openstack/openstack-ansible
Code Issues Proposed changes

[doc] Document usage of the user-collection-requirements

Browse Source 
Change-Id: I75886544804b4a2d5b72a5b6adcfdf5b876f8ce2
This commit is contained in:
Dmitriy Rabotyagov 2021-02-18 10:40:44 +02:00 committed by Jonathan Rosser
parent d2521a7c40
commit 5872ee43ec
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -81,6 +81,18 @@ the environment variable ``ANSIBLE_ROLE_FILE`` before running the
It is now the responsibility of the deployer to maintain appropriate
versions pins of the ansible roles if an upgrade is required.
Adding new collections in your OpenStack-Ansible installation
-------------------------------------------------------------
The Victoria release of openstack-ansible adds an optional new config
file which defaults to
``/etc/openstack_deploy/user-collection-requirements.yml``. It should be
in the native format of the ansible-galaxy requirements file and can be
used to add new collections to the deploy host.
You can override location of the ``user-collection-requirements.yml`` by
setting ``USER_COLLECTION_FILE`` environment variable before running the
``bootstrap-ansible.sh`` script.
Maintaining local forks of ansible roles
----------------------------------------
@ -102,4 +114,4 @@ entirely. It is also straightforward to include the
.. _ansible-role-requirements: https://opendev.org/openstack/openstack-ansible/src/ansible-role-requirements.yml
.. _ansible-galaxy: https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#install-multiple-collections-with-a-requirements-file