diff --git a/ansible/group_vars/all/globals b/ansible/group_vars/all/globals
index f6cad0af0f003fd6194a3d4d1064577ff398f46e..3a7f362ce81e92b9563479e3d6bd5f3f54a39802 100644
--- a/ansible/group_vars/all/globals
+++ b/ansible/group_vars/all/globals
@@ -51,3 +51,14 @@ os_distribution: "centos"
# OS release. Valid options are "8-stream" when os_distribution is "centos", or
# "focal" when os_distribution is "ubuntu".
os_release: "{{ '8-stream' if os_distribution == 'centos' else 'focal' }}"
+
+###############################################################################
+# Ansible configuration.
+
+# Filter to apply to the setup module when gathering facts. Default is to not
+# specify a filter.
+kayobe_ansible_setup_filter: "{{ omit }}"
+
+# Gather subset to apply to the setup module when gathering facts. Default is
+# to not specify a gather subset.
+kayobe_ansible_setup_gather_subset: "{{ omit }}"
diff --git a/ansible/kayobe-target-venv.yml b/ansible/kayobe-target-venv.yml
index b18acf9c6ca6994e842d1ea81ab9e42986a1b4db..02bd526f70c49ca88934bb879d38733309e10b19 100644
--- a/ansible/kayobe-target-venv.yml
+++ b/ansible/kayobe-target-venv.yml
@@ -19,7 +19,9 @@
- block:
- name: Gather facts
setup:
- when: not ansible_facts.module_setup | default(false)
+ filter: "{{ kayobe_ansible_setup_filter }}"
+ gather_subset: "{{ kayobe_ansible_setup_gather_subset }}"
+ when: not ansible_facts
register: gather_facts
- name: Ensure the Python virtualenv package is installed
@@ -79,6 +81,8 @@
# again using the interpreter from the virtual environment.
- name: Gather facts
setup:
+ filter: "{{ kayobe_ansible_setup_filter }}"
+ gather_subset: "{{ kayobe_ansible_setup_gather_subset }}"
when:
- virtualenv is defined
- gather_facts is not skipped
diff --git a/ansible/kolla-target-venv.yml b/ansible/kolla-target-venv.yml
index 9a556b9a0ed56f1a80403d582539a06e5f7efcd1..7fd9e3dc6a038d954f9f83acdca1eefcc4515d6b 100644
--- a/ansible/kolla-target-venv.yml
+++ b/ansible/kolla-target-venv.yml
@@ -21,7 +21,9 @@
- block:
- name: Gather facts
setup:
- when: not ansible_facts.module_setup | default(false)
+ filter: "{{ kayobe_ansible_setup_filter }}"
+ gather_subset: "{{ kayobe_ansible_setup_gather_subset }}"
+ when: not ansible_facts
- name: Ensure the Python virtualenv package is installed
package:
diff --git a/ansible/overcloud-facts-gather.yml b/ansible/overcloud-facts-gather.yml
new file mode 100644
index 0000000000000000000000000000000000000000..a8f101afe29068fbbaf4385c914da22a4f9bbef5
--- /dev/null
+++ b/ansible/overcloud-facts-gather.yml
@@ -0,0 +1,10 @@
+---
+- name: Gather facts
+ hosts: overcloud
+ gather_facts: false
+ tasks:
+ - name: Gather facts
+ setup:
+ filter: "{{ kayobe_ansible_setup_filter }}"
+ gather_subset: "{{ kayobe_ansible_setup_gather_subset }}"
+ when: not ansible_facts
diff --git a/ansible/roles/network-redhat/tasks/main.yml b/ansible/roles/network-redhat/tasks/main.yml
index 5f1f59d0c251c42b103876d3c9427ec01706e75e..27aa92d70b4134d3958266415de755e4bb4bfa99 100644
--- a/ansible/roles/network-redhat/tasks/main.yml
+++ b/ansible/roles/network-redhat/tasks/main.yml
@@ -36,6 +36,8 @@
net_select_bonds |
map('net_bond_obj') |
list }}
+ interfaces_setup_filter: "{{ kayobe_ansible_setup_filter }}"
+ interfaces_setup_gather_subset: "{{ kayobe_ansible_setup_gather_subset }}"
# Configure virtual ethernet patch links to connect the workload provision
# and external network bridges to the Neutron OVS bridge.
diff --git a/doc/source/administration/overcloud.rst b/doc/source/administration/overcloud.rst
index 6a2aa60c67e42745d767bb512a3040c99f0fa47d..914e727048ba068b6e6f3b734fc6c3422a26599a 100644
--- a/doc/source/administration/overcloud.rst
+++ b/doc/source/administration/overcloud.rst
@@ -249,3 +249,15 @@ Or to perform an incremental backup, run the following command:
Further information on backing up and restoring the database is available in
the :kolla-ansible-doc:`Kolla Ansible documentation
<admin/mariadb-backup-and-restore.html>`.
+
+Gathering Facts
+===============
+
+The following command may be used to gather facts for all overcloud hosts, for
+both Kayobe and Kolla Ansible:
+
+.. code-block:: console
+
+ kayobe overcloud facts gather
+
+This may be useful to populate a fact cache in advance of other operations.
diff --git a/doc/source/configuration/reference/ansible.rst b/doc/source/configuration/reference/ansible.rst
index 55f2688f189e57bf19fb4db5e434e08174b6e0e1..49372428d8468c8a0fea319e3f9e237404897c5e 100644
--- a/doc/source/configuration/reference/ansible.rst
+++ b/doc/source/configuration/reference/ansible.rst
@@ -84,3 +84,65 @@ caching using the `jsonfile cache plugin
You may also wish to set the expiration timeout for the cache via ``[defaults]
fact_caching_timeout``.
+
+Fact gathering
+==============
+
+Fact filtering
+--------------
+
+Filtering of facts can be used to speed up Ansible. Environments with
+many network interfaces on the network and compute nodes can experience very
+slow processing with Kayobe and Kolla Ansible. This happens due to the
+processing of the large per-interface facts with each task. To avoid storing
+certain facts, we can use the ``kayobe_ansible_setup_filter`` variable, which
+is used as the ``filter`` argument to the ``setup`` module.
+
+One case where this is particularly useful is to avoid collecting facts for
+virtual tap (beginning with t) and bridge (beginning with q) interfaces
+created by Neutron. These facts are large map values which can consume a lot
+of resources on the Ansible control host. Kayobe and Kolla Ansible typically
+do not need to reference them, so they may be filtered. For example, to
+avoid collecting facts beginning with q or t:
+
+.. code-block:: yaml
+ :caption: ``$KAYOBE_CONFIG_PATH/globals.yml``
+
+ kayobe_ansible_setup_filter: "ansible_[!qt]*"
+
+Similarly, for Kolla Ansible (notice the similar but different file names):
+
+.. code-block:: yaml
+ :caption: ``$KAYOBE_CONFIG_PATH/kolla/globals.yml``
+
+ kolla_ansible_setup_filter: "ansible_[!qt]*"
+
+This causes Ansible to collect but not store facts matching that pattern, which
+includes the virtual interface facts. Currently we are not referencing other
+facts matching the pattern within Kolla Ansible. Note that including the
+'ansible_' prefix causes meta facts ``module_setup`` and ``gather_subset`` to
+be filtered, but this seems to be the only way to get a good match on the
+interface facts.
+
+The exact improvement will vary, but has been reported to be as large as 18x on
+systems with many virtual interfaces.
+
+Fact gathering subsets
+----------------------
+
+It is also possible to configure which subsets of facts are gathered, via
+``kayobe_ansible_setup_gather_subset``, which is used as the ``gather_subset``
+argument to the ``setup`` module. For example, if one wants to avoid collecting
+facts via facter:
+
+.. code-block:: yaml
+ :caption: ``$KAYOBE_CONFIG_PATH/globals.yml``
+
+ kayobe_ansible_setup_gather_subset: "all,!facter"
+
+Similarly, for Kolla Ansible (notice the similar but different file names):
+
+.. code-block:: yaml
+ :caption: ``$KAYOBE_CONFIG_PATH/kolla/globals.yml``
+
+ kolla_ansible_setup_gather_subset: "all,!facter"
diff --git a/etc/kayobe/globals.yml b/etc/kayobe/globals.yml
index 9efc114f60fe717b859017bb3a66d05acfef9179..a4150d8eca271073663745171e7323f6760e50c0 100644
--- a/etc/kayobe/globals.yml
+++ b/etc/kayobe/globals.yml
@@ -53,6 +53,17 @@
# "focal" when os_distribution is "ubuntu".
#os_release:
+###############################################################################
+# Ansible configuration.
+
+# Filter to apply to the setup module when gathering facts. Default is to not
+# specify a filter.
+#kayobe_ansible_setup_filter:
+
+# Gather subset to apply to the setup module when gathering facts. Default is
+# to not specify a gather subset.
+#kayobe_ansible_setup_gather_subset:
+
###############################################################################
# Dummy variable to allow Ansible to accept this file.
workaround_ansible_issue_8743: yes
diff --git a/kayobe/cli/commands.py b/kayobe/cli/commands.py
index 38afdc6fe79d25494b4fb9bc18a5465944fc18d0..be5af1660a0cda5ead1cb8259d64d86cdeaa1e6d 100644
--- a/kayobe/cli/commands.py
+++ b/kayobe/cli/commands.py
@@ -932,6 +932,22 @@ class OvercloudDeprovision(KayobeAnsibleMixin, VaultMixin, Command):
self.run_kayobe_playbooks(parsed_args, playbooks)
+class OvercloudFactsGather(KollaAnsibleMixin, KayobeAnsibleMixin, VaultMixin,
+ Command):
+ """Gather facts for Kayobe and Kolla Ansible."""
+
+ def take_action(self, parsed_args):
+ self.app.LOG.debug("Gathering overcloud host facts")
+
+ # Gather facts for Kayobe.
+ playbooks = _build_playbook_list("overcloud-facts-gather")
+ self.run_kayobe_playbooks(parsed_args, playbooks)
+
+ # Gather facts for Kolla Ansible.
+ self.generate_kolla_ansible_config(parsed_args, service_config=False)
+ self.run_kolla_ansible_overcloud(parsed_args, "gather-facts")
+
+
class OvercloudHostConfigure(KollaAnsibleMixin, KayobeAnsibleMixin, VaultMixin,
Command):
"""Configure the overcloud host OS and services.
diff --git a/kayobe/tests/unit/cli/test_commands.py b/kayobe/tests/unit/cli/test_commands.py
index 4e2a0f55b386abd2b8ee1bab9184e919f429a8e4..b92059744f5b43a4fd7fd0fe198fe70789c7056f 100644
--- a/kayobe/tests/unit/cli/test_commands.py
+++ b/kayobe/tests/unit/cli/test_commands.py
@@ -1008,6 +1008,43 @@ class TestCase(unittest.TestCase):
]
self.assertEqual(expected_calls, mock_run.call_args_list)
+ @mock.patch.object(commands.KayobeAnsibleMixin,
+ "run_kayobe_playbooks")
+ @mock.patch.object(commands.KollaAnsibleMixin,
+ "run_kolla_ansible_overcloud")
+ def test_overcloud_facts_gather(self, mock_kolla_run, mock_run):
+ command = commands.OvercloudFactsGather(TestApp(), [])
+ parser = command.get_parser("test")
+ parsed_args = parser.parse_args([])
+
+ result = command.run(parsed_args)
+ self.assertEqual(0, result)
+
+ expected_calls = [
+ mock.call(
+ mock.ANY,
+ [
+ utils.get_data_files_path(
+ "ansible", "overcloud-facts-gather.yml"),
+ ],
+ ),
+ mock.call(
+ mock.ANY,
+ [utils.get_data_files_path("ansible", "kolla-ansible.yml")],
+ tags="config",
+ ignore_limit=True,
+ ),
+ ]
+ self.assertEqual(expected_calls, mock_run.call_args_list)
+
+ expected_calls = [
+ mock.call(
+ mock.ANY,
+ "gather-facts"
+ ),
+ ]
+ self.assertEqual(expected_calls, mock_kolla_run.call_args_list)
+
@mock.patch.object(commands.KayobeAnsibleMixin,
"run_kayobe_playbooks")
@mock.patch.object(commands.KollaAnsibleMixin,
diff --git a/releasenotes/notes/setup-module-args-2c36e56bf78ab5f0.yaml b/releasenotes/notes/setup-module-args-2c36e56bf78ab5f0.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..21aeb65ba0a880e3baf2c3e4115057240a102192
--- /dev/null
+++ b/releasenotes/notes/setup-module-args-2c36e56bf78ab5f0.yaml
@@ -0,0 +1,11 @@
+---
+features:
+ - |
+ Adds support for configuring the ``filter`` and ``gather_subset`` arguments
+ for the ``setup`` module via ``kayobe_ansible_setup_filter`` and
+ ``kayobe_ansible_setup_gather_subset`` respectively. These can be used to
+ reduce the number of facts, which can have a significant effect on
+ performance of Ansible.
+ - |
+ Adds a new command, ``kayobe overcloud facts gather``, to gather Ansible
+ facts for overcloud hosts. This may be useful for populating a fact cache.
diff --git a/setup.cfg b/setup.cfg
index 282c192e74894aeb1f12040f303d4e29e79f9f5d..708ea819195bec01fb01d1afa7f3062456ac4502 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -58,6 +58,7 @@ kayobe.cli=
overcloud_database_recover = kayobe.cli.commands:OvercloudDatabaseRecover
overcloud_deployment_image_build = kayobe.cli.commands:OvercloudDeploymentImageBuild
overcloud_deprovision = kayobe.cli.commands:OvercloudDeprovision
+ overcloud_facts_gather = kayobe.cli.commands:OvercloudFactsGather
overcloud_hardware_inspect = kayobe.cli.commands:OvercloudHardwareInspect
overcloud_host_configure = kayobe.cli.commands:OvercloudHostConfigure
overcloud_host_package_update = kayobe.cli.commands:OvercloudHostPackageUpdate
@@ -132,6 +133,8 @@ kayobe.cli.overcloud_deployment_image_build =
hooks = kayobe.cli.commands:HookDispatcher
kayobe.cli.overcloud_deprovision =
hooks = kayobe.cli.commands:HookDispatcher
+kayobe.cli.overcloud_facts_gather =
+ hooks = kayobe.cli.commands:HookDispatcher
kayobe.cli.overcloud_hardware_inspect =
hooks = kayobe.cli.commands:HookDispatcher
kayobe.cli.overcloud_host_configure =