refactor: handle INJECT_FACTS_AS_VARS=false by using ansible_facts instead (#44)

Ansible 2.20 has deprecated the use of Ansible facts as variables.  For
example, `ansible_distribution` is now deprecated in favor of
`ansible_facts["distribution"]`.  This is due to making the default
setting `INJECT_FACTS_AS_VARS=false`.  For now, this will create WARNING
messages, but in Ansible 2.24 it will be an error.

See https://docs.ansible.com/projects/ansible/latest/porting_guides/porting_guide_core_2.20.html#inject-facts-as-vars

Signed-off-by: Rich Megginson <rmeggins@redhat.com>

Author: richm

README-ostree.md

@@ -20,8 +20,8 @@ Usage:
 .ostree/get_ostree_data.sh packages runtime DISTRO-VERSION FORMAT
 ```
 
-`DISTRO-VERSION` is in the format that Ansible uses for `ansible_distribution`
-and `ansible_distribution_version` - for example, `Fedora-38`, `CentOS-8`,
+`DISTRO-VERSION` is in the format that Ansible uses for `ansible_facts["distribution"]`
+and `ansible_facts["distribution_version"]` - for example, `Fedora-38`, `CentOS-8`,
 `RedHat-9.4`
 
 `FORMAT` is one of `toml`, `json`, `yaml`, `raw`

tasks/main.yml

@@ -7,9 +7,9 @@
   fail:
     msg: >-
       This role supports only on x86_64 architecture.
-      You are running on {{ ansible_architecture }} architecture.
+      You are running on {{ ansible_facts['architecture'] }} architecture.
       Let us know if you need the role to support it.
-  when: ansible_architecture != 'x86_64'
+  when: ansible_facts['architecture'] != 'x86_64'
 
 - name: Fail if role installs openmpi without cuda toolkit
   fail:
@@ -61,20 +61,20 @@
 
     - name: Ensure that the non-EUS RHUI Azure repository is not installed
       package:
-        name: rhui-azure-rhel{{ ansible_distribution_major_version }}
+        name: rhui-azure-rhel{{ ansible_facts['distribution_major_version'] }}
         state: absent
         use: "{{ (__hpc_server_is_ostree | d(false)) |
           ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
 
     - name: Enable the RHUI Azure EUS repository
       when: >-
-        'rhui-microsoft-azure-rhel' + ansible_distribution_major_version
+        'rhui-microsoft-azure-rhel' + ansible_facts['distribution_major_version']
         + '-eus ' not in __hpc_dnf_repolist.stdout
       block:
         - name: Create a temp file for the EUS repository configuration
           tempfile:
             state: file
-            prefix: rhel{{ ansible_distribution_major_version }}-eus
+            prefix: rhel{{ ansible_facts['distribution_major_version'] }}-eus
             suffix: .config
           register: __hpc_euc_config
 
@@ -89,13 +89,13 @@
         - name: Add EUS repository
           command: >-
             dnf --config {{ __hpc_euc_config.path }} install
-            rhui-azure-rhel{{ ansible_distribution_major_version }}-eus
+            rhui-azure-rhel{{ ansible_facts['distribution_major_version'] }}-eus
             --assumeyes
           changed_when: true
 
         - name: Lock the RHEL minor release to the current minor release
           copy:
-            content: "{{ ansible_distribution_version }}"
+            content: "{{ ansible_facts['distribution_version'] }}"
             dest: /etc/dnf/vars/releasever
             mode: "0644"
             owner: root
@@ -225,7 +225,7 @@
 - name: Install NVidia driver
   # Note that currently the role supports only Microsoft Azure
   # When we add more cloud providers, we need to update this condition
-  when: ansible_system_vendor == "Microsoft Corporation"
+  when: ansible_facts["system_vendor"] == "Microsoft Corporation"
   block:
     - name: Get list of dnf modules
       command: dnf module list
@@ -274,7 +274,7 @@
 
 - name: Install CUDA driver and enable nvidia-persistenced.service
   when:
-    - ansible_system_vendor == "Microsoft Corporation"
+    - ansible_facts["system_vendor"] == "Microsoft Corporation"
     - hpc_install_cuda_driver
   block:
     - name: Install CUDA driver
@@ -294,7 +294,7 @@
 - name: Install CUDA Toolkit and lock version of its packages
   when:
     - hpc_install_cuda_toolkit
-    - ansible_system_vendor == "Microsoft Corporation"
+    - ansible_facts["system_vendor"] == "Microsoft Corporation"
   block:
     - name: Install CUDA Toolkit
       package:
@@ -449,7 +449,7 @@
               ./configure --prefix={{ __hpc_pmix_path }}
               --enable-pmix-binaries
               --disable-dependency-tracking
-            - make -j {{ ansible_processor_nproc }}
+            - make -j {{ ansible_facts["processor_nproc"] }}
             - make install
 
     - name: Ensure PMIx modulefile directory exists
@@ -638,7 +638,7 @@
               --enable-prte-prefix-by-default
               --with-platform=contrib/platform/mellanox/optimized
               --with-cuda={{ __hpc_cuda_path }}
-            - make -j {{ ansible_processor_nproc }}
+            - make -j {{ ansible_facts["processor_nproc"] }}
             - make install
 
         - name: Remove extracted tarball

templates/rhel-ver-eus.config

@@ -1,6 +1,6 @@
-[rhui-microsoft-azure-rhel{{ ansible_distribution_major_version }}]
-name=Microsoft Azure RPMs for Red Hat Enterprise Linux {{ ansible_distribution_major_version }} (rhel{{ ansible_distribution_major_version }}-eus)
-baseurl=https://rhui4-1.microsoft.com/pulp/repos/unprotected/microsoft-azure-rhel{{ ansible_distribution_major_version }}-eus
+[rhui-microsoft-azure-rhel{{ ansible_facts['distribution_major_version'] }}]
+name=Microsoft Azure RPMs for Red Hat Enterprise Linux {{ ansible_facts['distribution_major_version'] }} (rhel{{ ansible_facts['distribution_major_version'] }}-eus)
+baseurl=https://rhui4-1.microsoft.com/pulp/repos/unprotected/microsoft-azure-rhel{{ ansible_facts['distribution_major_version'] }}-eus
 enabled=1
 gpgcheck=1
 sslverify=1

tests/tasks/skip_unsupported_archs.yml

@@ -6,5 +6,5 @@
   when: '"architecture" not in ansible_facts.keys() | list'
 
 - name: Skip unsupported architectures
-  when: ansible_architecture != 'x86_64'
+  when: ansible_facts['architecture'] != 'x86_64'
   meta: end_host

tests/tests_azure.yml

@@ -10,7 +10,7 @@
   tasks:
     - name: End if not running on Azure
       meta: end_play
-      when: ansible_system_vendor != "Microsoft Corporation"
+      when: ansible_facts['system_vendor'] != "Microsoft Corporation"
 
     - name: Run the role
       include_role:

tests/tests_include_vars_from_parent.yml

@@ -35,10 +35,10 @@
             # create all variants like CentOS, CentOS_8.1, CentOS-8.1,
             # CentOS-8, CentOS-8.1
             # more formally:
-            # {{ ansible_distribution }}-{{ ansible_distribution_version }}
-            # {{ ansible_distribution }}-{{ ansible_distribution_major_version }}
-            # {{ ansible_distribution }}
-            # {{ ansible_os_family }}
+            # {{ ansible_facts['distribution'] }}-{{ ansible_facts['distribution_version'] }}
+            # {{ ansible_facts['distribution'] }}-{{ ansible_facts['distribution_major_version'] }}
+            # {{ ansible_facts['distribution'] }}
+            # {{ ansible_facts['os_family'] }}
             # and the same for _ as separator.
             varfiles: "{{ [facts['distribution']] | product(separators) |
               map('join') | product(versions) | map('join') | list +

tests/vars/rh_distros_vars.yml

@@ -14,7 +14,7 @@ __hpc_rh_distros:
 __hpc_rh_distros_fedora: "{{ __hpc_rh_distros + ['Fedora'] }}"
 
 # Use this in conditionals to check if distro is Red Hat or clone
-__hpc_is_rh_distro: "{{ ansible_distribution in __hpc_rh_distros }}"
+__hpc_is_rh_distro: "{{ ansible_facts['distribution'] in __hpc_rh_distros }}"
 
 # Use this in conditionals to check if distro is Red Hat or clone, or Fedora
-__hpc_is_rh_distro_fedora: "{{ ansible_distribution in __hpc_rh_distros_fedora }}"
+__hpc_is_rh_distro_fedora: "{{ ansible_facts['distribution'] in __hpc_rh_distros_fedora }}"

vars/main.yml

@@ -6,9 +6,9 @@ __hpc_required_facts:
   - distribution_major_version
   - distribution_version
   - os_family
-  # required for ansible_system_vendor
+  # required for ansible_facts["system_vendor"]
   - devices
-  # required for ansible_processor_nproc
+  # required for ansible_facts["processor_nproc"]
   - processor
 # the subsets of ansible_facts that need to be gathered in case any of the
 # facts in required_facts is missing; see the documentation of
@@ -87,8 +87,8 @@ __hpc_rh_distros:
 __hpc_rh_distros_fedora: "{{ __hpc_rh_distros + ['Fedora'] }}"
 
 # Use this in conditionals to check if distro is Red Hat or clone
-__hpc_is_rh_distro: "{{ ansible_distribution in __hpc_rh_distros }}"
+__hpc_is_rh_distro: "{{ ansible_facts['distribution'] in __hpc_rh_distros }}"
 
 # Use this in conditionals to check if distro is Red Hat or clone, or Fedora
-__hpc_is_rh_distro_fedora: "{{ ansible_distribution in __hpc_rh_distros_fedora }}"
+__hpc_is_rh_distro_fedora: "{{ ansible_facts['distribution'] in __hpc_rh_distros_fedora }}"
 # END - DO NOT EDIT THIS BLOCK - rh distros variables