openstack-ansible/doc/source/playbooks.rst
Nolan Brubaker 9012a748d3 Add Sphinx machinery and initial docs.
This commit gets the doc directory and Sphinx configuration started.

Further documentation will depend on the Sphinx files and the index.rst
file at the very least.

The dev-requirements were updated to install Sphinx, and a gating script
was added to do the building for when we move to actually do gating on
the docs. The docs gate script is currently set to treat warning as
errors.

Change-Id: I977a2e53f1b0981cbc702ac53f2198d9f6a9da9d
Implements: blueprint developer-docs
2015-05-14 10:50:05 -04:00

49 lines
1.3 KiB
ReStructuredText

os-ansible-deployment Playbooks
===============================
The OpenStack Ansible playbooks are stored in the playbooks directory.
There are several top-level playbooks that are run to prepare the host machines
before actually deploying OpenStack and associated containers.
Running Playbooks
-----------------
There is an `openstack-ansible` command installed by the
`scripts/bootstrap-ansible.sh` script. This wraps the `ansible-playbook`
command and provides the `/etc/openstack_deploy/user_*.yml` variable files
to the playbooks.
All of the playbooks should be run within the `os-ansible-deployment/playbooks`
directory
Setting up the Hosts
--------------------
Run `openstack-ansible setup-hosts.yml` to set up the physical hosts for
containers.
Setting up Infrastructure
-------------------------
Infrastructure pertains to utility services such as RabbitMQ, memcached,
galera, and logging which are not actually OpenStack services, but that
OpenStack relies on.
Run `openstack-ansible setup-infrastructure.yml` to install these containers.
Setting up OpenStack
--------------------
Running `openstack-ansible setup-openstack.yml` will install the following
OpenStack services:
* Keystone
* Swift
* Glance
* Cinder
* Nova
* Neutron
* Heat
* Horizon