openstack-ansible/doc/source/reference/conventions.rst
Jean-Philippe Evrard 6435ec7521 [Docs] Simplify advanced config
This merges advanced configuration and inventory, from the
operations guide into the reference guide. This avoids
duplications of the documentation accross the guides.

Change-Id: I6fd758b89a84698b0ac8e227d97cb24914bc2066
2018-02-20 08:09:22 +00:00

55 lines
1.3 KiB
ReStructuredText

===========
Conventions
===========
To avoid extra configuration, a series of conventions are set into code.
Default folders locations
=========================
Ansible roles
~~~~~~~~~~~~~
The ansible roles are stored under ``/etc/ansible/roles``.
OpenStack-Ansible directory checkout
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The code is generally located into ``/opt/openstack-ansible``.
OpenStack-Ansible wrapper
~~~~~~~~~~~~~~~~~~~~~~~~~
Our ``openstack-ansible`` cli is located in ``/usr/bin/openstack-ansible``.
It sources an environment variable file located in:
``/usr/bin/openstack-ansible.rc``.
Userspace configurations
~~~~~~~~~~~~~~~~~~~~~~~~~
All the userspace configurations are expected to be in
``/etc/openstack_deploy/``.
Ansible configuration
=====================
Ansible.cfg
~~~~~~~~~~~
There is no ``ansible.cfg`` provided with OpenStack-Ansible.
Environment variables are used to alter the default
Ansible behavior if necessary.
Ansible roles fetching
~~~~~~~~~~~~~~~~~~~~~~
Any roles defined in ``openstack-ansible/ansible-role-requirements.yml``
will be installed by the
``openstack-ansible/scripts/bootstrap-ansible.sh`` script, and fetched
into the ansible roles folder.
Inventory conventions
~~~~~~~~~~~~~~~~~~~~~
Please confer to the inventory section of this reference.