openstack/openstack-ansible
Code Issues Proposed changes

DOC: Clarify user cfg usage and removed reference to nonexistent files

Browse Source 
Change-Id: Iedbd1416727d896e6d0dc83627d78d05029bb1dd
This commit is contained in:
Travis Truman 2016-02-10 11:50:55 -05:00
parent d72dcb89d0
commit 519d563489
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/developer-docs/extending.rst
View File

@ -101,11 +101,12 @@ sourced in any ``openstack-ansible`` command. Alternatively, the files can be
sourced with the ``-e`` parameter of the ``ansible-playbook`` command.
``user_variables.yml`` and ``user_secrets.yml`` are used directly by
OpenStack-Ansible; adding custom values here is not recommended.
``user_extras_variables.yml`` and ``users_extras_secrets.yml`` are provided
and can contain deployer's custom values, but deployers can add any other
files they wish to include new configuration, or override existing.
OpenStack-Ansible. Adding custom variables used by your own roles and playbooks
to these files is not recommended. Doing so will complicate your upgrade path
by making comparison of your existing files with later versions of these files
more arduous. Rather, recommended practice is to place your own variables in files
named following the ``user_*.yml`` pattern so they will be sourced alongside
those used exclusively by OpenStack-Ansible.
Ordering and Precedence
+++++++++++++++++++++++