Fix ansible-lint errors in roles - change argument_spec.yml

Signed-off-by: Justin Cinkelj <justin.cinkelj@xlab.si>

Author: justinc1

docs/rst/extra/deprecation.rst

@@ -57,6 +57,17 @@ For ``scale_computing.hypercore.iso`` module:
       ansible.builtin.debug:
         msg: The uploaded_iso size={{ uploaded_iso.record.size }}
 
+Release 1.3.0
+=============
+
+Role parameters were renamed to start with ``role_name_`` prefix.
+For example, role `scale_computing.hypercore.version_update_single_node <../collections/scale_computing/hypercore/version_update_single_node_role.html>`_:
+
+* ``scale_computing_hypercore_desired_version`` name was used before.
+* ``version_update_single_node_desired_version`` name is used now.
+
+Old names are still valid, but will be removed in future release 3.0.0.
+
 Release 3.0.0 (not yet released)
 ================================
 

examples/cluster_config.yml

@@ -50,4 +50,4 @@
       ansible.builtin.include_role:
         name: scale_computing.hypercore.cluster_config
       vars:
-        scale_computing_hypercore_cluster_config: "{{ cluster_configuration }}"
+        cluster_config_configuration: "{{ cluster_configuration }}"

examples/shutdown_restart_tagged_vms.yml

@@ -63,8 +63,8 @@
         name: scale_computing.hypercore.version_update_single_node
         tasks_from: shutdown_vms
       vars:
-        scale_computing_hypercore_shutdown_vms: "{{ vm_desired_state }}"
-        scale_computing_hypercore_shutdown_tags: "{{ vm_shutdown_tags }}"
+        version_update_single_node_shutdown_vms: "{{ vm_desired_state }}"
+        version_update_single_node_shutdown_tags: "{{ vm_shutdown_tags }}"
 
     - name: List tagged VMs power-state after shutdown
       block: *list-tagged-vms
@@ -75,7 +75,7 @@
         name: scale_computing.hypercore.version_update_single_node
         tasks_from: restart_vms.yml
       vars:
-        scale_computing_hypercore_restart_vms: "{{ vm_desired_state }}"
+        version_update_single_node_restart_vms: "{{ vm_desired_state }}"
 
     - name: List tagged VMs power-state after restart
       block: *list-tagged-vms

examples/version_update_single_node.yml

@@ -28,11 +28,11 @@
       ansible.builtin.include_role:
         name: scale_computing.hypercore.check_local_time
       vars:
-        time_zone: "{{ time_zone_info.record.zone }}"
-        time_interval: 22:00-6:00
+        check_local_time_time_zone: "{{ time_zone_info.record.zone }}"
+        check_local_time_time_interval: 22:00-6:00
 
     - name: Update HyperCore single-node system to a desired version
       ansible.builtin.include_role:
         name: scale_computing.hypercore.version_update_single_node
       vars:
-        scale_computing_hypercore_desired_version: "{{ desired_version }}"
+        version_update_single_node_desired_version: "{{ desired_version }}"

roles/check_local_time/defaults/main.yml

@@ -0,0 +1,4 @@
+---
+# renamed variables - if new name is not present, use deprecated name as default value
+check_local_time_time_zone: "{{ time_zone | default(omit) }}"
+check_local_time_time_interval: "{{ time_interval | default(omit) }}"

roles/check_local_time/meta/argument_specs.yml

@@ -5,15 +5,29 @@ argument_specs:
     description:
       - Check if local time meets the required time interval
     options:
-      time_zone:
+      check_local_time_time_zone: &check_local_time_time_zone
         description:
           - Time zone for which to calculate if local time meets the required time interval
           - Must be provided in a form 'Europe/Amsterdam'
         required: true
         type: str
-      time_interval:
+      check_local_time_time_interval: &check_local_time_time_interval
         description:
           - Time interval in which local time must be located
           - Must be provided in a form '22:00-6:15' or '7:30-12:36'
         required: true
         type: str
+      # -------------
+      # Renamed/deprecated vars
+      time_zone:
+        <<: *check_local_time_time_zone
+        description:
+          - DEPRECATED, will be removed in release 3.0.0.
+          - Please use I(check_local_time_time_zone) instead.
+        required: false
+      time_interval:
+        <<: *check_local_time_time_interval
+        description:
+          - DEPRECATED, will be removed in release 3.0.0.
+          - Please use I(check_local_time_time_interval) instead.
+        required: false

roles/check_local_time/tasks/main.yml

@@ -2,13 +2,13 @@
 - name: Check if local time is in time interval (run check_local_time.py)
   ansible.builtin.script:
     executable: "{{ ansible_python_interpreter | default(ansible_playbook_python) }}"
-    cmd: check_local_time.py "{{ time_zone }}" "{{ time_interval }}"
+    cmd: check_local_time.py "{{ check_local_time_time_zone }}" "{{ check_local_time_time_interval }}"
   register: check_local_time_output
 
 - name: Assert that local time is in time interval
   ansible.builtin.assert:
-    fail_msg: "Local time for time zone {{ time_zone }} is not in required time interval {{ time_interval }}"
-    success_msg: "Local time for time zone {{ time_zone }} is in required time interval {{ time_interval }}"
+    fail_msg: "Local time for time zone {{ check_local_time_time_zone }} is not in required time interval {{ check_local_time_time_interval }}"
+    success_msg: "Local time for time zone {{ check_local_time_time_zone }} is in required time interval {{ check_local_time_time_interval }}"
     that:
       - check_local_time_output.stdout_lines[0] == "True"
   register: check_local_time_result

roles/cluster_config/defaults/main.yml

@@ -0,0 +1,3 @@
+---
+# Deprecated scale_computing_hypercore_cluster_config is still used if cluster_config_configuration is not defined
+cluster_config_configuration: "{{ scale_computing_hypercore_cluster_config | default(omit) }}"

roles/cluster_config/meta/argument_specs.yml

@@ -5,7 +5,7 @@ argument_specs:
     description:
       - Role cluster_config can be used to fully configure a new HyperCore server, or partially reconfigure an existing HyperCore server.
     options:
-      scale_computing_hypercore_cluster_config:
+      cluster_config_configuration: &cluster_config_configuration
         description:
           - A dict describing a full or partial cluster configuration.
           - Partial configuration will be used if some of the keys in `scale_computing_hypercore_cluster_config` are omitted.
@@ -167,3 +167,9 @@ argument_specs:
                 choices:
                   - udp
                   - tcp
+      scale_computing_hypercore_cluster_config:
+        <<: *cluster_config_configuration
+        description:
+          - DEPRECATED, will be removed in release 3.0.0.
+          - Please use I(cluster_config_configuration) instead.
+        required: false

roles/cluster_config/tasks/main.yml

@@ -7,72 +7,72 @@
 
 - name: Set cluster name
   scale_computing.hypercore.cluster_name:
-    name_new: "{{ scale_computing_hypercore_cluster_config.name }}"
-  when: scale_computing_hypercore_cluster_config.name | default(False)
+    name_new: "{{ cluster_config_configuration.name }}"
+  when: cluster_config_configuration.name | default(False)
 
 - name: Set registration data
   scale_computing.hypercore.registration:
-    company_name: "{{ scale_computing_hypercore_cluster_config.registration.company_name }}"
-    contact: "{{ scale_computing_hypercore_cluster_config.registration.contact }}"
-    phone: "{{ scale_computing_hypercore_cluster_config.registration.phone }}"
-    email: "{{ scale_computing_hypercore_cluster_config.registration.email }}"
+    company_name: "{{ cluster_config_configuration.registration.company_name }}"
+    contact: "{{ cluster_config_configuration.registration.contact }}"
+    phone: "{{ cluster_config_configuration.registration.phone }}"
+    email: "{{ cluster_config_configuration.registration.email }}"
     state: present
-  when: scale_computing_hypercore_cluster_config.registration | default(False)
+  when: cluster_config_configuration.registration | default(False)
 
 - name: Set DNS servers configuration
   scale_computing.hypercore.dns_config:
-    dns_servers: "{{ scale_computing_hypercore_cluster_config.dns.server_ips | default(omit) }}"
+    dns_servers: "{{ cluster_config_configuration.dns.server_ips | default(omit) }}"
     state: set
   when:
-    - scale_computing_hypercore_cluster_config.dns | default(False)
-    - '"server_ips" in scale_computing_hypercore_cluster_config.dns'
-    - scale_computing_hypercore_cluster_config.dns.server_ips is not none
+    - cluster_config_configuration.dns | default(False)
+    - '"server_ips" in cluster_config_configuration.dns'
+    - cluster_config_configuration.dns.server_ips is not none
 
 - name: Set DNS search_domains configuration
   scale_computing.hypercore.dns_config:
-    dns_servers: "{{ scale_computing_hypercore_cluster_config.dns.server_ips | default(omit) }}"
-    search_domains: "{{ scale_computing_hypercore_cluster_config.dns.search_domains | default(omit) }}"
+    dns_servers: "{{ cluster_config_configuration.dns.server_ips | default(omit) }}"
+    search_domains: "{{ cluster_config_configuration.dns.search_domains | default(omit) }}"
     state: set
   when:
-    - scale_computing_hypercore_cluster_config.dns | default(False)
-    - '"search_domains" in scale_computing_hypercore_cluster_config.dns'
-    - scale_computing_hypercore_cluster_config.dns.search_domains is not none
+    - cluster_config_configuration.dns | default(False)
+    - '"search_domains" in cluster_config_configuration.dns'
+    - cluster_config_configuration.dns.search_domains is not none
 
 - name: Set OIDC configuration
   scale_computing.hypercore.oidc_config:
-    client_id: "{{ scale_computing_hypercore_cluster_config.oidc.client_id }}"
-    shared_secret: "{{ scale_computing_hypercore_cluster_config.oidc.shared_secret | default(omit) }}"
-    certificate: "{{ scale_computing_hypercore_cluster_config.oidc.certificate | default(omit) }}"
-    config_url: "{{ scale_computing_hypercore_cluster_config.oidc.config_url }}"
-    scopes: "{{ scale_computing_hypercore_cluster_config.oidc.scopes }}"
-  when: scale_computing_hypercore_cluster_config.oidc | default(False)
+    client_id: "{{ cluster_config_configuration.oidc.client_id }}"
+    shared_secret: "{{ cluster_config_configuration.oidc.shared_secret | default(omit) }}"
+    certificate: "{{ cluster_config_configuration.oidc.certificate | default(omit) }}"
+    config_url: "{{ cluster_config_configuration.oidc.config_url }}"
+    scopes: "{{ cluster_config_configuration.oidc.scopes }}"
+  when: cluster_config_configuration.oidc | default(False)
 
 - name: Set time server
   scale_computing.hypercore.time_server:
-    source: "{{ scale_computing_hypercore_cluster_config.time_server }}"
-  when: scale_computing_hypercore_cluster_config.time_server | default(False)
+    source: "{{ cluster_config_configuration.time_server }}"
+  when: cluster_config_configuration.time_server | default(False)
 
 - name: Set time zone
   scale_computing.hypercore.time_zone:
-    zone: "{{ scale_computing_hypercore_cluster_config.time_zone }}"
-  when: scale_computing_hypercore_cluster_config.time_zone | default(False)
+    zone: "{{ cluster_config_configuration.time_zone }}"
+  when: cluster_config_configuration.time_zone | default(False)
 
 - name: Set SMTP configuration
   scale_computing.hypercore.smtp:
-    server: "{{ scale_computing_hypercore_cluster_config.smtp.server }}"
-    port: "{{ scale_computing_hypercore_cluster_config.smtp.port }}"
-    use_ssl: "{{ scale_computing_hypercore_cluster_config.smtp.use_ssl | default(omit) }}"
-    auth_user: "{{ scale_computing_hypercore_cluster_config.smtp.auth_user | default(omit) }}"
-    auth_password: "{{ scale_computing_hypercore_cluster_config.smtp.auth_password | default(omit) }}"
-    from_address: "{{ scale_computing_hypercore_cluster_config.smtp.from_address | default(omit) }}"
-  when: scale_computing_hypercore_cluster_config.smtp | default(False)
+    server: "{{ cluster_config_configuration.smtp.server }}"
+    port: "{{ cluster_config_configuration.smtp.port }}"
+    use_ssl: "{{ cluster_config_configuration.smtp.use_ssl | default(omit) }}"
+    auth_user: "{{ cluster_config_configuration.smtp.auth_user | default(omit) }}"
+    auth_password: "{{ cluster_config_configuration.smtp.auth_password | default(omit) }}"
+    from_address: "{{ cluster_config_configuration.smtp.from_address | default(omit) }}"
+  when: cluster_config_configuration.smtp | default(False)
 
 - name: Reconfigure email alert recipients
   when:
-    - '"email_alerts" in scale_computing_hypercore_cluster_config'
+    - '"email_alerts" in cluster_config_configuration'
     - |
-      scale_computing_hypercore_cluster_config.email_alerts or
-      scale_computing_hypercore_cluster_config.email_alerts == []
+      cluster_config_configuration.email_alerts or
+      cluster_config_configuration.email_alerts == []
   block:
     - name: Get old email alert recipients
       scale_computing.hypercore.email_alert_info:
@@ -85,22 +85,22 @@
       loop: "{{ cluster_config_email_alert_info_result.records }}"
       loop_control:
         loop_var: email_alert_recipient
-      when: email_alert_recipient.email not in scale_computing_hypercore_cluster_config.email_alerts
+      when: email_alert_recipient.email not in cluster_config_configuration.email_alerts
 
     - name: Set new email alerts
       scale_computing.hypercore.email_alert:
         email: "{{ email_address }}"
         state: present
-      loop: "{{ scale_computing_hypercore_cluster_config.email_alerts or [] }}"
+      loop: "{{ cluster_config_configuration.email_alerts or [] }}"
       loop_control:
         loop_var: email_address
 
 - name: Reconfigure syslog servers
   when:
-    - '"syslog_servers" in scale_computing_hypercore_cluster_config'
+    - '"syslog_servers" in cluster_config_configuration'
     - |
-      scale_computing_hypercore_cluster_config.syslog_servers or
-      scale_computing_hypercore_cluster_config.syslog_servers == []
+      cluster_config_configuration.syslog_servers or
+      cluster_config_configuration.syslog_servers == []
   block:
     - name: Get old syslog servers
       scale_computing.hypercore.syslog_server_info:
@@ -113,14 +113,14 @@
       loop: "{{ cluster_config_syslog_server_info_result.records }}"
       loop_control:
         loop_var: syslog_server
-      when: syslog_server.host not in (scale_computing_hypercore_cluster_config.syslog_servers | map(attribute='host') | list)
+      when: syslog_server.host not in (cluster_config_configuration.syslog_servers | map(attribute='host') | list)
 
     - name: Set new syslog servers
       scale_computing.hypercore.syslog_server:
         host: "{{ syslog_server.host }}"
         port: "{{ syslog_server.port | default(omit) }}"
         protocol: "{{ syslog_server.protocol | default(omit) }}"
         state: present
-      loop: "{{ scale_computing_hypercore_cluster_config.syslog_servers or [] }}"
+      loop: "{{ cluster_config_configuration.syslog_servers or [] }}"
       loop_control:
         loop_var: syslog_server