=================================
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

To clone or view the source code for this repository, visit the role repository
for `os_cinder <https://github.com/openstack/openstack-ansible-os_cinder>`_.

Default variables
~~~~~~~~~~~~~~~~~

.. literalinclude:: ../../defaults/main.yml
   :language: yaml
   :start-after: under the License.


Dependencies
~~~~~~~~~~~~

This role needs pip >= 7.1 installed on the target host.

This role needs to have the following variables defined:

.. 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"

This list is not exhaustive at present. See role internals for further
details.

Example playbook
~~~~~~~~~~~~~~~~

.. literalinclude:: ../../examples/playbook.yml
   :language: yaml

External Restart Hooks
~~~~~~~~~~~~~~~~~~~~~~

When the role performs a restart of the service, it will notify an Ansible
handler named ``Manage LB``, which is a noop within this role. In the
playbook, other roles may be loaded before and after this role which will
implement Ansible handler listeners for ``Manage LB``, allowing external roles
to manage the load balancer endpoints responsible for sending traffic to the
servers being restarted by marking them in maintenance or active mode,
draining sessions, etc. For an example implementation, please reference the
`ansible-haproxy-endpoints role <https://github.com/Logan2211/ansible-haproxy-endpoints>`_
used by the openstack-ansible project.

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.