[DOCS] Move aodh 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 tree structure for role docs. Change-Id: I424f16260339581b6ea612c9f7fd4b855bf62676 Signed-off-by: alextricity25 <miguel.cantu@rackspace.com>
This commit is contained in:
alextricity25
parent
f03762a45b
commit
fd4346e7fc
44
README.rst
44
README.rst
|
|
@ -49,47 +49,3 @@ To use this role, define the following variables:
|
|||
keystone_service_internalurl: "{{ keystone_service_internaluri }}/v3"
|
||||
keystone_service_adminuri: "http://5.6.7.8:35357"
|
||||
keystone_service_adminurl: "{{ keystone_service_adminuri }}/v3"
|
||||
|
||||
Example Playbook
|
||||
================
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
- name: Install aodh services
|
||||
hosts: aodh_all
|
||||
user: root
|
||||
roles:
|
||||
- { role: "os_aodh" }
|
||||
vars:
|
||||
# Needed for aodh to talk to MongoDB
|
||||
aodh_container_db_password: "secrete"
|
||||
# Password used for Keystone aodh service user
|
||||
aodh_service_password: "secrete"
|
||||
# Needed for aodh to talk to memcached
|
||||
memcached_servers: 127.0.0.1
|
||||
memcached_encryption_key: "some_key"
|
||||
# Needed for aodh to locate and connect to the RabbitMQ cluster
|
||||
aodh_rabbitmq_password: "secrete"
|
||||
rabbitmq_servers: "10.100.100.2"
|
||||
rabbitmq_use_ssl: true
|
||||
rabbitmq_port: 5671
|
||||
# Needed to setup the aodh service in Keystone
|
||||
keystone_admin_user_name: admin
|
||||
keystone_admin_tenant_name: admin
|
||||
keystone_auth_admin_password: "SuperSecretePassword"
|
||||
keystone_service_adminuri_insecure: false
|
||||
keystone_service_internaluri_insecure: false
|
||||
keystone_service_internaluri: "http://1.2.3.4:5000"
|
||||
keystone_service_internalurl: "{{ keystone_service_internaluri }}/v3"
|
||||
keystone_service_adminuri: "http://5.6.7.8:35357"
|
||||
keystone_service_adminurl: "{{ keystone_service_adminuri }}/v3"
|
||||
|
||||
Tags
|
||||
====
|
||||
|
||||
This role supports two tags: ``aodh-install`` and ``aodh-config``
|
||||
|
||||
The ``aodh-install`` tag can be used to install and upgrade.
|
||||
|
||||
The ``aodh-config`` tag can be used to maintain configuration of the
|
||||
aodh components.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,57 @@
|
|||
=======================================
|
||||
Configuring the Aodh service (optional)
|
||||
=======================================
|
||||
|
||||
The Telemetry alarming services perform the following functions:
|
||||
|
||||
- Creates an API endpoint for controlling alarms.
|
||||
|
||||
- Allows you to set alarms based on threshold evaluation for a collection of
|
||||
samples.
|
||||
|
||||
|
||||
|
||||
Configuring the hosts
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Configure Aodh by specifying the ``metering-alarm_hosts`` directive in
|
||||
the ``/etc/openstack_deploy/conf.d/aodh.yml`` file. The following shows
|
||||
the example included in the
|
||||
``etc/openstack_deploy/conf.d/aodh.yml.example`` file:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# The infra nodes that the Aodh services run on.
|
||||
metering-alarm_hosts:
|
||||
infra1:
|
||||
ip: 172.20.236.111
|
||||
infra2:
|
||||
ip: 172.20.236.112
|
||||
infra3:
|
||||
ip: 172.20.236.113
|
||||
|
||||
The ``metering-alarm_hosts`` provides several services:
|
||||
|
||||
- An API server (``aodh-api``): Runs on one or more central management
|
||||
servers to provide access to the alarm information in the
|
||||
data store.
|
||||
|
||||
- An alarm evaluator (``aodh-evaluator``): Runs on one or more central
|
||||
management servers to determine alarm fire due to the
|
||||
associated statistic trend crossing a threshold over a sliding
|
||||
time window.
|
||||
|
||||
- A notification listener (``aodh-listener``): Runs on a central
|
||||
management server and fire alarms based on defined rules against
|
||||
event captured by ceilometer's module's notification agents.
|
||||
|
||||
- An alarm notifier (``aodh-notifier``). Runs on one or more central
|
||||
management servers to allow the setting of alarms to base on the
|
||||
threshold evaluation for a collection of samples.
|
||||
|
||||
These services communicate by using the OpenStack messaging bus. Only
|
||||
the API server has access to the data store.
|
||||
|
||||
Run the ``os-aodh-install.yml`` playbook. If deploying a new OpenStack
|
||||
(instead of only Aodh), run ``setup-openstack.yml``.
|
||||
The Aodh playbooks run as part of this playbook.
|
||||
|
|
@ -1 +1,60 @@
|
|||
.. include:: ../../README.rst
|
||||
=================
|
||||
Table of Contents
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
overview.rst
|
||||
configure-aodh.rst
|
||||
|
||||
Default variables
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../defaults/main.yml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
||||
|
||||
Example playbook
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../examples/playbook.yml
|
||||
:language: yaml
|
||||
|
||||
Required Variables
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To use this role, define the following variables:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Needed for aodh to talk to MongoDB
|
||||
aodh_container_db_password: "secrete"
|
||||
# Password used for Keystone aodh service user
|
||||
aodh_service_password: "secrete"
|
||||
# Needed for aodh to talk to memcached
|
||||
memcached_servers: 127.0.0.1
|
||||
memcached_encryption_key: "some_key"
|
||||
# Needed for aodh to locate and connect to the RabbitMQ cluster
|
||||
aodh_rabbitmq_password: "secrete"
|
||||
rabbitmq_servers: "10.100.100.2"
|
||||
rabbitmq_use_ssl: true
|
||||
rabbitmq_port: 5671
|
||||
# Needed to setup the aodh service in Keystone
|
||||
keystone_admin_user_name: admin
|
||||
keystone_admin_tenant_name: admin
|
||||
keystone_auth_admin_password: "SuperSecretePassword"
|
||||
keystone_service_adminuri_insecure: false
|
||||
keystone_service_internaluri_insecure: false
|
||||
keystone_service_internaluri: "http://1.2.3.4:5000"
|
||||
keystone_service_internalurl: "{{ keystone_service_internaluri }}/v3"
|
||||
keystone_service_adminuri: "http://5.6.7.8:35357"
|
||||
keystone_service_adminurl: "{{ keystone_service_adminuri }}/v3"
|
||||
|
||||
Tags
|
||||
~~~~
|
||||
|
||||
This role supports two tags: ``aodh-install`` and
|
||||
``aodh-config``. The ``aodh-install`` tag can be used to install
|
||||
and upgrade. The ``aodh-config`` tag can be used to maintain the
|
||||
configuration of the service.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
- name: Install aodh services
|
||||
hosts: aodh_all
|
||||
user: root
|
||||
roles:
|
||||
- { role: "os_aodh" }
|
||||
vars:
|
||||
# Needed for aodh to talk to MongoDB
|
||||
aodh_container_db_password: "secrete"
|
||||
# Password used for Keystone aodh service user
|
||||
aodh_service_password: "secrete"
|
||||
# Needed for aodh to talk to memcached
|
||||
memcached_servers: 127.0.0.1
|
||||
memcached_encryption_key: "some_key"
|
||||
# Needed for aodh to locate and connect to the RabbitMQ cluster
|
||||
aodh_rabbitmq_password: "secrete"
|
||||
rabbitmq_servers: "10.100.100.2"
|
||||
rabbitmq_use_ssl: true
|
||||
rabbitmq_port: 5671
|
||||
# Needed to setup the aodh service in Keystone
|
||||
keystone_admin_user_name: admin
|
||||
keystone_admin_tenant_name: admin
|
||||
keystone_auth_admin_password: "SuperSecretePassword"
|
||||
keystone_service_adminuri_insecure: false
|
||||
keystone_service_internaluri_insecure: false
|
||||
keystone_service_internaluri: "http://1.2.3.4:5000"
|
||||
keystone_service_internalurl: "{{ keystone_service_internaluri }}/v3"
|
||||
keystone_service_adminuri: "http://5.6.7.8:35357"
|
||||
keystone_service_adminurl: "{{ keystone_service_adminuri }}/v3"
|
||||
Loading…
Reference in New Issue