Add map and split_clients directives (#235)

Author: igloo777

CHANGELOG.md

@@ -10,6 +10,7 @@ ENHANCEMENTS:
 
 * Bump the Ansible `community.general` collection to `4.6.1` and `community.docker` collection to `2.2.1`.
 * Add labels to loops in `tasks/config/template-config.yml` to reduce amount of output data.
+* Add the `map` and `split_clients` directives into the `http` core template.
 
 BUG FIXES:
 

defaults/main/template.yml

@@ -630,6 +630,17 @@ nginx_config_http_template:
           inactive: 20s
           min_uses: 2  # Number
           valid: 1m
+      map:  # Configure maps -- Available only in the 'http' context
+        hash_bucket_size: 64
+        hash_max_size: 2048
+        mappings:  # Dictionary or list of dictionaries
+          string: $remote_addr  # Required
+          variable: $upstream  # Required
+          hostnames: false  # Boolean
+          volatile: false  # Boolean
+          content:  # Dictionary or list of dictionaries
+            - value: default
+              new_value: 0
       rewrite:  # Configure rewrite directives
         return:  # Can also be set to a return URL or code directly -- Not available in the 'http' context
           code: 200  # Required -- You have to set either 'code' or 'url'
@@ -644,6 +655,14 @@ nginx_config_http_template:
           - variable: $var  # Required
             value: var  # Required
         uninitialized_variable_warn: true  # Boolean
+      split_clients:  # Configure split_clients -- Available only in the 'http' context
+        string: $remote_addr  # Required
+        variable: $upstream  # Required
+        content:  # List of dictionaries -- Percentages must add up to 100%
+          - percentage: 20%  # Required
+            value: appv2  # Required
+          - percentage: "*"  # Required
+            value: app  # Required
       sub_filter:  # Configure sub_filter directives
         sub_filters:  # Dictionary or a list of dictionaries
           - string: server_hostname  # Required

molecule/default/converge.yml

@@ -484,9 +484,35 @@
                   inactive: 20s
                   min_uses: 2
                   valid: 1m
+              map:
+                hash_bucket_size: 128
+                hash_max_size: 4096
+                mappings:
+                  - string: $http_host
+                    variable: $name
+                    hostnames: true
+                    volatile: true
+                    content:
+                      - value: example.com
+                        new_value: 1
+                  - string: $http_user_agent
+                    variable: $isblockaccess_ua
+                    content:
+                      - value: "default"
+                        new_value: 0
+                      - value: '"~jndi:ldap"'
+                        new_value: 1
               rewrite:
                 log: false
                 uninitialized_variable_warn: false
+              split_clients:
+                string: $remote_addr
+                variable: $upstream_split
+                content:
+                  - percentage: 20%
+                    value: appv2
+                  - percentage: "*"
+                    value: app
               sub_filter:
                 sub_filters:
                   - string: server_hostname

molecule/plus/converge.yml

@@ -278,9 +278,35 @@
                   inactive: 20s
                   min_uses: 2
                   valid: 1m
+              map:
+                hash_bucket_size: 128
+                hash_max_size: 4096
+                mappings:
+                  - string: $http_host
+                    variable: $name
+                    hostnames: true
+                    volatile: true
+                    content:
+                      - value: example.com
+                        new_value: 1
+                  - string: $http_user_agent
+                    variable: $isblockaccess_ua
+                    content:
+                      - value: "default"
+                        new_value: 0
+                      - value: '"~jndi:ldap"'
+                        new_value: 1
               rewrite:
                 log: false
                 uninitialized_variable_warn: false
+              split_clients:
+                string: $remote_addr
+                variable: $upstream_split
+                content:
+                  - percentage: 20%
+                    value: appv2
+                  - percentage: "*"
+                    value: app
               sub_filter:
                 sub_filters:
                   - string: server_hostname

templates/http/default.conf.j2

@@ -80,10 +80,18 @@
 {% from 'http/modules.j2' import log with context %}
 {{ log(item['config']['log']) }}
 {%- endif %}
+{% if item['config']['map'] is defined %}
+{% from 'http/modules.j2' import map with context %}
+{{ map(item['config']['map']) }}
+{%- endif %}
 {% if item['config']['rewrite'] is defined %}
 {% from 'http/modules.j2' import rewrite with context %}
 {{ rewrite(item['config']['rewrite']) }}
 {%- endif %}
+{% if item['config']['split_clients'] is defined %}
+{% from 'http/modules.j2' import split_clients with context %}
+{{ split_clients(item['config']['split_clients']) }}
+{%- endif %}
 {% if item['config']['sub_filter'] is defined %}
 {% from 'http/modules.j2' import sub_filter with context %}
 {{ sub_filter(item['config']['sub_filter']) }}

templates/http/modules.j2

@@ -124,13 +124,13 @@ match {{ match['name'] }} {
 
 {# NGINX HTTP Keyval -- ngx_http_keyval_module #}
 {# Available only in NGINX Plus #}
-{% macro keyval(keyval) %}
-{% if keyval['keyvals'] is defined %}{# 'keyval' directive is only available in the 'http' context #}
+{% macro keyval(keyval) %}{# 'keyval' module is only available in the 'http' context #}
+{% if keyval['keyvals'] is defined %}
 {% for keyval in keyval['keyvals'] %}
 keyval {{ keyval['key'] }} {{ keyval['variable'] }} {{ 'zone=' + keyval['zone'] | string }};
 {% endfor %}
 {% endif %}
-{% if keyval['zones'] is defined %}{# 'keyval_zone' directive is only available in the 'http' context #}
+{% if keyval['zones'] is defined %}
 {% for zone in keyval['zones'] %}
 keyval_zone {{ 'zone=' + zone['name'] | string + ':' + zone['size'] | string }}{{ (' state=' + zone['state'] | string) if zone['state'] is defined }}{{ (' timeout=' + zone['timeout'] | string) if zone['timeout'] is defined }}{{ (' type=' + zone['type'] | string) if zone['type'] is defined and zone['type'] in ['string', 'ip', 'prefix'] }}{{ ' sync' if zone['sync'] is defined and zone['sync'] is boolean and zone['sync'] | bool }};
 {% endfor %}
@@ -193,6 +193,38 @@ open_log_file_cache {{ 'off' if not log['open_log_file_cache'] else ('max=' + lo
 
 {% endmacro %}
 
+{# NGINX HTTP Map -- ngx_http_map_module #}
+{% macro map(map) %}{# 'map' module is only available in the 'http' context #}
+{% if map['hash_bucket_size'] is defined %}
+map_hash_bucket_size {{ map['hash_bucket_size'] }};
+{% endif %}
+{% if map['hash_max_size'] is defined %}
+map_hash_max_size {{ map['hash_max_size'] }};
+{% endif %}
+{% if map['mappings'] is defined %}
+{% for map_data in map['mappings'] %}
+{% if map_data['string'] is defined and map_data['variable'] is defined %}
+map {{ map_data['string'] }} {{ map_data['variable'] }} {
+{% if map_data['hostnames'] is defined and map_data['hostnames'] is boolean and map_data['hostnames'] | bool %}
+    hostnames;
+{% endif %}
+{% if map_data['volatile'] is defined and map_data['volatile'] is boolean and map_data['volatile'] | bool %}
+    volatile;
+{% endif %}
+{% if map_data['content'] is defined %}
+{% for content_line in map_data['content'] if map_data['content'] is not mapping %}
+    {{ content_line['value'] }} {{ content_line['new_value'] }};
+{% else %}
+    {{ map_data['content']['value'] }} {{ map_data['content']['new_value'] }};
+{% endfor %}
+{% endif %}
+}
+{% endif %}
+{% endfor %}
+{% endif %}
+
+{% endmacro %}
+
 {# NGINX HTTP Rewrite -- ngx_http_rewrite_module #}
 {% macro rewrite(rewrite) %}
 {% if rewrite['return'] is defined %}{# 'return' directive is not available in the 'http' context #}
@@ -221,6 +253,22 @@ uninitialized_variable_warn {{ rewrite['uninitialized_variable_warn'] | ternary(
 
 {% endmacro %}
 
+{# NGINX HTTP Split Clients -- ngx_http_split_clients_module #}
+{% macro split_clients(split_clients) %}{# 'split_clients' directive is only available in the 'http' context #}
+{% if split_clients['string'] is defined and split_clients['variable'] is defined %}
+split_clients {{ split_clients['string'] }} {{ split_clients['variable'] }} {
+{% if split_clients['content'] is defined %}
+{% for content_line in split_clients['content'] if split_clients['content'] is not mapping  %}
+    {{ content_line['percentage'] }} {{ content_line['value'] }};
+{% else %}
+    {{ split_clients['content']['percentage'] }} {{ split_clients['content']['value'] }};
+{% endfor %}
+{% endif %}
+}
+{% endif %}
+
+{% endmacro %}
+
 {# NGINX HTTP Sub Filter -- ngx_http_sub_module #}
 {% macro sub_filter(sub_filter) %}
 {% if sub_filter['sub_filters'] is defined %}