openstack-ansible-os_trove/README.rst
Andreas Jaeger abd4d64731 Fix doc8 failure
doc8 is now run as part of the new docs build job, fix failure.

Merge duplicated section.

Remove html_static_path, this is non-existant.

Fix docs environment to enable warnings.

Change-Id: I47b0af6257c0bc96fd23a5bd8620a6e137c77f17
2018-08-28 09:43:40 +02:00

54 lines
1.4 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/openstack-ansible-os_trove.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
=======================
OpenStack-Ansible Trove
=======================
Ansible role that installs and configures OpenStack Trove. Trove is
installed behind the Apache webserver listening on port 8779 by default.
Documentation for the project can be found at:
`<https://docs.openstack.org/openstack-ansible-os_trove/latest/>`_
Release notes for the project can be found at:
`<https://docs.openstack.org/releasenotes/openstack-ansible-os_trove/>`_
The project source code repository is located at:
`<https://git.openstack.org/cgit/openstack/openstack-ansible-os_trove>`_
The project home is at:
`<https://launchpad.net/openstack-ansible>`_
Required Variables
==================
This list is not exhaustive at present. See role internals for further
details.
.. code-block:: yaml
# trove TCP listening port
trove_service_port: 8779
Example Playbook
================
.. code-block:: yaml
- name: Install trove service
hosts: trove_all
user: root
roles:
- { role: "os_trove", tags: [ "os-trove" ] }
vars:
is_metal: "{{ properties.is_metal|default(false) }}"