From 5baf5dc70755c2245bfe49b7f7decd171c1f3d08 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pl=C3=ADchal?= Date: Mon, 9 Sep 2024 18:24:11 +0200 Subject: [PATCH] Mention ansible collections installed in Testing Farm Let users know which collections are available on the test runner. --- spec/plans/prepare.fmf | 12 +++++++++++- tmt/steps/prepare/ansible.py | 1 + 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/spec/plans/prepare.fmf b/spec/plans/prepare.fmf index e4d5e386e4..d8fbaf774b 100644 --- a/spec/plans/prepare.fmf +++ b/spec/plans/prepare.fmf @@ -63,7 +63,7 @@ example: | /ansible: summary: Apply ansible playbook to get the desired final state. - description: + description: | One or more playbooks can be provided as a list under the ``playbook`` attribute. Each of them will be applied using ``ansible-playbook`` in the given order. The path @@ -75,6 +75,16 @@ example: | Remote playbooks can be referenced as well as the local ones, and both kinds can be used at the same time. + .. note:: + + When executing tests in the Testing Farm, `selected + ansible collections`__ are available on the test + runner and can be used in user playbooks. + + __ https://gitlab.com/testing-farm/gluetool-modules/-/blob/main/container/requirements.yml + + TODO: Point to TF docs instead when ready. + example: | prepare: how: ansible diff --git a/tmt/steps/prepare/ansible.py b/tmt/steps/prepare/ansible.py index 3faef38530..451729dfad 100644 --- a/tmt/steps/prepare/ansible.py +++ b/tmt/steps/prepare/ansible.py @@ -115,6 +115,7 @@ class PrepareAnsible(tmt.steps.prepare.PreparePlugin[PrepareAnsibleData]): .. code-block:: shell prepare --how ansible --playbook https://foo.bar/two.yml --playbook two.yml + """ _data_class = PrepareAnsibleData