Add mirror and gunzip modules (#242)

Author: igloo777

CHANGELOG.md

@@ -10,7 +10,7 @@ ENHANCEMENTS:
 
 * Bump the Ansible `community.general` collection to `4.6.1` and `community.docker` collection to `2.3.0`.
 * Add labels to loops in `tasks/config/template-config.yml` to reduce amount of output data.
-* Implement the `map`, `realip` and `split_clients` modules into the `http` core template.
+* Implement `gunzip`, `map`, `mirror`, `realip` and `split_clients` modules into `http` templates.
 * Streamline configuring SELinux.
 
 BUG FIXES:

defaults/main/template.yml

@@ -538,6 +538,11 @@ nginx_config_http_template:
         exact_size: true  # Boolean
         format: html
         localtime: false  # Boolean
+      gunzip:  # Configure GUNZIP
+        enable: true  # Boolean
+        buffers:
+          number: 32  # Required
+          size: 4k  # Required
       gzip:  # Configure GZIP
         enable: true  # Boolean
         buffers:
@@ -641,6 +646,9 @@ nginx_config_http_template:
           content:  # Dictionary or list of dictionaries
             - value: default
               new_value: 0
+      mirror:  # Configure Mirror directives
+        request_body: true  # Boolean
+        uri: false  # Required -- String or a list of strings -- Can alternatively be set to 'false'
       realip:  # Configure RealIP directives
         set_real_ip_from: 0.0.0.0
         real_ip_header: X-Real-IP

molecule/default/converge.yml

@@ -422,6 +422,11 @@
                 exact_size: true
                 format: html
                 localtime: true
+              gunzip:
+                enable: true
+                buffers:
+                  number: 32
+                  size: 4k
               gzip:
                 enable: true
                 buffers:
@@ -589,11 +594,17 @@
                         limit_except:
                           method: GET
                           directive: "allow all"
+                      mirror:
+                        uri: /mirror
                       proxy:
                         pass: http://frontend_servers/
                     - location: /backend
                       proxy:
                         pass: http://backend_servers/
+                    - location: /mirror
+                      internal: true
+                      proxy:
+                        pass: http://127.0.0.1/
           - template_file: http/default.conf.j2
             deployment_location: /etc/nginx/conf.d/frontend_default.conf
             config:

molecule/plus/converge.yml

@@ -184,6 +184,11 @@
                   - field: Accept-Encoding
                     value: '""'
                 socket_keepalive: false
+              gunzip:
+                enable: true
+                buffers:
+                  number: 32
+                  size: 4k
               gzip:
                 enable: true
                 buffers:
@@ -519,6 +524,8 @@
                         last_modified: false
                         once: true
                     - location: /backend
+                      mirror:
+                        uri: /mirror
                       proxy_pass: http://backend_servers/
                       proxy:
                         set_header:
@@ -530,6 +537,10 @@
                             value: $proxy_add_x_forwarded_for
                           - field: X-Forwarded-Proto
                             value: $scheme
+                    - location: /mirror
+                      internal: true
+                      proxy:
+                        pass: http://127.0.0.1/
           - template_file: http/default.conf.j2
             deployment_location: /etc/nginx/conf.d/frontend_default.conf
             config:

templates/http/default.conf.j2

@@ -56,6 +56,10 @@
 {% from 'http/modules.j2' import autoindex with context %}
 {{ autoindex(item['config']['autoindex']) }}
 {%- endif %}
+{% if item['config']['gunzip'] is defined %}
+{% from 'http/modules.j2' import gunzip with context %}
+{{ gunzip(item['config']['gunzip']) }}
+{%- endif %}
 {% if item['config']['gzip'] is defined %}
 {% from 'http/modules.j2' import gzip with context %}
 {{ gzip(item['config']['gzip']) }}
@@ -84,6 +88,10 @@
 {% from 'http/modules.j2' import map with context %}
 {{ map(item['config']['map']) }}
 {%- endif %}
+{% if item['config']['mirror'] is defined %}
+{% from 'http/modules.j2' import mirror with context %}
+{{ mirror(item['config']['mirror']) }}
+{%- endif %}
 {% if item['config']['realip'] is defined %}
 {% from 'http/modules.j2' import realip with context %}
 {{ realip(item['config']['realip']) }}
@@ -186,6 +194,12 @@ server {
     {{ autoindex(server['autoindex']) }}
 {%- endfilter %}
 {% endif %}
+{% if server['gunzip'] is defined %}
+{% from 'http/modules.j2' import gunzip with context %}
+{% filter indent(4) %}
+    {{ gunzip(server['gunzip']) }}
+{%- endfilter %}
+{% endif %}
 {% if server['gzip'] is defined %}
 {% from 'http/modules.j2' import gzip with context %}
 {% filter indent(4) %}
@@ -222,6 +236,12 @@ server {
     {{ log(server['log']) }}
 {%- endfilter %}
 {% endif %}
+{% if server['mirror'] is defined %}
+{% from 'http/modules.j2' import mirror with context %}
+{% filter indent(4) %}
+    {{ mirror(server['mirror']) }}
+{%- endfilter %}
+{% endif %}
 {% if server['realip'] is defined %}
 {% from 'http/modules.j2' import realip with context %}
 {% filter indent(4) %}
@@ -322,6 +342,12 @@ server {
         {{ autoindex(location['autoindex']) }}
 {%- endfilter %}
 {% endif %}
+{% if location['gunzip'] is defined %}
+{% from 'http/modules.j2' import gunzip with context %}
+{% filter indent(8) %}
+        {{ gunzip(location['gunzip']) }}
+{%- endfilter %}
+{% endif %}
 {% if location['gzip'] is defined %}
 {% from 'http/modules.j2' import gzip with context %}
 {% filter indent(8) %}
@@ -358,6 +384,12 @@ server {
         {{ log(location['log']) }}
 {%- endfilter %}
 {% endif %}
+{% if location['mirror'] is defined %}
+{% from 'http/modules.j2' import mirror with context %}
+{% filter indent(8) %}
+        {{ mirror(location['mirror']) }}
+{%- endfilter %}
+{% endif %}
 {% if location['realip'] is defined %}
 {% from 'http/modules.j2' import realip with context %}
 {% filter indent(8) %}

templates/http/modules.j2

@@ -37,6 +37,17 @@ autoindex_localtime {{ autoindex['localtime'] | ternary('on', 'off') }};
 
 {% endmacro %}
 
+{# NGINX HTTP GUNZIP template -- ngx_http_gunzip_module #}
+{% macro gunzip(gunzip) %}
+{% if gunzip['enable'] is defined and gunzip['enable'] is boolean %}
+gunzip {{ gunzip['enable'] | ternary('on', 'off') }};
+{% endif %}
+{% if gunzip['buffers']['number'] is defined and gunzip['buffers']['size'] is defined %}
+gunzip_buffers {{ gunzip['buffers']['number'] }} {{ gunzip['buffers']['size'] }};
+{% endif %}
+
+{% endmacro %}
+
 {# NGINX HTTP GZIP template -- ngx_http_gzip_module #}
 {% macro gzip(gzip) %}
 {% if gzip['enable'] is defined and gzip['enable'] is boolean %}
@@ -225,6 +236,23 @@ map {{ map_data['string'] }} {{ map_data['variable'] }} {
 
 {% endmacro %}
 
+{# NGINX HTTP Mirror -- ngx_http_mirror_module #}
+{% macro mirror(mirror) %}
+{% if mirror is defined %}
+{% if mirror['uri'] is defined and mirror['uri'] is not mapping %}
+{%  for uri in mirror['uri'] if mirror['uri'] is not string %}
+mirror {{ 'off' if not uri else uri }};
+{% else %}
+mirror {{ 'off' if not mirror['uri'] else mirror['uri'] }};
+{% endfor %}
+{% endif %}
+{% if mirror['request_body'] is defined and mirror['request_body'] is boolean %}
+mirror_request_body {{ mirror['request_body'] | ternary('on', 'off') }};
+{% endif %}
+{% endif %}
+
+{% endmacro %}
+
 {# NGINX HTTP RealIP -- ngx_http_realip_module #}
 {% macro realip(realip) %}
 {% if realip['set_real_ip_from'] is defined %}