openstack/openstack-manuals
Code Issues Proposed changes

Merge "[install] Improve aodh content"

Browse Source
This commit is contained in:
Jenkins
2016-01-29 01:36:38 +00:00
committed by Gerrit Code Review
parent 9073f1babb 5c7846ab30
commit 70f068d07c
2 changed files with 125 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

258
doc/install-guide/source/ceilometer-aodh.rst
View File

@@ -1,36 +1,23 @@
.. _aodh-install: .. _aodh-install:
========================================== ================
Install and configure the alarming service Alarming service
========================================== ================
The Telemetry module contains a stand-alone alarming service, This section describes how to install and configure the Telemetry Alarming
code-named Aodh. This chapter guides you through the installation service, code-named aodh.
steps of this alarm management module that will work together with
the other services of Telemetry. Prerequisites
~~~~~~~~~~~~~
Before you install and configure the Alarming service, you must create a
database, service credentials, and API endpoints. Similar to other Telemetry
module services, this guide configures a NoSQL database. For more information,
see :ref:`environment-nosql-database`.
.. only:: ubuntu .. only:: ubuntu
.. warning:: 1. Create the ``aodh`` database:
In the Liberty release of OpenStack, the services of the new Telemetry
Alarming module are not officially supported on Ubuntu-based
deployments.
Configure prerequisites
~~~~~~~~~~~~~~~~~~~~~~~
The alarming service requires database access to store alarm definitions and
history. You must install a database back end and create a database
for Aodh. You also need to create service credentials, and API endpoint. If
you already installed a database back end for the base services of the
Telemetry module, you can choose to use that for the alarming service also.
If you need to install a back end, see :ref:`environment-nosql-database` to
install and configure MongoDB before proceeding further.
.. only:: ubuntu
#. Create the ``aodh`` database:
.. code-block:: console .. code-block:: console
@@ -52,12 +39,11 @@ install and configure MongoDB before proceeding further.
"_id" : ObjectId("5489c22270d7fad1ba631dc3") "_id" : ObjectId("5489c22270d7fad1ba631dc3")
} }
Replace ``AODH_DBPASS`` with a suitable password. Replace ``AODH_DBPASS`` with a suitable password.
.. only:: rdo .. only:: rdo
#. Create the ``aodh`` database: 1. Create the ``aodh`` database:
.. code-block:: console .. code-block:: console
@@ -73,60 +59,58 @@ install and configure MongoDB before proceeding further.
Replace ``AODH_DBPASS`` with a suitable password. Replace ``AODH_DBPASS`` with a suitable password.
2. Source the ``admin`` credentials to gain access to admin-only
#. Source the ``admin`` credentials to gain access to admin-only
CLI commands: CLI commands:
.. code-block:: console .. code-block:: console
$ source admin-openrc.sh $ source admin-openrc.sh
#. Create the service credentials: 3. To create the service credentials, complete these steps:
* Create the ``aodh`` user: * Create the ``aodh`` user:
.. code-block:: console .. code-block:: console
$ openstack user create --password-prompt aodh $ openstack user create --password-prompt aodh
User Password: User Password:
Repeat User Password: Repeat User Password:
+----------+----------------------------------+ +-----------+----------------------------------+
| Field | Value | | Field | Value |
+----------+----------------------------------+ +-----------+----------------------------------+
| email | None | | domain_id | default |
| enabled | True | | enabled | True |
| id | b7657c9ea07a4556aef5d34cf70713a3 | | id | b7657c9ea07a4556aef5d34cf70713a3 |
| name | aodh | | name | aodh |
| username | aodh | +-----------+----------------------------------+
+----------+----------------------------------+
* Add the ``admin`` role to the ``aodh`` user: * Add the ``admin`` role to the ``aodh`` user:
.. code-block:: console .. code-block:: console
$ openstack role add --project service --user aodh admin $ openstack role add --project service --user aodh admin
.. note:: .. note::
This command provides no output. This command provides no output.
* Create the ``aodh`` service entity: * Create the ``aodh`` service entity:
.. code-block:: console .. code-block:: console
$ openstack service create --name aodh \ $ openstack service create --name aodh \
--description "Telemetry" alarming --description "Telemetry" alarming
+-------------+----------------------------------+ +-------------+----------------------------------+
| Field | Value | | Field | Value |
+-------------+----------------------------------+ +-------------+----------------------------------+
| description | Telemetry | | description | Telemetry |
| enabled | True | | enabled | True |
| id | 3405453b14da441ebb258edfeba96d83 | | id | 3405453b14da441ebb258edfeba96d83 |
| name | aodh | | name | aodh |
| type | alarming | | type | alarming |
+-------------+----------------------------------+ +-------------+----------------------------------+
#. Create the Telemetry Alarming service API endpoints: 4. Create the Alarming service API endpoints:
.. code-block:: console .. code-block:: console
@@ -178,8 +162,8 @@ install and configure MongoDB before proceeding further.
| url | http://controller:8042 | | url | http://controller:8042 |
+--------------+----------------------------------+ +--------------+----------------------------------+
Install and configure the Telemetry Alarming service components Install and configure components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note:: .. note::
@@ -208,89 +192,95 @@ Install and configure the Telemetry Alarming service components
# apt-get install aodh-api aodh-evaluator aodh-notifier \ # apt-get install aodh-api aodh-evaluator aodh-notifier \
aodh-listener aodh-expirer python-ceilometerclient aodh-listener aodh-expirer python-ceilometerclient
#. Edit the ``/etc/aodh/aodh.conf`` file and perform these steps: 2. Edit the ``/etc/aodh/aodh.conf`` file and complete the following actions:
* In the ``[database]`` section, configure database access: * In the ``[database]`` section, configure database access:
.. code-block:: ini .. code-block:: ini
[database] [database]
... ...
connection = mongodb://aodh:AODH_DBPASS@controller:27017/aodh connection = mongodb://aodh:AODH_DBPASS@controller:27017/aodh
Replace ``AODH_DBPASS`` with the password you chose for the Replace ``AODH_DBPASS`` with the password you chose for the
Telemetry Alarming module database. You must escape special characters Telemetry Alarming module database. You must escape special characters
such as ':', '/', '+', and '@' in the connection string. For further such as ':', '/', '+', and '@' in the connection string in accordance
information see the Reserved Characters section of with `RFC2396 <https://www.ietf.org/rfc/rfc2396.txt>`_.
:ref:`RFC2396 <https://www.ietf.org/rfc/rfc2396.txt>`.
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections, * In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access: configure ``RabbitMQ`` message queue access:
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... ...
rpc_backend = rabbit rpc_backend = rabbit
[oslo_messaging_rabbit] [oslo_messaging_rabbit]
... ...
rabbit_host = controller rabbit_host = controller
rabbit_userid = openstack rabbit_userid = openstack
rabbit_password = RABBIT_PASS rabbit_password = RABBIT_PASS
Replace ``RABBIT_PASS`` with the password you chose for the Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``. ``openstack`` account in ``RabbitMQ``.
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, * In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
configure Identity service access: configure Identity service access:
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... ...
auth_strategy = keystone auth_strategy = keystone
[keystone_authtoken] [keystone_authtoken]
... ...
auth_uri = http://controller:5000/v2.0 auth_uri = http://controller:5000
identity_uri = http://controller:35357 auth_url = http://controller:35357
admin_tenant_name = service auth_plugin = password
admin_user = aodh project_domain_id = default
admin_password = AODH_PASS user_domain_id = default
project_name = service
username = aodh
password = AODH_PASS
Replace ``AODH_PASS`` with the password you chose for Replace ``AODH_PASS`` with the password you chose for
the ``aodh`` user in the Identity service. the ``aodh`` user in the Identity service.
* In the ``[service_credentials]`` section, configure service credentials: * In the ``[service_credentials]`` section, configure service credentials:
.. code-block:: ini .. code-block:: ini
[service_credentials] [service_credentials]
... ...
os_auth_url = http://controller:5000/v2.0 os_auth_url = http://controller:5000/v2.0
os_username = aodh os_username = aodh
os_tenant_name = service os_tenant_name = service
os_password = AODH_PASS os_password = AODH_PASS
os_endpoint_type = internalURL os_endpoint_type = internalURL
os_region_name = RegionOne os_region_name = RegionOne
Replace ``AODH_PASS`` with the password you chose for Replace ``AODH_PASS`` with the password you chose for
the ``aodh`` user in the Identity service. the ``aodh`` user in the Identity service.
* (Optional) To assist with troubleshooting, enable verbose * (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section: logging in the ``[DEFAULT]`` section:
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... ...
verbose = True verbose = True
.. todo:
Workaround for https://bugs.launchpad.net/ubuntu/+source/aodh/+bug/1513599.
.. only:: ubuntu .. only:: ubuntu
#. Edit the api_paste.ini file and add or modify the 3. Edit the ``/etc/aodh/api_paste.ini`` file and modify the
``[filter:authtoken]`` section: ``[filter:authtoken]`` section as follows:
.. code-block:: ini .. code-block:: ini
@@ -303,27 +293,27 @@ Finalize installation
.. only:: rdo .. only:: rdo
#. Start the Telemetry Alarming services and configure them to start * Start the Alarming services and configure them to start when the system
when the system boots: boots:
.. code-block:: console .. code-block:: console
# systemctl enable openstack-aodh-api.service \ # systemctl enable openstack-aodh-api.service \
openstack-aodh-evaluator.service \ openstack-aodh-evaluator.service \
openstack-aodh-notifier.service \ openstack-aodh-notifier.service \
openstack-aodh-listener.service openstack-aodh-listener.service
# systemctl start openstack-aodh-api.service \ # systemctl start openstack-aodh-api.service \
openstack-aodh-evaluator.service \ openstack-aodh-evaluator.service \
openstack-aodh-notifier.service \ openstack-aodh-notifier.service \
openstack-aodh-listener.service openstack-aodh-listener.service
.. only:: ubuntu .. only:: ubuntu
#. Restart the Telemetry Alarming services: * Restart the Alarming services:
.. code-block:: console .. code-block:: console
# service aodh-api restart # service aodh-api restart
# service aodh-evaluator restart # service aodh-evaluator restart
# service aodh-notifier restart # service aodh-notifier restart
# service aodh-listener restart # service aodh-listener restart

2
doc/install-guide/source/ceilometer-install.rst
View File

@@ -217,7 +217,7 @@ Install and configure components
Replace ``CEILOMETER_DBPASS`` with the password you chose for the Replace ``CEILOMETER_DBPASS`` with the password you chose for the
Telemetry service database. You must escape special characters such Telemetry service database. You must escape special characters such
as ':', '/', '+', and '@' in the connection string in accordance as ':', '/', '+', and '@' in the connection string in accordance
with RFC2396. with `RFC2396 <https://www.ietf.org/rfc/rfc2396.txt>`_.
.. only:: obs or rdo or ubuntu .. only:: obs or rdo or ubuntu