feat: Template support for the NGINX Stream map module (#561)

Author: alessfg

CHANGELOG.md

@@ -6,6 +6,7 @@ FEATURES:
 
 - Add validation tasks to check the Ansible version, the Jinja2 version, and whether the required Ansible collections for this role are installed.
 - Bump the Ansible `community.general` collection to `9.2.0`, `community.crypto` collection to `2.21.1` and `community.docker` collection to `3.11.0`.
+- Add templating support for the `ngx_stream_map_module` NGINX module.
 
 BUG FIXES:
 

defaults/main/template.yml

@@ -961,6 +961,17 @@ nginx_config_stream_template:
           inactive: 20s
           min_uses: 2  # Number
           valid: 1m
+      map:  # Configure maps -- Available only in the 'stream' context
+        hash_bucket_size: 64
+        hash_max_size: 2048
+        mappings:  # 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
       custom_directives:  # String or a list of strings. Custom directive for specific use cases not covered by templates. Note: You need to include each directive in its full form. Make sure you add a semi-colon or closing curly bracket at the end of each directive.
         - server {};
       servers:   # All previous modules are also available (when allowed) in the 'servers' context.

molecule/complete/converge.yml

@@ -854,6 +854,24 @@
                   inactive: 20s
                   min_uses: 2
                   valid: 1m
+              map:
+                hash_bucket_size: 128
+                hash_max_size: 4096
+                mappings:
+                  - string: $hostname
+                    variable: $stream_name
+                    hostnames: true
+                    volatile: true
+                    content:
+                      - value: example.com
+                        new_value: 3
+                  - string: $host
+                    variable: $isblockaccess_ua
+                    content:
+                      - value: default
+                        new_value: 0
+                      - value: '"~jndi:ldap"'
+                        new_value: 2
               servers:
                 - core:
                     listen:

molecule/complete_plus/converge.yml

@@ -769,6 +769,24 @@
                   inactive: 20s
                   min_uses: 2
                   valid: 1m
+              map:
+                hash_bucket_size: 128
+                hash_max_size: 4096
+                mappings:
+                  - string: $hostname
+                    variable: $stream_name
+                    hostnames: true
+                    volatile: true
+                    content:
+                      - value: example.com
+                        new_value: 3
+                  - string: $host
+                    variable: $isblockaccess_ua
+                    content:
+                      - value: default
+                        new_value: 0
+                      - value: '"~jndi:ldap"'
+                        new_value: 2
               servers:
                 - core:
                     listen:

templates/stream/modules.j2

@@ -79,3 +79,35 @@ open_log_file_cache {{ 'off' if not log['open_log_file_cache'] else ('max=' + lo
 {% endif %}
 
 {% endmacro %}
+
+{# NGINX Stream Map -- ngx_stream_map_module #}
+{% macro map(map) %}{# 'map' module is only available in the 'stream' 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 %}