Move information from README to documentation
Change-Id: If329233dc23bd2bce96a3465696100fdf76747bd Signed-off-by: Ivan Anfimov <lazekteam@gmail.com>
This commit is contained in:
28
README.rst
28
README.rst
@@ -2,8 +2,7 @@
|
||||
OpenStack-Ansible Trove
|
||||
=======================
|
||||
|
||||
Ansible role that installs and configures OpenStack Trove. Trove is
|
||||
installed behind the Apache webserver listening on port 8779 by default.
|
||||
Ansible role that installs and configures OpenStack Trove.
|
||||
|
||||
Documentation for the project can be found at:
|
||||
`<https://docs.openstack.org/openstack-ansible-os_trove/latest/>`_
|
||||
@@ -19,28 +18,3 @@ The project home is at:
|
||||
|
||||
The project bug tracker is located at:
|
||||
`<https://bugs.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) }}"
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ OpenStack-Ansible Trove
|
||||
This Ansible role installs Trove.
|
||||
|
||||
To clone or view the source code for this repository, visit the role repository
|
||||
for `os_trove <https://github.com/openstack/openstack-ansible-os_trove>`_.
|
||||
for `os_trove <https://opendev.org/openstack/openstack-ansible-os_trove>`_.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -22,12 +22,13 @@ Default variables
|
||||
Dependencies
|
||||
~~~~~~~~~~~~
|
||||
|
||||
This role needs pip >= 7.1 installed on the target host.
|
||||
|
||||
To use this role, define the following variables:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# trove TCP listening port
|
||||
trove_service_port: 8779
|
||||
|
||||
# Service and user passwords
|
||||
trove_galera_password:
|
||||
trove_rabbitmq_password:
|
||||
|
||||
Reference in New Issue
Block a user