Fix all ansible-lint issues

Author: olliewalsh

.ansible-lint

@@ -1,10 +1,9 @@
+---
 skip_list:
-  - '204'
-  - '301'
-  - '306'
-  - '602'
-  - '701'
-  - 'ignore-errors'
+  - "no-changed-when"
+  - "ignore-errors"
+  - "name[template]"
+  - "risky-shell-pipe"
 
 # warn_list: # or 'skip_list' to silence them completely
 
@@ -13,6 +12,7 @@ exclude_paths:
   - ansible/files
   - ansible/roles/cnosp/files
   - .github/workflows
+  - .ansible
 
 kinds:
   - tasks: "**/*_tasks.yaml"

.ansible-lint-ignore

@@ -1,21 +1,22 @@
 ---
-- hosts: localhost
+- name: CNOSP Cleanup
+  hosts: localhost
   vars_files: vars/default.yaml
   roles:
-  - oc_local
+    - oc_local
 
   tasks:
-  - name: Delete the ctlplane
-    include_role:
-      name: cnosp
-      tasks_from: ctlplane_cleanup
+    - name: Delete the ctlplane
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: ctlplane_cleanup
 
-  - name: Delete OVN
-    include_role:
-      name: cnosp
-      tasks_from: ovn_cleanup
+    - name: Delete OVN
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: ovn_cleanup
 
-  - name: Delete cnosp openstackclient
-    include_role:
-      name: cnosp
-      tasks_from: openstackclient_cleanup
+    - name: Delete cnosp openstackclient
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: openstackclient_cleanup

ansible/cnosp_ctlplane_cleanup.yaml

@@ -1,38 +1,40 @@
 ---
-- hosts: convergence_base
+- name: CNOSP Prepare NFS service for cinder
+  hosts: convergence_base
   gather_facts: false
   become: true
   user: root
   vars_files: vars/default.yaml
 
   tasks:
-  - name: Prepare NFS service for cinder
-    include_role:
-      name: cnosp
-      tasks_from: cinder_nfs_prepare
+    - name: Prepare NFS service for cinder
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: cinder_nfs_prepare
 
-- hosts: localhost
+- name: CNOSP ControlPlane
+  hosts: localhost
   vars_files: vars/default.yaml
   roles:
-  - oc_local
+    - oc_local
 
   tasks:
-  - name: Config OSP ctlplane services
-    include_role:
-      name: cnosp
-      tasks_from: ctlplane_config
+    - name: Config OSP ctlplane services
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: ctlplane_config
 
-  - name: Setup OVN
-    include_role:
-      name: cnosp
-      tasks_from: ovn_install
+    - name: Setup OVN
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: ovn_install
 
-  - name: Deploy the ctlplane
-    include_role:
-      name: cnosp
-      tasks_from: ctlplane_deploy
+    - name: Deploy the ctlplane
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: ctlplane_deploy
 
-  - name: Deploy the cnosp openstackclient
-    include_role:
-      name: cnosp
-      tasks_from: openstackclient_install
+    - name: Deploy the cnosp openstackclient
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: openstackclient_install

ansible/cnosp_ctlplane_deploy.yaml

@@ -1,15 +1,15 @@
 #!/usr/bin/env ansible-playbook
 ---
-- hosts: localhost
+- name: CNOSP OLM
+  hosts: localhost
   vars_files: "vars/default.yaml"
   roles:
-  - oc_local
+    - oc_local
 
   tasks:
-  - name: Deploy cnosp operators
-    include_role:
-      name: cnosp
-      tasks_from: olm
-    vars:
-      _csv_version: "{{ cnosp_csv_version }}"
-
+    - name: Deploy cnosp operators
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: olm
+      vars:
+        _csv_version: "{{ cnosp_csv_version }}" # noqa: var-naming[no-role-prefix]

ansible/cnosp_olm.yaml

@@ -1,14 +1,15 @@
 #!/usr/bin/env ansible-playbook
 ---
-- hosts: localhost
+- name: CNOSP OLM Cleanup
+  hosts: localhost
   vars_files: "vars/default.yaml"
   roles:
-  - oc_local
+    - oc_local
 
   tasks:
-  - name: Deinstall cnosp operators
-    include_role:
-      name: cnosp
-      tasks_from: olm_cleanup
-    vars:
-      _csv_version: "{{ cnosp_csv_version }}"
+    - name: Deinstall cnosp operators
+      ansible.builtin.include_role:
+        name: cnosp
+        tasks_from: olm_cleanup
+      vars:
+        _csv_version: "{{ cnosp_csv_version }}" # noqa: var-naming[no-role-prefix]

ansible/cnosp_olm_cleanup.yaml

@@ -1,74 +1,77 @@
 ---
-- hosts: localhost
+- name: ConfigGenerator
+  hosts: localhost
   vars_files: vars/default.yaml
   roles:
-  - oc_local
+    - oc_local
 
   tasks:
-  - name: Set combined osp dict
-    set_fact:
-      osp: "{{ osp_defaults | combine((osp_release_defaults | default({})), recursive=True) | combine((osp_local | default({})), recursive=True) }}"
+    - name: Set combined osp dict
+      ansible.builtin.set_fact:
+        osp: "{{ osp_defaults | combine((osp_release_defaults | default({})), recursive=True) | combine((osp_local | default({})), recursive=True) }}"
 
-  - name: Set directory for generator yaml files
-    set_fact:
-      config_generator_yaml_dir: "{{ working_yamls_dir }}/config_generator_{{ config_generator_name|default('default') }}"
+    - name: Set directory for generator yaml files
+      ansible.builtin.set_fact:
+        config_generator_yaml_dir: "{{ working_yamls_dir }}/config_generator_{{ config_generator_name | default('default') }}"
 
-  - name: show yaml output dir
-    debug:
-      msg: "yamls will be written to {{ config_generator_yaml_dir }} locally"
+    - name: Show yaml output dir
+      ansible.builtin.debug:
+        msg: "yamls will be written to {{ config_generator_yaml_dir }} locally"
 
-  - name: Clean yaml dir
-    file:
-      state: absent
-      path: "{{ config_generator_yaml_dir }}/"
+    - name: Clean yaml dir
+      ansible.builtin.file:
+        state: absent
+        path: "{{ config_generator_yaml_dir }}/"
 
-  - name: Create yaml dir
-    file:
-      path: "{{ config_generator_yaml_dir }}"
-      state: directory
-      mode: '0755'
+    - name: Create yaml dir
+      ansible.builtin.file:
+        path: "{{ config_generator_yaml_dir }}"
+        state: directory
+        mode: "0755"
 
-  - name: Render templates to yaml dir
-    template:
-      src: "osp/config_generator/{{ item }}.j2"
-      dest: "{{ config_generator_yaml_dir }}/{{ item }}"
-      mode: '0644'
-    with_items:
-    - "openstackconfiggenerator.yaml"
+    - name: Render templates to yaml dir
+      ansible.builtin.template:
+        src: "osp/config_generator/{{ item }}.j2"
+        dest: "{{ config_generator_yaml_dir }}/{{ item }}"
+        mode: "0644"
+      with_items:
+        - "openstackconfiggenerator.yaml"
 
-  - name: Check if config generator exists
-    environment: &oc_env
-      PATH: "{{ oc_env_path }}"
-      KUBECONFIG: "{{ kubeconfig }}"
-    ignore_errors: true
-    command: oc get osconfiggenerator -n openstack {{ config_generator_name|default('default') }} -o name
-    register: osconfiggen_check_exists
+    - name: Check if config generator exists
+      environment: &oc_env
+        PATH: "{{ oc_env_path }}"
+        KUBECONFIG: "{{ kubeconfig }}"
+      ignore_errors: true
+      ansible.builtin.command: oc get osconfiggenerator -n openstack {{ config_generator_name | default('default') }} -o name
+      register: osconfiggen_check_exists
 
-  - set_fact:
-      osconfiggen_exists: "{{ osconfiggen_check_exists.rc == 0 }}"
+    - name: Set fact
+      ansible.builtin.set_fact:
+        osconfiggen_exists: "{{ osconfiggen_check_exists.rc == 0 }}"
 
-  - name: Start config generator
-    shell: |
-      set -e
-      oc apply -n openstack -f "{{ config_generator_yaml_dir }}/openstackconfiggenerator.yaml"
-    environment:
-      <<: *oc_env
-    when: osconfiggen_exists|bool == false
+    - name: Start config generator
+      ansible.builtin.shell: |
+        set -e
+        oc apply -n openstack -f "{{ config_generator_yaml_dir }}/openstackconfiggenerator.yaml"
+      environment:
+        <<: *oc_env
+      when: not osconfiggen_exists | bool
 
-  - name: Refresh config generator image
-    shell: |
-      oc patch osconfiggenerator -n openstack {{ config_generator_name|default('default') }} --type=json -p="[
-        {'op': 'remove', 'path': '/spec/imageURL'}
-      ]"
-    environment:
-      <<: *oc_env
-    when:
-      - config_generator_update_image|default(False)
-      - osconfiggen_exists|bool
+    - name: Refresh config generator image
+      ansible.builtin.shell: |
+        oc patch osconfiggenerator -n openstack {{ config_generator_name | default('default') }} --type=json -p="[
+          {'op': 'remove', 'path': '/spec/imageURL'}
+        ]"
+      environment:
+        <<: *oc_env
+      when:
+        - config_generator_update_image | default(False)
+        - osconfiggen_exists | bool
 
-  - name: wait for config generator to finish
-    shell: |
-      set -e
-      oc wait -n openstack osconfiggenerator {{ config_generator_name|default('default') }} --for condition=Finished --timeout="{{ (default_timeout * 20)|int }}s"
-    environment:
-      <<: *oc_env
+    - name: Wait for config generator to finish
+      ansible.builtin.shell: |
+        set -e
+        oc wait -n openstack osconfiggenerator {{ config_generator_name | default('default') }} \
+          --for condition=Finished --timeout="{{ (default_timeout * 20) | int }}s"
+      environment:
+        <<: *oc_env