nginx_controller_ var pattern

Author: brianehlert

README.md

@@ -14,17 +14,17 @@ Role Variables
 
 ### Required Variables
 
-`controller.fqdn` - FQDN of the NGINX Controller instance
+`nginx_controller_fqdn` - FQDN of the NGINX Controller instance
 
-`api_key` - The API key used to authenticate to NGINX Controller.
+`nginx_controller_api_key` - The API key used to authenticate to NGINX Controller.
 
 ### Optional Variables
 
-`controller_hostname` - The name of the NGINX instance as reflected in NGINX Controller. Must be unique per instance.
+`nginx_controller_hostname` - The name of the NGINX instance as reflected in NGINX Controller. Must be unique per instance.  (currently redundant with nginx_controller_instance_name)
 
-`location` - The location in NGINX Controller this instance will be automatically added to. Otherwise the location will be 'unspecified' in NGINX Controller.
+`nginx_controller_location` - The location in NGINX Controller this instance will be automatically added to. Otherwise the location will be 'unspecified' in NGINX Controller.
 
-`instance_name` - The name of the instance as reflected in Controller. Must be unique per instance (currently redundant with controller_hostname).
+`nginx_controller_instance_name` - The name of the instance as reflected in Controller. Must be unique per instance.
 
 Dependencies
 ------------
@@ -38,11 +38,10 @@ To use this role you can create a playbook such as the following:
 - hosts: localhost
   gather_facts: yes
   vars:
-    controller:
-      user_email: "user@example.com"
-      user_password: "mySecurePassword"
-      fqdn: "controller.mydomain.com"
-      validate_certs: false
+    nginx_controller_user_email: "user@example.com"
+    nginx_controller_user_password: "mySecurePassword"
+    nginx_controller_fqdn: "controller.mydomain.com"
+    nginx_controller_validate_certs: false
 
   tasks:
     - name: Upgrade your packages
@@ -64,31 +63,31 @@ To use this role you can create a playbook such as the following:
 
     - name: Get NGINX Controller API key for agent registration
       uri:
-        url: "https://{{ controller.fqdn }}/api/v1/platform/global"
+        url: "https://{{ nginx_controller_fqdn }}/api/v1/platform/global"
         method: "GET"
         return_content: yes
         status_code: 200
-        validate_certs: "{{ controller.validate_certs | default(false) }}"
+        validate_certs: "{{ nginx_controller_validate_certs | default(false) }}"
         headers:
-          Cookie: "{{ controller.auth_token }}"
-      register: ctrl_globals
+          Cookie: "{{ nginx_controller_auth_token }}"
+      register: nginx_controller_globals
 
     - name: Copy api_key to a variable
       set_fact:
-        api_key: "{{ ctrl_globals.json.currentStatus.agentSettings.apiKey }}"
+        nginx_controller_api_key: "{{ nginx_controller_globals.json.currentStatus.agentSettings.apiKey }}"
 
     - name: Install the NGINX Controller agent
       include_role:
         name: nginxinc.nginx_controller_agent
       vars:
-        api_key: "{{ api_key }}"
+        nginx_controller_api_key: "{{ nginx_controller_api_key }}"
 ```
 
 Use
 ---
 
 ```cli
-ansible-playbook nginx_controller_agent.yaml -b -i hosts -e "user_email=controller-admin@nginx.com user_password=password controller_fqdn=controller.acme.com"
+ansible-playbook nginx_controller_agent.yaml -b -i hosts -e "nginx_controller_user_email=controller-admin@nginx.com nginx_controller_user_password=password nginx_controller_fqdn=controller.acme.com"
 ```
 
 License

defaults/main.yml

@@ -1,11 +1,7 @@
 ---
-# These need to be defined to allow the ternary test to execute.
-controller_hostname: ""
-location: ""
-instance_name: ""
 
-## The following defaults exist to ensure no breakage of existing implementations that utilize this role. Do not remove.
-controller:
-  user_email: "user@example.com"
-  user_password: "mySecurePassword"
-  fqdn: "{{ controller_fqdn }}"
+
+# These need to be defined to allow the ternary test to evaluate.
+nginx_controller_hostname: ""
+nginx_controller_location: ""
+nginx_controller_instance_name: ""

tasks/main.yml

@@ -3,8 +3,8 @@
   assert:
     that: ("{{ item }} is defined") and ("{{ item }} | length > 0")
   loop:
-    - controller.fqdn
-    - api_key
+    - nginx_controller_fqdn
+    - nginx_controller_api_key
 
 - name: COPY files/nginx-plus-api.conf /etc/nginx/conf.d/ necessary for process monitoring.
   copy:
@@ -14,15 +14,15 @@
 
 - name: Download the installer script from NGINX Controller
   get_url:
-    url: "https://{{ controller.fqdn }}:8443/1.4/install/controller/"
+    url: "https://{{ nginx_controller_fqdn }}:8443/1.4/install/controller/"
     dest: "{{ ansible_env.HOME }}/install.sh"
-    validate_certs: "{{ controller.validate_certs | default(false) }}"
+    validate_certs: "{{ nginx_controller_validate_certs | default(false) }}"
     force: yes
-  register: controller_return
+  register: nginx_controller_return
 
 - name: Run the NGINX Controller agent installer
   shell: |
-    API_KEY='{{ api_key }}' \
+    API_KEY='{{ nginx_controller_api_key }}' \
     {{ (controller_hostname | length > 0) | ternary('CONTROLLER_HOSTNAME=' + controller_hostname,'') }} \
     {{ (controller_hostname | length > 0) | ternary('STORE_UUID=True','') }} \
     sh ./install.sh -y \
@@ -31,11 +31,11 @@
   args:
     chdir: "{{ ansible_env.HOME }}"
     creates: /var/log/nginx-controller/agent.log
-  register: agent_install
+  register: nginx_controller_agent_install
 
 - name: Output agent install results
   debug:
-    var: agent_install.stdout_lines
+    var: nginx_controller_agent_install.stdout_lines
 
 - name: Restart NGINX
   service:

vars/main.yml

@@ -1,11 +1,11 @@
 ---
 ## All the below variables are REQUIRED
 
-# controller.fqdn:  # FQDN of the NGINX Controller instance
-# api_key: ""  # The API key used to authenticate to NGINX Controller
+# nginx_controller_fqdn:  # FQDN of the NGINX Controller instance
+# nginx_controller_api_key: ""  # The API key used to authenticate to NGINX Controller
 
 ## All the below variables are OPTIONAL
 
-# controller_hostname: ""  # The name of the instance as reflected in NGINX Controller. Must be unique.
-# location:  # The location in NGINX Controller this instance will be automatically added to. Otherwise the location will be 'unspecified'.
-# instance_name:  # The name of the instance as reflected in Controller. Must be unique (redundant with controller_hostname).
+# nginx_controller_hostname: ""  # The name of the instance as reflected in NGINX Controller. Must be unique.
+# nginx_controller_location:  # The location in NGINX Controller this instance will be automatically added to. Otherwise the location will be 'unspecified'.
+# nginx_controller_instance_name:  # The name of the instance as reflected in Controller. Must be unique (redundant with controller_hostname).