[DOCS] Move gnocchi configs from developer docs

This commit moves the aodh configs in the developer docs
over to the role. It also cleans up README.rst and index.rst to
support the new three structure for the roles docs

Change-Id: I63bf5a2b742998265782c35582734d1f1d9d1fe8
Signed-off-by: alextricity25 <miguel.cantu@rackspace.com>
This commit is contained in:
alextricity25 2016-08-11 13:35:28 -05:00
parent 7400b51e4e
commit 89ab19e011
3 changed files with 36 additions and 62 deletions

View File

@ -1,5 +1,6 @@
=========================
OpenStack-Ansible Gnocchi
#########################
=========================
Ansible role which installs and configures OpenStack Gnocchi. Gnocchi installs
behind an Apache webserver listening for HTTP connections on port 8041 and
@ -8,63 +9,3 @@ writes to filesystem storage by default.
The role can readily be configured to use Swift or Ceph storage as desired and
may be used as a stand-alone service integrated with Keystone for auth or with
Ceilometer as a metrics source.
Default Variables
=================
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required Variables
==================
This list is not considered exhaustive at present. See role internals for
further details.
.. code-block:: yaml
gnocchi_container_mysql_password: "secrete"
galera_address: 10.100.100.2
# Keystone credentials
keystone_admin_tenant_name: admin
keystone_admin_user_name: admin
keystone_auth_admin_password: "SuperSecretePassword"
keystone_service_adminuri_insecure: false
keystone_service_adminurl: "https://10.100.100.10:35357/v3"
keystone_service_internalurl: "https://10.100.100.10:5000/v3"
# Keystone password for the gnocchi service user
gnocchi_service_password: "secrete"
# hostname or IP of load balancer providing external network
# access to Keystone
external_lb_vip_address: 10.100.100.102
# hostname or IP of load balancer providing internal network
# access to Keystone
internal_lb_vip_address: 10.100.100.102
Example Playbook
================
.. code-block:: yaml
- name: Installation and setup of Keystone
hosts: keystone_all
user: root
roles:
- { role: "os_keystone", tags: [ "os-keystone" ] }
vars:
Tags
====
This role supports two tags: ``gnocchi-install`` and ``gnocchi-config``
The ``gnocchi-install`` tag can be used to install and upgrade.
The ``gnocchi-config`` tag can be used to maintain configuration of the
service.

View File

@ -1 +1,29 @@
.. include:: ../../README.rst
=================
Table of Contents
=================
.. toctree::
:maxdepth: 2
overview.rst
Default variables
~~~~~~~~~~~~~~~~~
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml
Tags
~~~~
This role supports two tags: ``gnocchi-install`` and
``gnocchi-config``. The ``gnocchi-install`` tag can be used to install
and upgrade. The ``gnocchi-config`` tag can be used to maintain the
configuration of the service.

5
examples/playbook.yml Normal file
View File

@ -0,0 +1,5 @@
- name: Installation and setup of Keystone
hosts: keystone_all
user: root
roles:
- { role: "os_keystone", tags: [ "os-keystone" ] }