openstack/openstack-ansible
Code Issues Proposed changes

[doc] Add information about hook playbooks to the 'extending-osa' docs

Browse Source 
Change-Id: I131920a1622d8ba36362f6ccc95dc705baca8a16
This commit is contained in:
Jonathan Rosser 2024-05-14 09:00:14 +01:00 committed by Dmitriy Rabotyagov
parent 2cb87aaf2d
commit 9ce7a2e76c
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/source/reference/configuration/extending-osa.rst
View File

@ -124,6 +124,36 @@ setting ``USER_COLLECTION_FILE`` environment variable before running the
``bootstrap-ansible.sh`` script. Though it is expected to be relative to
``OSA_CONFIG_DIR`` (/etc/openstack_deploy) folder.
Calling extra playbooks during the deployment
---------------------------------------------
If you install some additional deployment functionality as either a
collection or a git repository on the deploy host, it is possible
to automatically include extra playbooks at certain points during
the deployment.
The points where a hook exists to call an external playbook are as
follows:
* ``pre_setup_hosts_hook``
* ``post_setup_hosts_hook``
* ``pre_setup_infrastructure_hook``
* ``post_setup_infrastructure_hook``
* ``pre_setup_openstack_hook``
* ``post_setup_openstack_hook``
The hook variables should be configured in a suitable user_variables
file. An example calling a playbook from a collection (installed
using user-collection-requirements.yml) :
.. code-block:: bash
pre_setup_hosts_hook: custom.collection.playbook
Installing extra playbooks using collections, and referencing the
playbook with its FQCN is the most robust approach to including
additional user defined playbooks.
Installing extra Python packages inside Ansible virtualenv
----------------------------------------------------------