Refactor modules (#22)

Author: alessfg

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
-## 0.1.1 (Unreleased)
+## 0.2.0 (Unreleased)
+
+BREAKING CHANGES:
+
+*   The process to configure modules has changed. Instead of manually setting the modules you want to install to `true` or `false`, you will now have to use either:
+    *   A newly introduced top level list variable, `nginx_config_modules`.
+    *   A newly introduced list variable within your main NGINX config template, `nginx_config_main_template.modules`.
+
+Make sure you only use one variable or the other, since they will overwrite each other. This change will simplify adding future supported modules to this role, and allows you to include any external modules you may wish in your NGINX config.
 
 ENHANCEMENTS:
 

README.md

@@ -135,7 +135,7 @@ Example Playbooks
 Working functional playbook examples can be found in the **`molecule/common`** directory in the following files:
 
 -   **[molecule/common/playbooks/default_converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/molecule/common/playbooks/default_converge.yml):** Use the NGINX configuration templating variables to create an NGINX configuration file
--   **[molecule/common/playbooks/module_converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/molecule/common/playbooks/module_converge.yml):** Install and configure NGINX supported modules
+-   **[molecule/common/playbooks/module_converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/molecule/common/playbooks/module_converge.yml):** Cleanup NGINX configs and configure NGINX supported modules
 -   **[molecule/common/playbooks/stable_push_converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/molecule/common/playbooks/stable_push_converge.yml):** Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance
 
 Do note that if you install this repository via Ansible Galaxy, you will have to replace the role variable in the sample playbooks from `ansible-role-nginx-config` to `nginxinc.nginx_config`.

defaults/main/main.yml

@@ -6,17 +6,6 @@ nginx_config_start: true
 # Print NGINX configuration file to terminal after executing playbook.
 nginx_config_debug_output: false
 
-# Install NGINX JavaScript, Perl, ModSecurity WAF (NGINX Plus only), GeoIP, Image-Filter, RTMP Media Streaming (NGINX Plus only), and/or XSLT modules.
-# Default is false.
-nginx_config_modules:
-  njs: false
-  perl: false
-  waf: false
-  geoip: false
-  image_filter: false
-  rtmp: false
-  xslt: false
-
 # Remove previously existing NGINX configuration files (files ending in *.conf).
 # You can specify a list of paths you wish to remove.
 # You can also choose whether to recurse through the paths specified.
@@ -29,3 +18,8 @@ nginx_config_cleanup: false
 #     recurse: false
 # nginx_config_cleanup_files:
 #   - /etc/nginx/conf.d/default.conf
+
+# Add select modules to the beginning of your `nginx.conf` file. Do not use if
+# you are already setting modules via 'nginx_config_main_template'.
+# nginx_config_modules:
+#   - modules/ngx_http_js_module.so

defaults/main/template.yml

@@ -15,6 +15,8 @@ nginx_config_main_template:
   template_file: nginx.conf.j2
   conf_file_name: nginx.conf
   conf_file_location: /etc/nginx/
+  # modules:  # specify modules as a list following the format in the line below
+  #   - modules/ngx_http_js_module.so
   user: nginx
   worker_processes: auto
   # worker_rlimit_nofile: 1024

molecule/common/playbooks/default_converge.yml

@@ -14,6 +14,8 @@
           template_file: nginx.conf.j2
           conf_file_name: nginx.conf
           conf_file_location: /etc/nginx/
+          modules:
+            - modules/ngx_http_js_module.so
           user: nginx
           worker_processes: auto
           pid: /var/run/nginx.pid

molecule/common/playbooks/module_converge.yml

@@ -17,10 +17,4 @@
           - /etc/nginx/conf.d/default.conf
 
         nginx_config_modules:
-          njs: true
-          perl: true
-          waf: false
-          geoip: true
-          image_filter: true
-          rtmp: true
-          xslt: true
+          - modules/ngx_http_js_module.so

molecule/common/playbooks/prepare.yml

@@ -5,3 +5,12 @@
     - name: Install NGINX
       include_role:
         name: nginxinc.nginx
+      vars:
+        nginx_modules:
+          njs: true
+          perl: false
+          waf: false
+          geoip: false
+          image_filter: false
+          rtmp: false
+          xslt: false

tasks/conf/template-config.yml

@@ -16,6 +16,17 @@
   with_dict: "{{ nginx_config_html_demo_template }}"
   when: nginx_config_html_demo_template_enable | bool
 
+- name: "(Setup: All NGINX) Configure NGINX Modules"
+  lineinfile:
+    path: /etc/nginx/nginx.conf
+    insertbefore: BOF
+    line: "load_module {{ item }};"
+  loop: "{{ nginx_config_modules }}"
+  when:
+    - nginx_config_modules is defined
+    - nginx_config_modules | length > 0
+  notify: "(Handler: All OSs) Start NGINX"
+
 - name: "(Setup: All NGINX) Ensure NGINX Main Directory Exists"
   file:
     path: "{{ nginx_config_main_template.conf_file_location | default('/etc/nginx') }}"

tasks/main.yml

@@ -27,6 +27,8 @@
         or nginx_config_http_template_enable | bool
         or nginx_config_stream_template_enable | bool
         or nginx_config_rest_api_enable | bool
+        or nginx_config_html_demo_template_enable | bool
+        or nginx_config_modules is defined and nginx_config_modules | length > 0
   tags: nginx_config_template
 
 - name: "(Config: All OSs) Ensure NGINX is Running"

templates/nginx.conf.j2

@@ -1,36 +1,9 @@
 {{ ansible_managed | comment }}
 
-{% if nginx_config_modules.njs %}
-{% if nginx_config_http_template_enable %}
-load_module modules/ngx_http_js_module.so;
-{% endif %}
-{% if nginx_config_stream_template_enable %}
-load_module modules/ngx_stream_js_module.so;
-{% endif %}
-{% endif %}
-{% if nginx_config_modules.perl %}
-load_module modules/ngx_http_perl_module.so;
-{% endif %}
-{% if nginx_config_modules.geoip %}
-{% if nginx_config_http_template_enable %}
-load_module modules/ngx_http_geoip_module.so;
-{% endif %}
-{% if nginx_config_stream_template_enable %}
-load_module modules/ngx_stream_geoip_module.so;
-{% endif %}
-{% endif %}
-{% if nginx_config_modules.image_filter %}
-load_module modules/ngx_http_image_filter_module.so;
-{% endif %}
-{% if nginx_config_modules.rtmp and nginx_type == "plus" %}
-load_module modules/ngx_rtmp_module.so;
-{% endif %}
-{% if nginx_config_modules.xslt %}
-load_module modules/ngx_http_xslt_filter_module.so;
-{% endif %}
-{% if nginx_config_modules.waf and nginx_type == "plus" %}
-load_module modules/ngx_http_modsecurity_module.so;
-{% endif %}
+{% for nginx_module in nginx_config_main_template.modules %}
+load_module {{ nginx_module }};
+{% endfor %}
+
 user  {{ nginx_config_main_template.user }};
 worker_processes  {{ nginx_config_main_template.worker_processes }};