From fd4e041608260ec9e1b545d00cac8ff1d266c8de Mon Sep 17 00:00:00 2001 From: Dmitriy Rabotyagov Date: Thu, 7 Dec 2023 18:38:44 +0100 Subject: [PATCH] [doc] Add examples of u-c-r, u-c-c and user.rc As of today we do support very powerful set of overrides for roles, collections and environment variables that are not widely used or known by deployers. This patch aims to add some example files to sample openstack_deploy folder to raise awareness about existence of these files. Change-Id: I3940f5277c7d5a26c2686382758507c19b0c815d --- ansible-role-requirements.yml.example | 6 ------ .../user-collection-requirements.yml.example | 9 +++++++++ etc/openstack_deploy/user-role-requirements.yml.example | 7 +++++++ etc/openstack_deploy/user.rc.example | 4 ++++ 4 files changed, 20 insertions(+), 6 deletions(-) delete mode 100644 ansible-role-requirements.yml.example create mode 100644 etc/openstack_deploy/user-collection-requirements.yml.example create mode 100644 etc/openstack_deploy/user-role-requirements.yml.example create mode 100644 etc/openstack_deploy/user.rc.example diff --git a/ansible-role-requirements.yml.example b/ansible-role-requirements.yml.example deleted file mode 100644 index 1619e82965..0000000000 --- a/ansible-role-requirements.yml.example +++ /dev/null @@ -1,6 +0,0 @@ -# Use this file to fill in your third party roles that you'd like to have added to the list of available roles. -# Example: -# - github_api: https://api.github.com/repos/os-cloud/opc_role-galera_client -# name: galera_client -# src: https://github.com/os-cloud/opc_role-galera_client -# version: master diff --git a/etc/openstack_deploy/user-collection-requirements.yml.example b/etc/openstack_deploy/user-collection-requirements.yml.example new file mode 100644 index 0000000000..b378f936d8 --- /dev/null +++ b/etc/openstack_deploy/user-collection-requirements.yml.example @@ -0,0 +1,9 @@ +# Use this file to fill in your third party collections or roles that you'd like to have added during bootstrap-ansible.sh. +# Collections with the same name will have prescedence and override ones provided in ansible-collection-requirements.yml +# Content of this file will be fed to ansible-galaxy binary, so it should be compatible with requirements.yml format. +# Example: +# collections: +# - name: openstack.cloud +# source: https://github.com/os-cloud/ansible-collections-openstack +# type: git +# version: main diff --git a/etc/openstack_deploy/user-role-requirements.yml.example b/etc/openstack_deploy/user-role-requirements.yml.example new file mode 100644 index 0000000000..0edfd5aa67 --- /dev/null +++ b/etc/openstack_deploy/user-role-requirements.yml.example @@ -0,0 +1,7 @@ +# Use this file to fill in your third party roles that you'd like to have added during bootstrap-ansible.sh. +# Roles with the same name will have prescedence and override ones provided in ansible-role-requirements.yml +# Example: +# - name: galera_client +# src: https://github.com/os-cloud/opc_role-galera_client +# scm: git +# version: master diff --git a/etc/openstack_deploy/user.rc.example b/etc/openstack_deploy/user.rc.example new file mode 100644 index 0000000000..4992fc7704 --- /dev/null +++ b/etc/openstack_deploy/user.rc.example @@ -0,0 +1,4 @@ +# Use this file to define any needed environment variables that will be sourced +# by openstack-ansible binary after loading main RC fail. +# Example: +# export ANSIBLE_INVENTORY="${ANSIBLE_INVENTORY},/opt/extra/inventory.py"