refactor!: rename role variables to role-prefixed names for ansible-lint compliance (#148)

Author: beechesII

.config/ansible-lint.yml

@@ -5,15 +5,11 @@ exclude_paths:
   - .yamllint
   - molecule/
   - .github/
+  - galaxy.yml
 
 # install collection dependencies
 offline: false
 
-skip_list:
-  - yaml[line-length]
-
 warn_list:
-  - var-naming[no-role-prefix]
   - args[module]
-  - fqcn[action-core]
   - meta-runtime[unsupported-version]

roles/icinga_agent/defaults/main.yml

@@ -22,9 +22,9 @@ icinga_agent_api_conf: |
   accept_config = true
   accept_commands = true
 
-icinga2_user:
+icinga_agent_icinga2_user:
   Debian: nagios
   RedHat: icinga
-icinga2_group:
+icinga_agent_icinga2_group:
   Debian: nagios
   RedHat: icinga

roles/icinga_agent/tasks/main.yml

@@ -10,17 +10,17 @@
   ansible.builtin.file:
     path: /etc/icinga2/repository.d
     mode: "0750"
-    owner: "{{ icinga2_user[ansible_facts.os_family] }}"
-    group: "{{ icinga2_group[ansible_facts.os_family] }}"
+    owner: "{{ icinga_agent_icinga2_user[ansible_facts.os_family] }}"
+    group: "{{ icinga_agent_icinga2_group[ansible_facts.os_family] }}"
     state: directory
 
 - name: Create features-* folders in case it is missing
   ansible.builtin.file:
     path: "{{ item }}"
     state: directory
     mode: "0750"
-    owner: "{{ icinga2_user[ansible_facts.os_family] }}"
-    group: "{{ icinga2_group[ansible_facts.os_family] }}"
+    owner: "{{ icinga_agent_icinga2_user[ansible_facts.os_family] }}"
+    group: "{{ icinga_agent_icinga2_group[ansible_facts.os_family] }}"
   loop:
     - /etc/icinga2/features-available/
     - /etc/icinga2/features-enabled/
@@ -29,8 +29,8 @@
   ansible.builtin.template:
     src: "{{ item }}"
     dest: /etc/icinga2/{{ item | basename | regex_replace('.j2', '') }}
-    owner: "{{ icinga2_user[ansible_facts.os_family] }}"
-    group: "{{ icinga2_group[ansible_facts.os_family] }}"
+    owner: "{{ icinga_agent_icinga2_user[ansible_facts.os_family] }}"
+    group: "{{ icinga_agent_icinga2_group[ansible_facts.os_family] }}"
     mode: "0640"
   with_fileglob:
     - ../templates/configuration/*
@@ -41,8 +41,8 @@
   ansible.builtin.template:
     src: "{{ item }}"
     dest: /etc/icinga2/features-available/{{ item | basename | regex_replace('.j2', '') }}
-    owner: "{{ icinga2_user[ansible_facts.os_family] }}"
-    group: "{{ icinga2_group[ansible_facts.os_family] }}"
+    owner: "{{ icinga_agent_icinga2_user[ansible_facts.os_family] }}"
+    group: "{{ icinga_agent_icinga2_group[ansible_facts.os_family] }}"
     mode: "0640"
   with_fileglob:
     - ../templates/features/*
@@ -53,8 +53,8 @@
   ansible.builtin.template:
     src: "{{ item }}"
     dest: /etc/icinga2/features-available/{{ item | basename | regex_replace('.j2', '') }}
-    owner: "{{ icinga2_user[ansible_facts.os_family] }}"
-    group: "{{ icinga2_group[ansible_facts.os_family] }}"
+    owner: "{{ icinga_agent_icinga2_user[ansible_facts.os_family] }}"
+    group: "{{ icinga_agent_icinga2_group[ansible_facts.os_family] }}"
     mode: "0640"
   with_fileglob:
     - "{{ icinga_agent_custom_features_template_path }}"
@@ -86,17 +86,17 @@
         path: /var/lib/icinga2/certs/
         state: directory
         mode: "0750"
-        owner: "{{ icinga2_user[ansible_facts.os_family] }}"
-        group: "{{ icinga2_group[ansible_facts.os_family] }}"
+        owner: "{{ icinga_agent_icinga2_user[ansible_facts.os_family] }}"
+        group: "{{ icinga_agent_icinga2_group[ansible_facts.os_family] }}"
 
     - name: Generate ticket and save it as a variable
       ansible.builtin.command: >
         /usr/sbin/icinga2 pki ticket --cn {{ icinga_agent_hostname }} --salt {{ icinga_agent_salt }}
       environment:
         LD_LIBRARY_PATH: /usr/lib64
-      register: ticket
+      register: icinga_agent_ticket
       changed_when: false
-      failed_when: ticket.rc != 0
+      failed_when: icinga_agent_ticket.rc != 0
 
     - name: Create certificate
       ansible.builtin.command: >
@@ -119,7 +119,7 @@
       ansible.builtin.command: >
         /usr/sbin/icinga2 pki request --host {{ icinga_agent_ca_host }}
         --port {{ icinga_agent_ca_host_icinga_port }}
-        --ticket {{ ticket.stdout }} --key /var/lib/icinga2/certs/{{ icinga_agent_hostname }}.key
+        --ticket {{ icinga_agent_ticket.stdout }} --key /var/lib/icinga2/certs/{{ icinga_agent_hostname }}.key
         --cert /var/lib/icinga2/certs/{{ icinga_agent_hostname }}.crt
         --trustedcert /var/lib/icinga2/certs/trusted-master.crt --ca /var/lib/icinga2/certs/ca.crt
       args:

roles/icinga_downtime/README.md

@@ -5,36 +5,34 @@ You can add a downtime for a group or a single host, both included or excluded t
 Or you can set a downtime for a dedicated service of a group or single host.
 Additionally current downtimes set by Ansible can be removed.
 
-
 ## Requirements
 
-- The name of the ansible hosts inside the inventory has to be exactly the same as the icinga objects, due to using the ansible hostname as icinga target filter.
+- The name of the ansible hosts inside the inventory has to be exactly the same as the icinga objects, due to using the ansible hostname as icinga icinga_downtime_target filter.
 
 ## Role Variables
 
 | Variable                 | Required    | Default                        | Description
 |-|-|-|-|
-| target                   | mandatory   | ""                             | define icinga-host-objects as target (must be identically in ansibles inventory)
-| icinga_action            | mandatory   | ""                             | "add_downtimes" or "remove_downtimes"
-| icinga_api_uri           | mandatory   | ""                             | URL of the Icinga instance could be "https://<hostname>.<domain>
-| icinga_api_user          | mandatory   | ""                             | User with access to the REST-API
-| icinga_api_pwd           | mandatory   | ""                             | Password of the User, should be encrypted e.g. with ansible-vault
-| icinga_api_port          | optional    | "5665"                         | Icinga API port
-| duration                 | optional    | "2"                            | Duration of the downtime
-| duration_unit            | optional    | "hours"                        | Unit of the duration
-| author                   | optional    | "Ansible"                      | Author of the downtime
-| comment                  | optional    | "Downtime set by automation"   | Comment to be added to the downtime
-| host_downtime            | optional    | true                           | Also set a downtime for the host
-| service_downtime         | optional    | true                           | Also set a downtime for the services
-| single_service_downtime  | optional    | false                          | Only set a downtime for a single service
-| host_service_downtime    | optional    | false                          | Only set a downtime for a single host
-| service_filter           | optional    | ""                             | Add a service filter to the downtime
+| icinga_downtime_target                   | mandatory   | ""                             | define icinga-host-objects as target (must be identically in ansibles inventory)
+| icinga_downtime_icinga_action            | mandatory   | ""                             | "add_downtimes" or "remove_downtimes"
+| icinga_downtime_icinga_api_uri           | mandatory   | ""                             | URL of the Icinga instance could be "https://<hostname>.<domain>
+| icinga_downtime_icinga_api_user          | mandatory   | ""                             | User with access to the REST-API
+| icinga_downtime_icinga_api_password      | mandatory   | ""                             | Password of the User, should be encrypted e.g. with ansible-vault
+| icinga_downtime_icinga_api_port          | optional    | "5665"                         | Icinga API port
+| icinga_downtime_duration                 | optional    | "2"                            | Duration of the downtime
+| icinga_downtime_duration_unit            | optional    | "hours"                        | Unit of the duration
+| icinga_downtime_author                   | optional    | "Ansible"                      | Author of the downtime
+| icinga_downtime_comment                  | optional    | "Downtime set by automation"   | Comment to be added to the downtime
+| icinga_downtime_host_downtime            | optional    | true                           | Also set a downtime for the host
+| icinga_downtime_service_downtime         | optional    | true                           | Also set a downtime for the services
+| icinga_downtime_single_service_downtime  | optional    | false                          | Only set a downtime for a single service
+| icinga_downtime_host_service_downtime    | optional    | false                          | Only set a downtime for a single host
+| icinga_downtime_service_filter           | optional    | ""                             | Add a service filter to the downtime
 
 ## Dependencies
 
 - no dependencies
 
-
 ## Examples
 
 ```
@@ -50,19 +48,19 @@ Additionally current downtimes set by Ansible can be removed.
 
 ```
 # command template
-ansible-playbook <path_to_playbooks/playbook.yml> -i <path_to_inventory/hosts> -e target="<groupname>" -e icinga_action="<icinga_action>"
+ansible-playbook <path_to_playbooks/playbook.yml> -i <path_to_inventory/hosts> -e icinga_downtime_target="<groupname>" -e icinga_downtime_icinga_action="<icinga_downtime_icinga_action>"
 
 # add downtime for all hosts in group devhosts and all of its services
-ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e target="devhosts" -e icinga_action="add_downtimes"
+ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e icinga_downtime_target="devhosts" -e icinga_downtime_icinga_action="add_downtimes"
 
 # remove downtime for all hosts in group devhosts and all of its services
-ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e target="devhosts" -e icinga_action="remove_downtimes"
+ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e icinga_downtime_target="devhosts" -e icinga_downtime_icinga_action="remove_downtimes"
 
 # add downtime for load-check of all hosts in group devhosts
-ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e target="devhosts" -e icinga_action="add_downtimes" -e single_service_downtime="true" -e service_filter="load"
+ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e icinga_downtime_target="devhosts" -e icinga_downtime_icinga_action="add_downtimes" -e single_service_downtime="true" -e service_filter="load"
 
 # add downtime for single host "hostname1" and all its services
-ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e target="hostname1" -e icinga_action="add_downtimes" -e single_host_downtime="true"
+ansible-playbook ./playbooks/playbook.yml -i inventories/inventory/hosts -e icinga_downtime_target="hostname1" -e icinga_downtime_icinga_action="add_downtimes" -e single_host_downtime="true"
 ```
 
 ## Author Information

roles/icinga_downtime/defaults/main.yml

@@ -1,11 +1,11 @@
 ---
-duration: 2
-duration_unit: hours
-author: Ansible
-comment: Downtime set by automation
-host_downtime: true
-service_downtime: true
-single_service_downtime: false
-single_host_downtime: false
-service_filter: ""
-icinga_api_port: "5665"
+icinga_downtime_duration: 2
+icinga_downtime_duration_unit: hours
+icinga_downtime_author: Ansible
+icinga_downtime_comment: Downtime set by automation
+icinga_downtime_host_downtime: true
+icinga_downtime_service_downtime: true
+icinga_downtime_single_service_downtime: false
+icinga_downtime_single_host_downtime: false
+icinga_downtime_service_filter: ""
+icinga_downtime_icinga_api_port: "5665"

roles/icinga_downtime/tasks/add_downtimes.yml

@@ -1,9 +1,10 @@
 ---
 - name: Add icinga host downtimes
+  when: icinga_downtime_host_downtime | bool
   ansible.builtin.uri:
-    url: "{{ icinga_api_uri }}:{{ icinga_api_port }}/v1/actions/schedule-downtime?type=Host"
-    url_username: "{{ icinga_api_user }}"
-    url_password: "{{ icinga_api_password }}"
+    url: "{{ icinga_downtime_icinga_api_uri }}:{{ icinga_downtime_icinga_api_port }}/v1/actions/schedule-downtime?type=Host"
+    url_username: "{{ icinga_downtime_icinga_api_user }}"
+    url_password: "{{ icinga_downtime_icinga_api_password }}"
     validate_certs: true
     method: POST
     status_code: 200
@@ -13,23 +14,24 @@
     body_format: json
     body: '{
              "filter": "host.name==\"{{ item }}\"",
-             "author": "{{ author }}",
-             "comment": "{{ comment }}",
-             "start_time": "{{ start_time_now }}",
-             "end_time": "{{ end_time }}",
+             "author": "{{ icinga_downtime_author }}",
+             "comment": "{{ icinga_downtime_comment }}",
+             "start_time": "{{ icinga_downtime_start_time_now }}",
+             "end_time": "{{ icinga_downtime_end_time }}",
              "pretty": true,
              "fixed": true,
            }'
   loop:
-    - "{{ icinga_host_filter }}"
-  when:
-    - host_downtime | bool
+    - "{{ icinga_downtime_host_filter }}"
 
 - name: Add icinga service downtimes
+  when:
+    - icinga_downtime_service_downtime | bool
+    - icinga_downtime_service_filter == ''
   ansible.builtin.uri:
-    url: "{{ icinga_api_uri }}:{{ icinga_api_port }}/v1/actions/schedule-downtime?type=Service"
-    url_username: "{{ icinga_api_user }}"
-    url_password: "{{ icinga_api_password }}"
+    url: "{{ icinga_downtime_icinga_api_uri }}:{{ icinga_downtime_icinga_api_port }}/v1/actions/schedule-downtime?type=Service"
+    url_username: "{{ icinga_downtime_icinga_api_user }}"
+    url_password: "{{ icinga_downtime_icinga_api_password }}"
     validate_certs: true
     method: POST
     status_code: 200
@@ -39,25 +41,25 @@
     body_format: json
     body: '{
              "filter": "host.name==\"{{ item }}\"",
-             "author": "{{ author }}",
-             "comment": "{{ comment }}",
-             "start_time": {{ start_time_now }},
-             "end_time": {{ end_time }},
+             "author": "{{ icinga_downtime_author }}",
+             "comment": "{{ icinga_downtime_comment }}",
+             "start_time": {{ icinga_downtime_start_time_now }},
+             "end_time": {{ icinga_downtime_end_time }},
              "pretty": true,
              "fixed": true,
            }'
   delegate_to: localhost
   loop:
-    - "{{ icinga_host_filter }}"
-  when:
-    - service_downtime | bool
-    - service_filter == ''
+    - "{{ icinga_downtime_host_filter }}"
 
 - name: Add icinga single service downtimes
+  when:
+    - icinga_downtime_single_service_downtime | bool
+    - icinga_downtime_service_filter != ''
   ansible.builtin.uri:
-    url: "{{ icinga_api_uri }}:{{ icinga_api_port }}/v1/actions/schedule-downtime?type=Service"
-    url_username: "{{ icinga_api_user }}"
-    url_password: "{{ icinga_api_password }}"
+    url: "{{ icinga_downtime_icinga_api_uri }}:{{ icinga_downtime_icinga_api_port }}/v1/actions/schedule-downtime?type=Service"
+    url_username: "{{ icinga_downtime_icinga_api_user }}"
+    url_password: "{{ icinga_downtime_icinga_api_password }}"
     validate_certs: true
     method: POST
     status_code: 200
@@ -66,17 +68,14 @@
       Accept: application/json
     body_format: json
     body: '{
-             "filter": "host.name==\"{{ item }}\" && match(\"*{{ service_filter }}*\",service.name)",
-             "author": "{{ author }}",
-             "comment": "{{ comment }}",
-             "start_time": {{ start_time_now }},
-             "end_time": {{ end_time }},
+             "filter": "host.name==\"{{ item }}\" && match("*{{ icinga_downtime_service_filter }}*",service.name)",
+             "author": "{{ icinga_downtime_author }}",
+             "comment": "{{ icinga_downtime_comment }}",
+             "start_time": {{ icinga_downtime_start_time_now }},
+             "end_time": {{ icinga_downtime_end_time }},
              "pretty": true,
              "fixed": true,
            }'
   delegate_to: localhost
   loop:
-    - "{{ icinga_host_filter }}"
-  when:
-    - single_service_downtime | bool
-    - service_filter != ''
+    - "{{ icinga_downtime_host_filter }}"

roles/icinga_downtime/tasks/main.yml

@@ -1,40 +1,39 @@
 ---
 - name: Set facts for start_time_now and end_time of the maintenance window
+  when: icinga_downtime_icinga_action == "add_downtimes"
   ansible.builtin.set_fact:
-    start_time_now: "{{ ansible_facts.date_time.epoch }}"
-    end_time: "{{ ((duration + duration_unit) | community.general.to_time_unit('seconds') | int) + ansible_facts.date_time.epoch | int }}"
+    icinga_downtime_start_time_now: "{{ ansible_facts.date_time.epoch }}"
+    icinga_downtime_end_time: >-
+      {{
+        ((icinga_downtime_duration + icinga_downtime_duration_unit)
+        | community.general.to_time_unit('seconds') | int)
+        + ansible_facts.date_time.epoch | int
+      }}
   delegate_to: localhost
   run_once: true
   changed_when: false
-  when:
-    - icinga_action == "add_downtimes"
 
 - name: Define icinga_host_filter as single host
+  when: icinga_downtime_single_host_downtime | bool
   ansible.builtin.set_fact:
-    icinga_host_filter: "{{ target }}"
-  when:
-    - single_host_downtime | bool
+    icinga_downtime_host_filter: "{{ icinga_downtime_target }}"
 
 - name: Define icinga_host_filter as group
+  when: not (icinga_downtime_single_host_downtime | bool)
   ansible.builtin.set_fact:
-    icinga_host_filter: "{{ groups[target] | list | flatten }}"
-  when:
-    - not (single_host_downtime | bool)
+    icinga_downtime_host_filter: "{{ groups[icinga_downtime_target] | list | flatten }}"
 
 - name: Include add_downtimes
+  when: icinga_downtime_icinga_action == "add_downtimes"
   ansible.builtin.include_tasks:
     file: add_downtimes.yml
-  when:
-    - icinga_action == "add_downtimes"
 
 - name: Include remove_downtimes
+  when: icinga_downtime_icinga_action == "remove_downtimes"
   ansible.builtin.include_tasks:
     file: remove_downtimes.yml
-  when:
-    - icinga_action == "remove_downtimes"
 
 - name: Include remove_all_downtimes
+  when: icinga_downtime_icinga_action == "remove_all_downtimes"
   ansible.builtin.include_tasks:
     file: remove_all_downtimes.yml
-  when:
-    - icinga_action == "remove_all_downtimes"

roles/icinga_downtime/tasks/remove_all_downtimes.yml

@@ -1,9 +1,9 @@
 ---
 - name: Delete all icinga downtimes (host and service)
   ansible.builtin.uri:
-    url: "{{ icinga_api_uri }}:{{ icinga_api_port }}/v1/actions/remove-downtime?type=Downtime"
-    url_username: "{{ icinga_api_user }}"
-    url_password: "{{ icinga_api_password }}"
+    url: "{{ icinga_downtime_icinga_api_uri }}:{{ icinga_downtime_icinga_api_port }}/v1/actions/remove-downtime?type=Downtime"
+    url_username: "{{ icinga_downtime_icinga_api_user }}"
+    url_password: "{{ icinga_downtime_icinga_api_password }}"
     validate_certs: true
     method: POST
     status_code: 200
@@ -14,4 +14,4 @@
     body: '{ "filter": "host.name==\"{{ item }}\"", "pretty": true }'
   delegate_to: localhost
   with_inventory_hostnames:
-    - "{{ groups[icinga_host_filter] }}"
+    - "{{ groups[icinga_downtime_host_filter] }}"