Use ansible_facts to reference facts

By default, Ansible injects a variable for every fact, prefixed with
ansible_. This can result in a large number of variables for each host,
which at scale can incur a performance penalty. Ansible provides a
configuration option [0] that can be set to False to prevent this
injection of facts. In this case, facts should be referenced via
ansible_facts.<fact>.

This change updates all references to Ansible facts within Kolla Ansible
from using individual fact variables to using the items in the
ansible_facts dictionary. This allows users to disable fact variable
injection in their Ansible configuration, which may provide some
performance improvement.

This change disables fact variable injection in the ansible
configuration used in CI, to catch any attempts to use the injected
variables.

[0] https://docs.ansible.com/ansible/latest/reference_appendices/config.html#inject-facts-as-vars

Change-Id: I7e9d5c9b8b9164d4aee3abb4e37c8f28d98ff5d1
Partially-Implements: blueprint performance-improvements
(cherry picked from commit ade5bfa)

Author: markgoddard

ansible/gather-facts.yml

@@ -37,5 +37,5 @@
       with_items: "{{ delegate_hosts }}"
       # We gathered facts for all hosts in the batch during the first play.
       when:
-        - not hostvars[item].module_setup | default(false)
+        - not hostvars[item].ansible_facts.module_setup | default(false)
   tags: always

ansible/group_vars/all.yml

@@ -537,8 +537,8 @@ supported_policy_format_list:
 multiple_regions_names:
   - "{{ openstack_region_name }}"
 
-openstack_service_workers: "{{ [ansible_processor_vcpus, 5]|min }}"
-openstack_service_rpc_workers: "{{ [ansible_processor_vcpus, 3]|min }}"
+openstack_service_workers: "{{ [ansible_facts.processor_vcpus, 5]|min }}"
+openstack_service_rpc_workers: "{{ [ansible_facts.processor_vcpus, 3]|min }}"
 
 # Optionally allow Kolla to set sysctl values
 set_sysctl: "yes"
@@ -920,7 +920,7 @@ gnocchi_metric_datadir_volume: "gnocchi"
 cinder_backend_ceph: "no"
 cinder_backend_vmwarevc_vmdk: "no"
 cinder_volume_group: "cinder-volumes"
-cinder_target_helper: "{{ 'lioadm' if ansible_os_family == 'RedHat' else 'tgtadm' }}"
+cinder_target_helper: "{{ 'lioadm' if ansible_facts.os_family == 'RedHat' else 'tgtadm' }}"
 # Valid options are [ '', redis, etcd ]
 cinder_coordination_backend: "{{ 'redis' if enable_redis|bool else 'etcd' if enable_etcd|bool else '' }}"
 

ansible/post-deploy.yml

@@ -7,8 +7,8 @@
       template:
         src: "roles/common/templates/admin-openrc.sh.j2"
         dest: "{{ node_config }}/admin-openrc.sh"
-        owner: "{{ ansible_user_uid }}"
-        group: "{{ ansible_user_gid }}"
+        owner: "{{ ansible_facts.user_uid }}"
+        group: "{{ ansible_facts.user_gid }}"
         mode: 0600
 
     - import_role:

ansible/roles/aodh/defaults/main.yml

@@ -158,26 +158,26 @@ aodh_notifier_healthcheck:
 aodh_api_default_volumes:
   - "{{ node_config_directory }}/aodh-api/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "aodh:/var/lib/aodh/"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/aodh/aodh:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/aodh' if aodh_dev_mode | bool else '' }}"
 aodh_evaluator_default_volumes:
   - "{{ node_config_directory }}/aodh-evaluator/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/aodh/aodh:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/aodh' if aodh_dev_mode | bool else '' }}"
 aodh_listener_default_volumes:
   - "{{ node_config_directory }}/aodh-listener/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/aodh/aodh:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/aodh' if aodh_dev_mode | bool else '' }}"
 aodh_notifier_default_volumes:
   - "{{ node_config_directory }}/aodh-notifier/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/aodh/aodh:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/aodh' if aodh_dev_mode | bool else '' }}"
 

ansible/roles/barbican/defaults/main.yml

@@ -115,20 +115,20 @@ barbican_worker_healthcheck:
 barbican_api_default_volumes:
   - "{{ node_config_directory }}/barbican-api/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "barbican:/var/lib/barbican/"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/barbican/barbican:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/barbican' if barbican_dev_mode | bool else '' }}"
 barbican_keystone_listener_default_volumes:
   - "{{ node_config_directory }}/barbican-keystone-listener/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/barbican/barbican:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/barbican' if barbican_dev_mode | bool else '' }}"
 barbican_worker_default_volumes:
   - "{{ node_config_directory }}/barbican-worker/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/barbican/barbican:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/barbican' if barbican_dev_mode | bool else '' }}"
 

ansible/roles/baremetal/defaults/main.yml

@@ -3,14 +3,14 @@
 enable_docker_repo: true
 
 # Docker APT repository configuration.
-docker_apt_url: "https://download.docker.com/linux/{{ ansible_distribution | lower }}"
-docker_apt_repo: "deb {{ docker_apt_url }} {{ ansible_distribution_release }} stable"
+docker_apt_url: "https://download.docker.com/linux/{{ ansible_facts.distribution | lower }}"
+docker_apt_repo: "deb {{ docker_apt_url }} {{ ansible_facts.distribution_release }} stable"
 docker_apt_key_file: "gpg"
 docker_apt_key_id: "0EBFCD88"
 docker_apt_package: "docker-ce"
 
 # Docker Yum repository configuration.
-docker_yum_url: "https://download.docker.com/linux/{{ ansible_distribution | lower }}"
+docker_yum_url: "https://download.docker.com/linux/{{ ansible_facts.distribution | lower }}"
 docker_yum_baseurl: "{{ docker_yum_url }}/$releasever/$basearch/stable"
 docker_yum_gpgkey: "{{ docker_yum_url }}/gpg"
 docker_yum_gpgcheck: true
@@ -41,7 +41,7 @@ docker_https_proxy: ""
 docker_no_proxy: ""
 
 # Version of python used to execute Ansible modules.
-host_python_version: "{{ ansible_python.version.major }}.{{ ansible_python.version.minor }}"
+host_python_version: "{{ ansible_facts.python.version.major }}.{{ ansible_facts.python.version.minor }}"
 
 debian_pkg_install:
  - "{{ docker_apt_package }}"

ansible/roles/baremetal/tasks/install.yml

@@ -3,15 +3,15 @@
   apt:
     update_cache: yes
   become: True
-  when: ansible_os_family == 'Debian'
+  when: ansible_facts.os_family == 'Debian'
 
 # TODO(inc0): Gates don't seem to have ufw executable, check for it instead of ignore errors
 - name: Set firewall default policy
   become: True
   ufw:
     state: disabled
     policy: allow
-  when: ansible_os_family == 'Debian'
+  when: ansible_facts.os_family == 'Debian'
   ignore_errors: yes
 
 - name: Check if firewalld is installed
@@ -21,7 +21,7 @@
   failed_when: firewalld_check.rc > 1
   args:
     warn: false
-  when: ansible_os_family == 'RedHat'
+  when: ansible_facts.os_family == 'RedHat'
 
 - name: Disable firewalld
   become: True
@@ -32,7 +32,7 @@
   with_items:
     - firewalld
   when:
-    - ansible_os_family == 'RedHat'
+    - ansible_facts.os_family == 'RedHat'
     - firewalld_check.rc == 0
 
 # Upgrading docker engine may cause containers to stop. Take a snapshot of the
@@ -63,15 +63,15 @@
     state: link
   become: true
   when:
-    - ansible_os_family == 'Debian'
+    - ansible_facts.os_family == 'Debian'
     - not docker_unit_file.stat.exists
 
 - name: Install apt packages
   package:
     name: "{{ (debian_pkg_install | join(' ')).split() }}"
     state: present
   become: True
-  when: ansible_os_family == 'Debian'
+  when: ansible_facts.os_family == 'Debian'
   register: apt_install_result
 
 - name: Install deltarpm packages
@@ -80,15 +80,15 @@
     state: present
     update_cache: yes
   become: True
-  when: ansible_os_family == 'RedHat'
+  when: ansible_facts.os_family == 'RedHat'
 
 - name: Install RPM packages
   package:
     name: "{{ (redhat_pkg_install | join(' ')).split() }}"
     state: present
     update_cache: yes
   become: True
-  when: ansible_os_family == 'RedHat'
+  when: ansible_facts.os_family == 'RedHat'
   register: rpm_install_result
 
 # If any packages were updated, and any containers were running, wait for the
@@ -122,7 +122,7 @@
     - running_containers.rc == 0
     - running_containers.stdout != ''
   vars:
-    install_result: "{{ rpm_install_result if ansible_os_family == 'RedHat' else apt_install_result }}"
+    install_result: "{{ rpm_install_result if ansible_facts.os_family == 'RedHat' else apt_install_result }}"
 
 - name: Install latest pip in the virtualenv
   pip:
@@ -150,11 +150,11 @@
     name: "{{ (ubuntu_pkg_removals | join(' ')).split() }}"
     state: absent
   become: True
-  when: ansible_os_family == 'Debian'
+  when: ansible_facts.os_family == 'Debian'
 
 - name: Remove packages
   package:
     name: "{{ (redhat_pkg_removals | join(' ')).split() }}"
     state: absent
   become: True
-  when: ansible_os_family == 'RedHat'
+  when: ansible_facts.os_family == 'RedHat'

ansible/roles/baremetal/tasks/post-install.yml

@@ -192,19 +192,19 @@
   stat:
     path: /etc/apparmor.d/usr.sbin.libvirtd
   register: apparmor_libvirtd_profile
-  when: ansible_distribution == "Ubuntu"
+  when: ansible_facts.distribution == "Ubuntu"
 
 - name: Get stat of libvirtd apparmor disable profile
   stat:
     path: /etc/apparmor.d/disable/usr.sbin.libvirtd
   register: apparmor_libvirtd_disable_profile
-  when: ansible_distribution == "Ubuntu"
+  when: ansible_facts.distribution == "Ubuntu"
 
 - name: Remove apparmor profile for libvirt
   command: apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd
   become: True
   when:
-    - ansible_distribution == "Ubuntu"
+    - ansible_facts.distribution == "Ubuntu"
     - apparmor_libvirtd_profile.stat.exists
     - not apparmor_libvirtd_disable_profile.stat.exists
 
@@ -213,14 +213,14 @@
     path: /etc/apparmor.d/usr.sbin.chronyd
   register: apparmor_chronyd_profile
   when:
-    - ansible_os_family == "Debian"
+    - ansible_facts.os_family == "Debian"
     - enable_chrony | bool
 
 - name: Remove apparmor profile for chrony
   command: apparmor_parser -R /etc/apparmor.d/usr.sbin.chronyd
   become: True
   when:
-    - ansible_os_family == "Debian"
+    - ansible_facts.os_family == "Debian"
     - enable_chrony | bool
     - apparmor_chronyd_profile.stat.exists
 
@@ -272,7 +272,7 @@
     state: stopped
   become: True
   when:
-    - ansible_os_family == "Debian"
+    - ansible_facts.os_family == "Debian"
     - enable_host_ntp | bool
 
 - name: Stop time service
@@ -281,7 +281,7 @@
     state: stopped
   become: True
   when:
-    - ansible_os_family == "RedHat"
+    - ansible_facts.os_family == "RedHat"
     - enable_host_ntp | bool
 
 - name: Synchronizing time one-time
@@ -296,7 +296,7 @@
     enabled: yes
   become: True
   when:
-    - ansible_os_family == "Debian"
+    - ansible_facts.os_family == "Debian"
     - enable_host_ntp | bool
 
 - name: Start time sync service
@@ -306,7 +306,7 @@
     enabled: yes
   become: True
   when:
-    - ansible_os_family == "RedHat"
+    - ansible_facts.os_family == "RedHat"
     - enable_host_ntp | bool
 
 - name: Change state of selinux
@@ -316,4 +316,4 @@
   become: true
   when:
     - change_selinux | bool
-    - ansible_os_family == "RedHat"
+    - ansible_facts.os_family == "RedHat"

ansible/roles/baremetal/tasks/pre-install.yml

@@ -17,7 +17,7 @@
 - name: Ensure hostname does not point to 127.0.1.1 in /etc/hosts
   lineinfile:
     dest: /etc/hosts
-    regexp: "^127.0.1.1\\b.*\\s{{ ansible_hostname }}\\b"
+    regexp: "^127.0.1.1\\b.*\\s{{ ansible_facts.hostname }}\\b"
     state: absent
   become: True
   when: customize_etc_hosts | bool
@@ -28,9 +28,9 @@
     marker: "# {mark} ANSIBLE GENERATED HOSTS"
     block: |
         {% for host in groups['baremetal'] %}
-        {% set api_interface = hostvars[host]['api_interface'] | replace('-', '_') %}
-        {% if host not in groups['bifrost'] or 'ansible_' + api_interface in hostvars[host] %}
-        {% set hostnames = [hostvars[host]['ansible_nodename'], hostvars[host]['ansible_hostname']] %}
+        {% set api_interface = hostvars[host]['api_interface'] %}
+        {% if host not in groups['bifrost'] or api_interface in hostvars[host].ansible_facts %}
+        {% set hostnames = [hostvars[host].ansible_facts.nodename, hostvars[host].ansible_facts.hostname] %}
         {{ 'api' | kolla_address(host) }} {{ hostnames | unique | join(' ') }}
         {% endif %}
         {% endfor %}
@@ -39,7 +39,7 @@
     - customize_etc_hosts | bool
     # Skip hosts in the bifrost group that do not have a valid api_interface.
     - inventory_hostname not in groups['bifrost'] or
-      'ansible_' + hostvars[inventory_hostname]['api_interface'] | replace('-', '_') in hostvars[inventory_hostname]
+      hostvars[inventory_hostname]['api_interface'] | replace('-', '_') in hostvars[inventory_hostname].ansible_facts
 
 # NOTE(osmanlicilegi): The distribution might come with cloud-init installed, and manage_etc_hosts
 # configuration enabled. If so, it will override the file /etc/hosts from cloud-init templates at
@@ -110,7 +110,7 @@
             repo: "{{ docker_apt_repo }}"
             filename: docker
           become: True
-      when: ansible_os_family == 'Debian'
+      when: ansible_facts.os_family == 'Debian'
 
     - block:
         - name: Ensure yum repos directory exists
@@ -147,5 +147,5 @@
             key: "{{ docker_yum_url }}/gpg"
           become: True
           when: docker_yum_gpgcheck | bool
-      when: ansible_os_family == 'RedHat'
+      when: ansible_facts.os_family == 'RedHat'
   when: enable_docker_repo | bool

ansible/roles/blazar/defaults/main.yml

@@ -92,13 +92,13 @@ blazar_manager_healthcheck:
 blazar_api_default_volumes:
   - "{{ node_config_directory }}/blazar-api/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/blazar/blazar:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/blazar' if blazar_dev_mode | bool else '' }}"
 blazar_manager_default_volumes:
   - "{{ node_config_directory }}/blazar-manager/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
-  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_os_family == 'Debian' else '' }}"
+  - "{{ '/etc/timezone:/etc/timezone:ro' if ansible_facts.os_family == 'Debian' else '' }}"
   - "kolla_logs:/var/log/kolla/"
   - "{{ kolla_dev_repos_directory ~ '/blazar/blazar:/var/lib/kolla/venv/lib/python' ~ distro_python_version ~ '/site-packages/blazar' if blazar_dev_mode | bool else '' }}"