Merge pull request #67 from nginxinc/(feature)/refactor-templating

Refactor templating

Author: alessfg

defaults/main.yml

@@ -3,6 +3,9 @@
 # Default is true.
 nginx_enable: true
 
+# Print NGINX configuration file to terminal after executing playbook.
+nginx_debug_output: false
+
 # Specify which version of NGINX you want to install.
 # Options are 'opensource' or 'plus'.
 # Default is 'opensource'.
@@ -78,34 +81,108 @@ nginx_unit_modules: null
 # Will enable 'stub_status' in NGINX Open Source and 'status' in NGINX Plus.
 # Default is false.
 nginx_status_enable: false
+nginx_status_port: 8080
 
 # Enable NGINX Plus REST API, write access to the REST API, and NGINX Plus dashboard.
 # Requires NGINX Plus.
 # Default is false.
 nginx_rest_api_enable: false
+nginx_rest_api_location: /etc/nginx/conf.d/api.conf
+nginx_rest_api_port: 8080
 nginx_rest_api_write: false
 nginx_rest_api_dashboard: false
 
 # Enable uploading NGINX configuration files to your system.
 # Default for uploading files is false.
 # Default location of files is the files folder within the NGINX Ansible role.
-nginx_main_push_enable: false
-nginx_main_push_location: conf/nginx.conf
-nginx_http_push_enable: false
-nginx_http_push_location: conf/http/*.conf
-nginx_stream_push_enable: false
-nginx_stream_push_location: conf/stream/*.conf
-
-# Configuration variables to create a templated NGINX configuration.
+# Upload the main NGINX configuration file.
+nginx_main_upload_enable: false
+nginx_main_upload_src: conf/nginx.conf
+nginx_main_upload_dest: /etc/nginx
+# Upload HTTP NGINX configuration files.
+nginx_http_upload_enable: false
+nginx_http_upload_src: conf/http/*.conf
+nginx_http_upload_dest: /etc/nginx/conf.d
+# Upload Stream NGINX configuration files.
+nginx_stream_upload_enable: false
+nginx_stream_upload_src: conf/stream/*.conf
+nginx_stream_upload_dest: /etc/nginx/conf.d
+# Upload HTML files.
+nginx_html_upload_enable: false
+nginx_html_upload_src: www/*
+nginx_html_upload_dest: /usr/share/nginx/html
+# Upload SSL certificates and keys.
+nginx_ssl_upload_enable: false
+nginx_ssl_crt_upload_src: ssl/*.crt
+nginx_ssl_crt_upload_dest: /etc/ssl/certs/
+nginx_ssl_key_upload_src: ssl/*.key
+nginx_ssl_key_upload_dest: /etc/ssl/private/
+
+# Enable crating dynamic templated NGINX HTMK demo websites.
+nginx_html_demo_template_enable: false
+nginx_html_demo_template:
+  default:
+    template_file: www/index.html.j2
+    html_file_name: index.html
+    html_file_location: /usr/share/nginx/html
+    app_name: default
+
+# Enable creating dynamic templated NGINX configuration files.
 # Defaults are the values found in a fresh NGINX installation.
 nginx_main_template_enable: false
-nginx_main_template_user: nginx
-nginx_main_template_worker_processes: auto
-nginx_main_template_error_level: warn
-nginx_main_template_worker_connections: 1024
+nginx_main_template:
+  template_file: nginx.conf.j2
+  conf_file_name: nginx.conf
+  conf_file_location: /etc/nginx/
+  user: nginx
+  worker_processes: auto
+  error_level: warn
+  worker_connections: 1024
+  http_enable: true
+  http_settings:
+    keepalive_timeout: 65
+    cache: false
+    rate_limit: false
+    keyval: false
+  stream_enable: false
+
+# Enable creating dynamic templated NGINX HTTP configuration files.
+# Defaults will not produce a valid configuration. Instead they are meant to showcase
+# the options available for templating. Each key represents a new configuration file.
+# Comment out load_balancer or web_server depending on whether you wish to create a web server
+# or load balancer configuration file.
 nginx_http_template_enable: false
-nginx_http_template_keepalive_timeout: 65
-nginx_http_template_listen: 80
-nginx_http_template_server_name: localhost
+nginx_http_template:
+  default:
+    template_file: http/default.conf.j2
+    conf_file_name: default.conf
+    conf_file_location: /etc/nginx/conf.d/
+    port: 8081
+    server_name: localhost
+    error_page: /usr/share/nginx/html
+    ssl:
+      cert: ssl/default.crt
+      key: ssl/default.key
+    web_server:
+      html_file_location: /usr/share/nginx/html
+      html_file_name: index.html
+      http_demo_conf: false
+    load_balancer:
+      proxy_pass: backend
+      health_check_plus: false
+    upstreams:
+      upstream1:
+        name: backend
+        lb_method: least_conn
+        zone_name: backend
+        zone_size: 64k
+        sticky_cookie: false
+        servers:
+          server1:
+            address: localhost
+            port: 8081
+            weight: 1
+
+# Enable creating dynamic templated NGINX stream configuration files.
 nginx_stream_template_enable: false
 nginx_stream_template_listen: 12345

files/ssl/.gitkeep

@@ -0,0 +1,9 @@
+---
+- name: "(Setup: All OSs) Register NGINX configuration"
+  command: nginx -T
+  changed_when: false
+  register: nginx_configuration
+
+- name: "(Setup: All OSs) Print NGINX configuration"
+  debug:
+    var:  nginx_configuration.stdout_lines

files/www/.gitkeep

@@ -1,11 +1,11 @@
 ---
 - name: "(Setup: NGINX Plus) Setup NGINX Plus API"
   blockinfile:
-    path: "{{ (nginx_http_template_enable) | ternary('/etc/nginx/conf.d/http/api.conf','/etc/nginx/conf.d/api.conf') }}"
+    path: "{{ nginx_rest_api_location }}"
     create: yes
     block: |
       server {
-          listen 8080;
+          listen {{ nginx_rest_api_port }};
           location /api {
       {% if nginx_rest_api_write %}
               api write=on;

tasks/conf/debug-output.yml

@@ -5,7 +5,7 @@
     create: yes
     block: |
       server {
-          listen 127.0.0.1:80;
+          listen 127.0.0.1:{{ nginx_status_port }};
           location /nginx_status {
               stub_status on;
               allow 127.0.0.1;
@@ -21,7 +21,7 @@
     create: yes
     block: |
       server {
-          listen 127.0.0.1:80;
+          listen 127.0.0.1:{{ nginx_status_port }};
           location /status {
               status;
               allow 127.0.0.1;

tasks/conf/push-config.yml

@@ -1,25 +1,39 @@
 ---
+- name: "(Setup: All NGINX) Ensure HTML Directory Exists"
+  file:
+    path: "{{ item.value.html_file_location }}"
+    state: directory
+  with_dict: "{{ nginx_html_demo_template }}"
+  when: nginx_html_demo_template_enable
+
+- name: "(Setup: All NGINX) Dynamically Generate HTML Files"
+  template:
+    src: "{{ item.value.template_file }}"
+    dest: "{{ item.value.html_file_location }}/{{ item.value.html_file_name }}"
+  with_dict: "{{ nginx_html_demo_template }}"
+  when: nginx_html_demo_template_enable
+
 - name: "(Setup: All NGINX) Dynamically Generate NGINX Main Configuration File"
   template:
-    src: nginx.conf.j2
-    dest: /etc/nginx/nginx.conf
+    src: "{{ nginx_main_template.template_file }}"
+    dest: "{{ nginx_main_template.conf_file_location }}/{{ nginx_main_template.conf_file_name }}"
     backup: yes
   when: nginx_main_template_enable
   notify: "(Handler: All OSs) Reload NGINX"
 
 - name: "(Setup: All NGINX) Ensure NGINX HTTP Directory Exists"
   file:
-    path: /etc/nginx/conf.d/http
+    path: "{{ item.value.conf_file_location }}"
     state: directory
+  with_dict: "{{ nginx_http_template }}"
   when: nginx_http_template_enable
 
 - name: "(Setup: All NGINX) Dynamically Generate NGINX HTTP Configuration Files"
   template:
-    src: "{{ item }}"
-    dest: /etc/nginx/conf.d/http/{{ item | basename | regex_replace('\.j2','') }}
+    src: "{{ item.value.template_file }}"
+    dest: "{{ item.value.conf_file_location }}/{{ item.value.conf_file_name }}"
     backup: yes
-  with_fileglob:
-    - "../templates/http/*.j2"
+  with_dict: "{{ nginx_http_template }}"
   when: nginx_http_template_enable
   notify: "(Handler: All OSs) Reload NGINX"
 

tasks/conf/setup-rest-api.yml

@@ -0,0 +1,81 @@
+---
+- name: "(Setup: All NGINX) Upload NGINX Main Configuration File"
+  copy:
+    src: "{{ nginx_main_upload_src }}"
+    dest: "{{ nginx_main_upload_dest }}"
+    backup: yes
+  notify: "(Handler: All OSs) Reload NGINX"
+  when: nginx_main_upload_enable
+
+- name: "(Setup: All NGINX) Ensure NGINX HTTP Directory Exists"
+  file:
+    path: "{{ nginx_http_upload_dest }}"
+    state: directory
+  when: nginx_http_upload_enable
+
+- name: "(Setup: All NGINX) Upload NGINX HTTP Configuration Files"
+  copy:
+    src: "{{ item }}"
+    dest: "{{ nginx_http_upload_dest }}"
+    backup: yes
+  with_fileglob: "{{ nginx_http_upload_src }}"
+  notify: "(Handler: All OSs) Reload NGINX"
+  when: nginx_http_upload_enable
+
+- name: "(Setup: All NGINX) Ensure NGINX Stream Directory Exists"
+  file:
+    path: "{{ nginx_stream_upload_dest }}"
+    state: directory
+  when: nginx_stream_upload_enable
+
+- name: "(Setup: All NGINX) Upload NGINX Stream Configuration Files"
+  copy:
+    src: "{{ item }}"
+    dest: "{{ nginx_stream_upload_dest }}"
+    backup: yes
+  with_fileglob: "{{ nginx_stream_upload_src }}"
+  notify: "(Handler: All OSs) Reload NGINX"
+  when: nginx_stream_upload_enable
+
+- name: "(Setup: All NGINX) Ensure NGINX HTML Directory Exists"
+  file:
+    path: "{{ nginx_html_upload_dest }}"
+    state: directory
+  when: nginx_html_upload_enable
+
+- name: "(Setup: All NGINX) Upload NGINX HTML Files"
+  copy:
+    src: "{{ item }}"
+    dest: "{{ nginx_html_upload_dest }}"
+    backup: yes
+  with_fileglob: "{{ nginx_html_upload_src }}"
+  notify: "(Handler: All OSs) Reload NGINX"
+  when: nginx_html_upload_enable
+
+- name: "(Setup: All NGINX) Ensure SSL Certificate Directory Exists"
+  file:
+    path: "{{ nginx_ssl_crt_upload_dest }}"
+    state: directory
+  when: nginx_ssl_upload_enable
+
+- name: "(Setup: All NGINX) Ensure SSL Key Directory Exists"
+  file:
+    path: "{{ nginx_ssl_key_upload_dest }}"
+    state: directory
+  when: nginx_ssl_upload_enable
+
+- name: "(Setup: All NGINX) Upload NGINX SSL Certificates"
+  copy:
+    src: "{{ item }}"
+    dest: "{{ nginx_ssl_crt_upload_dest }}"
+    backup: yes
+  with_fileglob: "{{ nginx_ssl_crt_upload_src }}"
+  when: nginx_ssl_upload_enable
+
+- name: "(Setup: All NGINX) Upload NGINX SSL Keys"
+  copy:
+    src: "{{ item }}"
+    dest: "{{ nginx_ssl_key_upload_dest }}"
+    backup: yes
+  with_fileglob: "{{ nginx_ssl_key_upload_src }}"
+  when: nginx_ssl_upload_enable

tasks/conf/setup-status.yml

@@ -19,8 +19,8 @@
     - import_tasks: modules/install-modules.yml
       when: true in nginx_modules.values()
 
-    - import_tasks: conf/push-config.yml
-      when: nginx_main_push_enable or nginx_http_push_enable or nginx_stream_push_enable
+    - import_tasks: conf/upload-config.yml
+      when: nginx_main_upload_enable or nginx_http_upload_enable or nginx_stream_upload_enable or nginx_html_upload_enable or nginx_ssl_upload_enable
 
     - import_tasks: conf/template-config.yml
       when: nginx_main_template_enable or nginx_http_template_enable or nginx_stream_template_enable
@@ -29,7 +29,10 @@
       when: nginx_status_enable
 
     - import_tasks: conf/setup-rest-api.yml
-      when: nginx_rest_api_enable and nginx_type == "plus"
+      when: nginx_rest_api_enable
+
+    - import_tasks: conf/debug-output.yml
+      when: nginx_debug_output
 
   when: nginx_enable
 

tasks/conf/template-config.yml

@@ -9,5 +9,5 @@
     src: "{{ item }}"
     dest: /etc/ssl/nginx
   with_items:
-    - "{{ license.certificate }}"
-    - "{{ license.key }}"
+    - "{{ nginx_license.certificate }}"
+    - "{{ nginx_license.key }}"