fix(awx): prevented var collision by prefixing with nfc_pb_awx

jon-nfc · jon-nfc · commit 1e629ccf946d · 2023-10-29T22:51:43.000+09:30
awx itself uses var prefix `awx_`

!26
diff --git a/awx.yaml b/awx.yaml
@@ -6,17 +6,18 @@
 
   tasks:
 
+
     - name: Organizations
       ansible.builtin.include_tasks:
         file: tasks/awx/organization.yaml
-      loop: "{{ awx_config.organizations }}"
+      loop: "{{ my_awx_config.organizations }}" # Fix as this var should be dynamic
       loop_control:
-        loop_var: awx_organization
+        loop_var: nfc_pb_awx_organization
 
 
   vars:
     ansible_connection: local
-    awx_tower_template:
+    nfc_pb_awx_tower_template:
       - name: "AWX / Tower Configure"
         ask_tags_on_launch: false
         ask_inventory_on_launch: true
@@ -40,9 +41,9 @@
                 "min": 3,
                 "type": "text",
                 "choices": "",
-                "default": "awx_config",
+                "default": "my_awx_config",
                 "required": true,
-                "variable": "awx_config_variable",
+                "variable": "nfc_pb_awx_config_variable",
                 "new_question": true,
                 "question_name": "Inventory Variable",
                 "question_description": "The Variable in the Inventory the AWX config is under"
@@ -65,7 +66,7 @@
     #     max_concurrent_jobs: "{{ item[0].max_concurrent_jobs | default('0') }}"
     #     max_forks: "{{ item[0].max_forks | default('0') }}"
     #     state: "{{ item[1].state | default('present') }}"
-    #   when: awx_config is defined and awx_config.organizations is defined and item[1]|length > 0
+    #   when: nfc_pb_awx_config is defined and nfc_pb_awx_config.organizations is defined and item[1]|length > 0
     #   #with_items: "{{ awx.organizations }}.instance_groups"
     #   # with_list: "{{ awx.organizations.instance_groups }}"
     #   with_subelements:
@@ -78,14 +79,14 @@
     #     name: "{{ item[1].name }}"
     #     inventory: "{{ item[1].name }}"
     #     organization: "{{ item[0].name }}"
-    #     controller_host: "{{ awx_controller_host | default(omit) }}"
-    #     controller_oauthtoken: "{{ awx_controller_oauthtoken | default(omit) }}"
-    #     controller_username: "{{ awx_controller_username | default(omit) }}"
-    #     controller_password: "{{ awx_controller_password | default(omit) }}"
+    #     controller_host: "{{ nfc_pb_awx_controller_host | default(omit) }}"
+    #     controller_oauthtoken: "{{ nfc_pb_awx_controller_oauthtoken | default(omit) }}"
+    #     controller_username: "{{ nfc_pb_awx_controller_username | default(omit) }}"
+    #     controller_password: "{{ nfc_pb_awx_controller_password | default(omit) }}"
     #   with_subelements:
-    #     - "{{ awx_config_variable.organizations }}"
+    #     - "{{ nfc_pb_awx_config_variable.organizations }}"
     #     - projects
-    #   when: awx_config is defined and awx_config.organizations is defined and item[1] | length > 0
+    #   when: nfc_pb_awx_config is defined and nfc_pb_awx_config.organizations is defined and item[1] | length > 0
     #   # no_log: true
     #   diff: true
     #   tags:
@@ -99,10 +100,10 @@
     # #
     # - name: Schedule configuration
     #   awx.awx.schedule:
-    #     controller_host: "{{ awx_controller_host | default(omit) }}"
-    #     controller_oauthtoken: "{{ awx_controller_oauthtoken | default(omit) }}"
-    #     controller_username: "{{ awx_controller_username | default(omit) }}"
-    #     controller_password: "{{ awx_controller_password | default(omit) }}"
+    #     controller_host: "{{ nfc_pb_awx_controller_host | default(omit) }}"
+    #     controller_oauthtoken: "{{ nfc_pb_awx_controller_oauthtoken | default(omit) }}"
+    #     controller_username: "{{ nfc_pb_awx_controller_username | default(omit) }}"
+    #     controller_password: "{{ nfc_pb_awx_controller_password | default(omit) }}"
     #     name: "{{ item[1].name }}"
     #     state: "{{ item[1].state | default('present') }}"
     #     scm_branch: "{{ item[1].scm_branch | default(omit) }}"
@@ -111,7 +112,7 @@
     #     job_type: "{{ item[1].job_type }}"
     #     rrule: "{{ query('awx.awx.schedule_rrule', item[1].schedule.terms, every=item[1].schedule.every, timezone=item[1].schedule.timezone) }}" # "{{ item[1].schedule }}"
     #   with_subelements:
-    #     - "{{ awx_config.organizations }}"
+    #     - "{{ nfc_pb_awx_config.organizations }}"
     #     - schedules
     #   # no_log: true
     #   diff: true
diff --git a/backup.yaml b/backup.yaml
@@ -70,7 +70,7 @@
 
   vars:
 
-    awx_tower_template:
+    nfc_pb_awx_tower_template:
       - name: "Backup(s) from Inventory config"
         ask_limit_on_launch: true
         ask_tags_on_launch: true
diff --git a/git_configuration.yaml b/git_configuration.yaml
@@ -11,7 +11,7 @@
 
   vars:
     ansible_connection: local
-    awx_tower_template:
+    nfc_pb_awx_tower_template:
       - name: "Configure Gitlab / Github Repositories"
         ask_tags_on_launch: true
         ask_inventory_on_launch: true
diff --git a/kubernetes.yaml b/kubernetes.yaml
@@ -12,7 +12,7 @@
         common_gather_facts: true
 
   vars:
-    awx_tower_template:
+    nfc_pb_awx_tower_template:
       - name: "Kubernetes"
         ask_tags_on_launch: true
         ask_limit_on_launch: true
diff --git a/postgres.yaml b/postgres.yaml
@@ -171,7 +171,7 @@
     postgresDB_database_name: ""       # String, Required
     postgresDB_filename_restore: ""    # String, Required for Restore ONLY
 
-    awx_tower_template:
+    nfc_pb_awx_tower_template:
       - name: "PostgresDB"
         ask_tags_on_launch: true
         description: |
diff --git a/tasks/awx/inventory.yaml b/tasks/awx/inventory.yaml
@@ -2,12 +2,12 @@
 - name: Add inventory
   awx.awx.inventory:
     name: "Production"
-    description: "{{ awx_inventory.description | default('') }}"
-    controller_host: "{{ awx_controller_host | default(omit) }}"
-    controller_oauthtoken: "{{ awx_controller_oauthtoken | default(omit) }}"
-    controller_username: "{{ awx_controller_username | default(omit) }}"
-    controller_password: "{{ awx_controller_password | default(omit) }}"
-    organization: "{{ awx_organization.name }}"
+    description: "{{ nfc_pb_awx_inventory.description | default('') }}"
+    controller_host: "{{ nfc_pb_awx_controller_host | default(omit) }}"
+    controller_oauthtoken: "{{ nfc_pb_awx_controller_oauthtoken | default(omit) }}"
+    controller_username: "{{ nfc_pb_awx_controller_username | default(omit) }}"
+    controller_password: "{{ nfc_pb_awx_controller_password | default(omit) }}"
+    organization: "{{ nfc_pb_awx_organization.name }}"
     state: present
     validate_certs: "{{ validate_certs | default(true) }}"
   # no_log: true
@@ -16,37 +16,49 @@
 
 - name: Add an inventory source
   awx.awx.inventory_source:
+    name: "{{ nfc_pb_awx_project.name }}"
+    description: "{{ nfc_pb_awx_inventory.description | default('') }}"
+    controller_host: "{{ nfc_pb_awx_controller_host | default(omit) }}"
+    controller_oauthtoken: "{{ nfc_pb_awx_controller_oauthtoken | default(omit) }}"
+    controller_username: "{{ nfc_pb_awx_controller_username | default(omit) }}"
+    controller_password: "{{ nfc_pb_awx_controller_password | default(omit) }}"
     validate_certs: "{{ validate_certs | default(true) }}"
+    organization: "{{ nfc_pb_awx_organization.name }}"
     inventory: "Production"
     # credential: previously-created-credential
     # overwrite: True
     # update_on_launch: True
-    source_project: "{{ awx_project.name }}"
+    source_project: "{{ nfc_pb_awx_project.name }}"
     source_path: inventory/production/
     source: scm
     state: present
     verbosity: 2
-    overwrite: "{{ awx_inventory.inventory_overwrite | default(true) | bool }}"
-    overwrite_vars: "{{ awx_inventory.inventory_overwrite_vars | default(true) | bool }}"
-    scm_branch: "{{ awx_inventory.scm_branch | default(omit) }}"
+    overwrite: "{{ nfc_pb_awx_inventory.inventory_overwrite | default(true) | bool }}"
+    overwrite_vars: "{{ nfc_pb_awx_inventory.inventory_overwrite_vars | default(true) | bool }}"
+    scm_branch: "{{ nfc_pb_awx_inventory.scm_branch | default(omit) }}"
   # no_log: true
   diff: true
 
 
-- name: "Update inventory sources {{ awx_project.name }}/{{ awx_project.name }}"
+- name: "Update inventory sources {{ nfc_pb_awx_project.name }}/{{ nfc_pb_awx_project.name }}"
   awx.awx.inventory_source_update:
-    name: "{{ awx_project.name }}"
+    name: "{{ nfc_pb_awx_project.name }}"
     inventory: "Production"
+    controller_host: "{{ nfc_pb_awx_controller_host | default(omit) }}"
+    controller_oauthtoken: "{{ nfc_pb_awx_controller_oauthtoken | default(omit) }}"
+    controller_username: "{{ nfc_pb_awx_controller_username | default(omit) }}"
+    controller_password: "{{ nfc_pb_awx_controller_password | default(omit) }}"
+    organization: "{{ nfc_pb_awx_organization.name }}"
     validate_certs: "{{ validate_certs | default(true) }}"
   # no_log: true
   diff: true
 
 
-- name: "RBAC - {{ awx_organization.name }}/Project/{{ awx_project.name }}/Inventory"
+- name: "RBAC - {{ nfc_pb_awx_organization.name }}/Project/{{ nfc_pb_awx_project.name }}/Inventory"
   ansible.builtin.include_tasks:
     file: tasks/awx/rbac.yaml
-  loop: "{{ awx_project.rbac.inventory }}"
+  loop: "{{ nfc_pb_awx_project.rbac.inventory }}"
   loop_control:
-    loop_var: awx_rbac
+    loop_var: nfc_pb_awx_rbac
   vars:
-    awx_inventory_name: "Production"
+    nfc_pb_awx_inventory_name: "Production"
diff --git a/tasks/awx/job_template.yaml b/tasks/awx/job_template.yaml
@@ -5,88 +5,96 @@
     - name: Debug
       ansible.builtin.debug:
         msg:
-          - "{{ awx_playbook_filename }}"
-          - "{{ awx_job_template }}"
+          - "{{ nfc_pb_awx_playbook_filename }}"
+          - "{{ nfc_pb_awx_job_template }}"
+          - "{{ nfc_pb_awx_job_template_name | default('Not Yet Defined') }}"
 
     # - name: Create fact from Playbook
     #   ansible.builtin.set_fact:
-    #     playbook_contents: "{{ lookup('file', awx_playbook_filename) | from_yaml }}"
-    #   when: awx_playbook_filename | default('') != ''
+    #     playbook_contents: "{{ lookup('file', nfc_pb_awx_playbook_filename) | from_yaml }}"
+    #   when: nfc_pb_awx_playbook_filename | default('') != ''
     #   failed_when: false
 
 
     # - name: Job Template from Playbook
     #   ansible.builtin.set_fact:
     #     # playbook_contents: "{{ playbook_contents[0] }}"
-    #     # awx_name: "{{ playbook_contents[0].name }}"
-    #     awx_tower_template: "{{ awx_job_template.vars.awx_tower_template }}"
-    #   when: playbook_contents[0].vars.awx_tower_template | default([]) | length | int > 0
+    #     # nfc_pb_awx_name: "{{ playbook_contents[0].name }}"
+    #     nfc_pb_awx_tower_template: "{{ nfc_pb_awx_job_template.vars.nfc_pb_awx_tower_template }}"
+    #   when: playbook_contents[0].vars.nfc_pb_awx_tower_template | default([]) | length | int > 0
     #   loop: "{{ playbook_contents }}"
     #   loop_control:
     #     loop_var: job_template
     #   failed_when: false
 
     - name: Create Labels
       awx.awx.label:
-        controller_host: "{{ awx_controller_host | default(omit) }}"
-        controller_oauthtoken: "{{ awx_controller_oauthtoken | default(omit) }}"
-        controller_username: "{{ awx_controller_username | default(omit) }}"
-        controller_password: "{{ awx_controller_password | default(omit) }}"
+        controller_host: "{{ nfc_pb_awx_controller_host | default(omit) }}"
+        controller_oauthtoken: "{{ nfc_pb_awx_controller_oauthtoken | default(omit) }}"
+        controller_username: "{{ nfc_pb_awx_controller_username | default(omit) }}"
+        controller_password: "{{ nfc_pb_awx_controller_password | default(omit) }}"
         name: "{{ item }}"
-        organization: "{{ awx_organization.name }}"
+        organization: "{{ nfc_pb_awx_organization.name }}"
         state: present
         validate_certs: "{{ validate_certs | default(true) }}"
+      loop: "{{ nfc_pb_awx_job_template.labels | default([]) }}"
 
 
-    - name: "Configure Job Template {{ awx_playbook_dir | default('') }}{{ awx_playbook_filename }}"
+    - name: "Configure Job Template {{ nfc_pb_awx_playbook_dir | default('') }}{{ nfc_pb_awx_playbook_filename }}"
       awx.awx.job_template:
-        name: "{{ awx_job_template.name }}"
-        description: "{{ awx_job_template.description | default(omit) }}"
-        controller_host: "{{ awx_controller_host | default(omit) }}"
-        controller_oauthtoken: "{{ awx_controller_oauthtoken | default(omit) }}"
-        controller_username: "{{ awx_controller_username | default(omit) }}"
-        controller_password: "{{ awx_controller_password | default(omit) }}"
-        execution_environment: "{{ awx_job_template.execution_environment | default(omit) }}"
-        job_type: "{{ awx_job_template.job_type | default('run') }}"
-        job_tags: "{{ awx_job_template.job_tags | default(omit) }}"
-        organization: "{{ awx_organization.name }}"
-        # inventory: "{{ awx_inventory.name | default(omit) }}"
-        project: "{{ awx_project.name }}"
-        playbook: "{{ awx_project.path | default('') }}{{ awx_playbook_filename }}"
-        # scm_branch: "{{ awx_branch }}"
-        ask_tags_on_launch: "{{ awx_job_template.ask_tags_on_launch | default(false) | bool }}"
-        ask_inventory_on_launch: "{{ awx_job_template.ask_inventory_on_launch | default(true) | bool }}"
-        credentials: "{{ awx_job_template.credentials | default(omit) }}"
-        state: "{{ awx_job_template.state | default('present') }}"
-        survey_enabled: "{{ awx_job_template.survey_enabled | default(false) | bool }}"
-        # survey_spec: "{{ awx_job_template.survey_spec | from_yaml | to_json | default(omit) }}"
+        name: "{{ nfc_pb_awx_job_template.name }}"
+        description: "{{ nfc_pb_awx_job_template.description | default(omit) }}"
+        controller_host: "{{ nfc_pb_awx_controller_host | default(omit) }}"
+        controller_oauthtoken: "{{ nfc_pb_awx_controller_oauthtoken | default(omit) }}"
+        controller_username: "{{ nfc_pb_awx_controller_username | default(omit) }}"
+        controller_password: "{{ nfc_pb_awx_controller_password | default(omit) }}"
+        execution_environment: "{{ nfc_pb_awx_job_template.execution_environment | default(omit) }}"
+        job_type: "{{ nfc_pb_awx_job_template.job_type | default('run') }}"
+        job_tags: "{{ nfc_pb_awx_job_template.job_tags | default(omit) }}"
+        organization: "{{ nfc_pb_awx_organization.name }}"
+        # inventory: "{{ nfc_pb_awx_inventory.name | default(omit) }}"
+        project: "{{ nfc_pb_awx_project.name }}"
+        playbook: "{{ nfc_pb_awx_project.path | default('') }}{{ nfc_pb_awx_playbook_filename }}"
+        # scm_branch: "{{ nfc_pb_awx_branch }}"
+        ask_tags_on_launch: "{{ nfc_pb_awx_job_template.ask_tags_on_launch | default(false) | bool }}"
+        ask_inventory_on_launch: "{{ nfc_pb_awx_job_template.ask_inventory_on_launch | default(true) | bool }}"
+        credentials: "{{ nfc_pb_awx_job_template.credentials | default(omit) }}"
+        state: "{{ nfc_pb_awx_job_template.state | default('present') }}"
+        survey_enabled: "{{ nfc_pb_awx_job_template.survey_enabled | default(false) | bool }}"
+        # survey_spec: "{{ nfc_pb_awx_job_template.survey_spec | from_yaml | to_json | default(omit) }}"
         survey_spec: >-
-          {%- if awx_job_template.survey_spec | default ('') == '' -%}
+          {%- if nfc_pb_awx_job_template.survey_spec | default ('') == '' -%}
           {{ omit }}
           {%- else -%}
-          {{ awx_job_template.survey_spec | from_yaml | to_json }}
+          {{ nfc_pb_awx_job_template.survey_spec | from_yaml | to_json }}
           {%- endif -%}
+        labels: "{{ nfc_pb_awx_job_template.labels | default(omit) }}"
+        verbosity: "{{ nfc_pb_awx_job_template.verbosity | default(2) }}"
+        ask_scm_branch_on_launch: "{{ nfc_pb_awx_job_template.ask_scm_branch_on_launch | default(false) | bool }}"
+        ask_limit_on_launch: "{{ nfc_pb_awx_job_template.ask_limit_on_launch | default(false) | bool }}"
+        ask_job_type_on_launch: "{{ nfc_pb_awx_job_template.ask_job_type_on_launch | default(true) | bool }}"
+        use_fact_cache: "{{ nfc_pb_awx_job_template.use_fact_cache | default(true) | bool }}"
         validate_certs: "{{ validate_certs | default(true) }}"
       # no_log: true
-      when: awx_tower_template | default('') != ''
+      when: nfc_pb_awx_tower_template | default('') != ''
       diff: true
 
 
-    - name: "RBAC - {{ awx_organization.name }}/Project/{{ awx_project.name }}/Job/{{ awx_job_template.name }}"
+    - name: "RBAC - {{ nfc_pb_awx_organization.name }}/Project/{{ nfc_pb_awx_project.name }}/Job/{{ nfc_pb_awx_job_template.name }}"
       ansible.builtin.include_tasks:
         file: tasks/awx/rbac.yaml
-      loop: "{{ awx_project.rbac.job }}"
+      loop: "{{ nfc_pb_awx_project.rbac.job }}"
       loop_control:
-        loop_var: awx_rbac
+        loop_var: nfc_pb_awx_rbac
       when:
         (
-          awx_project.type | lower == 'playbook'
+          nfc_pb_awx_project.type | lower == 'playbook'
             or
-          awx_project.type | lower == 'both'
+          nfc_pb_awx_project.type | lower == 'both'
         )
       vars:
-        job_template_name: "{{ awx_job_template.name }}"
+        nfc_pb_awx_job_template_name: "{{ nfc_pb_awx_job_template.name }}"
 
     # - name: Fact Cleanup - job_template
     #   ansible.builtin.set_fact:
-    #     awx_tower_template:
+    #     nfc_pb_awx_job_template_name:
diff --git a/tasks/awx/job_templates.yaml b/tasks/awx/job_templates.yaml
@@ -3,14 +3,14 @@
 - name: Debug
   ansible.builtin.debug:
     msg:
-      - "{{ awx_playbook_filename }}"
+      - "{{ nfc_pb_awx_playbook_filename }}"
 
 
 - name: Create fact from Playbook
   ansible.builtin.set_fact:
-    awx_tower_templates: []
-    playbook_contents: "{{ lookup('file', item.root + awx_playbook_filename) | from_yaml }}"
-  when: awx_playbook_filename | default('') != ''
+    nfc_pb_awx_tower_templates: []
+    playbook_contents: "{{ lookup('file', item.root + nfc_pb_awx_playbook_filename) | from_yaml }}"
+  when: nfc_pb_awx_playbook_filename | default('') != ''
   failed_when: false
 
 
@@ -22,7 +22,7 @@
 
 - name: Job Template from Playbook
   ansible.builtin.set_fact:
-    awx_tower_templates: "{{ awx_tower_templates + job_template.vars.awx_tower_template }}"
+    nfc_pb_awx_tower_templates: "{{ nfc_pb_awx_tower_templates + job_template.vars.awx_tower_template }}"
   when: >
     job_template.vars | default({}) | length | int > 0
       and
@@ -36,18 +36,19 @@
 - name: Add Job template
   ansible.builtin.include_tasks:
     file: tasks/awx/job_template.yaml
-  loop: "{{ awx_tower_templates }}"
+  loop: "{{ nfc_pb_awx_tower_templates }}"
   loop_control:
-    loop_var: awx_job_template
+    loop_var: nfc_pb_awx_job_template
   when: >
     item.state == 'file'
       and
     'yaml' in item.path
       and
-    item.path|basename|replace(".yaml","") not in awx_project.job_template_ignore | default([])
+    item.path|basename|replace(".yaml","") not in nfc_pb_awx_project.job_template_ignore | default([])
 
 
 - name: Fact Cleanup - job_template
   ansible.builtin.set_fact:
-    awx_tower_templates: []
-    awx_playbook_filename:
+    nfc_pb_awx_tower_templates: []
+    nfc_pb_awx_playbook_filename:
+    # nfc_pb_awx_job_template_name:
diff --git a/tasks/awx/organization.yaml b/tasks/awx/organization.yaml
diff --git a/tasks/awx/project.yaml b/tasks/awx/project.yaml
diff --git a/tasks/awx/rbac.yaml b/tasks/awx/rbac.yaml
diff --git a/tasks/awx/team.yaml b/tasks/awx/team.yaml
