Travis Truman 88416a9760 [DOCS] - Clean up role docs
Changes are:
 - README now links to role docs and project launchpad
 - Project homepage links to developer docs
 - Service capitalization fixed
 - Example playbook indentation fixed

Change-Id: I40b20c48cc15d516d949be51aa55597a4d77a421
2016-08-17 10:56:38 -04:00

57 lines
1.2 KiB
ReStructuredText

=================================
Cinder role for OpenStack-Ansible
=================================
This Ansible role installs and configures OpenStack cinder.
The following cinder services are managed by the role:
* cinder-api
* cinder-volume
* cinder-scheduler
By default, cinder API v1 and v2 are both enabled.
.. toctree::
:maxdepth: 2
configure-cinder.rst
Default variables
~~~~~~~~~~~~~~~~~
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required variables
~~~~~~~~~~~~~~~~~~
This list is not exhaustive at present. See role internals for further
details.
.. code-block:: yaml
# Comma separated list of Glance API servers
cinder_glance_api_servers: "http://glance_server:9292"
# Hostname or IP address of the Galera database
cinder_galera_address: "1.2.3.4"
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml
Tags
~~~~
This role supports two tags: ``cinder-install`` and ``cinder-config``
The ``cinder-install`` tag can be used to install and upgrade.
The ``cinder-config`` tag can be used to maintain configuration of the
service.