Docs and version are updated for MOS 9.0 compatibility

Change-Id: I757ee2599758aea94addd0c087b038259703a2e3
This commit is contained in:
Nadya Shakhat 2016-07-27 15:42:28 +03:00
parent 5ef8543196
commit e8e20c95fa
11 changed files with 33 additions and 44 deletions

View File

@ -7,7 +7,7 @@ master_doc = 'index'
project = u'The Ceilometer Redis Plugin'
copyright = u'2016, Mirantis Inc.'
version = '0.1'
release = '0.1.2'
release = '1.0.3'
exclude_patterns = [
]
pygments_style = 'sphinx'

View File

@ -5,11 +5,13 @@ The *Ceilometer Redis Plugin* installs `Redis <http://redis.io>`_ and
the `Tooz library <http://docs.openstack.org/developer/tooz/>`_, in a
Mirantis OpenStack (MOS) environment deployed by Fuel.
Both Redis and the Tooz library should be installed on all the controller
nodes of the environment.
nodes of the environment. Starting from MOS 9.0, Ceilometer alarming service was
moved to the project called Aodh.
The *Ceilometer Redis Plugin* is used to provide coordination mechanisms to
enable the horizontal scaling of the Ceilometer services. Using the plugin,
the Ceilometer services are joined into a so-called **coordination group**,
enable the horizontal scaling of the Ceilometer/Aodh services. Using the plugin,
the Ceilometer/Aodh services are joined into a so-called **coordination group**,
which allows for resources and alarms sharding.
There is one coordination group per service type.
@ -17,7 +19,7 @@ Please refer to the `Telemetry architecture
<http://docs.openstack.org/admin-guide/telemetry-system-architecture.html>`_
documentation for more information about the Ceilometer services.
In MOS 7.0 and MOS 8.0, the *Ceilometer Redis Plugin* enables coordination
In MOS 9.0, the *Ceilometer Redis Plugin* enables coordination
for both:
* The **ceilometer-agent-central service**.
@ -34,20 +36,20 @@ for both:
across multiple instances of the ceilometer-agent-central using disjoint sets
of resources.
* The **ceilometer-alarm-evaluator service**.
* The **aodh-evaluator service**.
The **ceilometer-alarm-evaluator** service is responsible for evaluating the Ceilometer alarms.
By default, there is only one ceilometer-alarm-evaluator running per environment.
Without coordination, there can be only one ceilometer-alarm-evaluator running at a time.
This is because, as for the ceilometer-agent-central, the ceilometer-alarm-evaluator works
with an entire set of alarms. Running multiple ceilometer-alarm-evaluator
The **aodh-evaluator** service is responsible for evaluating the Ceilometer alarms.
By default, there is only one aodh-evaluator running per environment.
Without coordination, there can be only one aodh-evaluator running at a time.
This is because, as for the ceilometer-agent-central, the aodh-evaluator works
with an entire set of alarms. Running multiple aodh-evaluator
without coordination would evaluate all the alarms as many times as the number of evaluators
running on the controller nodes every evaluation interval. To cope with this problem,
the coordination mechanism provided by the *Ceilometer Redis Plugin* allows distributing
the alarms evaluation workload across multiple instances of the ceilometer-alarm-evaluator
the alarms evaluation workload across multiple instances of the aodh-evaluator
using disjoint sets of alarms.
Please note that with MOS 8.0, the *Ceilometer Redis Plugin* doesn't provide support
Please note that starting from MOS 8.0, the *Ceilometer Redis Plugin* doesn't provide support
(out-of-the-box) for the coordination of the **ceilometer-agent-notification** service because
it is not needed for the most common samples transformations.
@ -56,7 +58,7 @@ it is not needed for the most common samples transformations.
In Liberty, the transformation of the samples was moved
to the **ceilometer-agent-notification** service, but after thorough performance analysis
of Ceilometer at scale, we discovered that this change has a bad impact on performance.
In MOS 8.0, the transformations for the following list of measurements were moved back
Starting from MOS 8.0, the transformations for the following list of measurements were moved back
to the ceilometer-agent-compute service.
* cpu_util
@ -72,7 +74,7 @@ it is not needed for the most common samples transformations.
* network.incoming.packets.rate
* network.outgoing.packets.rate
As a result, in MOS 8.0, there is no need to run the ceilometer-agent-notification
As a result, starting from MOS 8.0, there is no need to run the ceilometer-agent-notification
in coordination mode unless you need to maintain the transformation of custom samples that
are not listed above. In this case, it is possible to enable coordination for the
ceilometer-agent-notification service manually event though, it is not recommended
@ -93,7 +95,7 @@ Requirements
======================= ================
Requirements Version/Comment
======================= ================
MOS 7.0, 8.0
MOS 9.0
Tooz <0.14.0,>=0.13.1
======================= ================

View File

@ -3,10 +3,10 @@ User Guide
Once the *Ceilometer Redis Plugin* is installed following the instructions of
the :ref:`Installation Guide`, you can create a Mirantis OpenStack (MOS) environment
with Ceilometer whose **ceilometer-agent-central** and **ceilometer-alarm-evaluator**
with Ceilometer and Aodh whose **ceilometer-agent-central** and **aodh-evaluator**
services will work in **workload partitioned** mode.
This plugin was created to enable the scale-out of these Ceilometer services.
It is useless and **shouldn't be used if Ceilometer is not installed**.
This plugin was created to enable the scale-out of these Ceilometer/Aodh services.
It is useless and **shouldn't be used if Ceilometer and Aodh are not installed**.
Plugin Configuration
--------------------
@ -21,29 +21,16 @@ with the `Telemetry service
Go to the *Plugins* tab. You should see the following:
On Mos 8.0
.. image:: images/redis-plugin.png
:width: 100%
On Mos 7.0
.. image:: images/redis-plugin-on8-0.png
.. image:: images/redis-plugin-on9-0.png
:width: 100%
2. Enable the plugin.
Go to the *Environments* tab and select the *Redis plugin for Ceilometer* checkbox:
On Mos 8.0
.. image:: images/redis-plugin-8-0.png
.. image:: images/redis-plugin-9-0.png
:width: 100%
On Mos 7.0
.. image:: images/redis-plugin-on.png
:width: 100%
3. Add nodes to your environment to which you will assign the **controller role**.
@ -63,15 +50,15 @@ with the `Telemetry service
Plugin Verification
-------------------
#. Check that the ceilometer-agent-central and ceilometer-alarm-evaluator services are running
#. Check that the ceilometer-agent-central and aodh-evaluator services are running
on each controller.
Run ``pcs resource``. You should see the following in the output::
Run ``http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html`. You should see the following in the output::
Clone Set: clone_p_ceilometer-agent-central [p_ceilometer-agent-central]
Started: [ node-21.domain.tld node-27.domain.tld node-33.domain.tld ]
Clone Set: clone_p_ceilometer-alarm-evaluator [p_ceilometer-alarm-evaluator]
Clone Set: clone_p_aodh-evaluator [p_aodh-evaluator]
Started: [ node-21.domain.tld node-27.domain.tld node-33.domain.tld ]
The *Started* list should contain all controllers.
@ -104,6 +91,6 @@ Plugin Verification
#. For the alarm evaluator, it is possible to see that everything works as expected
only from the logs::
# grep extract_my_subset /var/log/ceilometer/ceilometer-alarm-evaluator.log
# grep extract_my_subset /var/log/aodh/aodh-evaluator.log
There should be different *My subset: [* results for the ceilometer-alarm-evaluator instances.
There should be different *My subset: [* results for the aodh-evaluator instances.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

View File

@ -18,18 +18,18 @@ To install the *Ceilometer Redis Plugin*, you need to follow these steps.
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/intro/intro_fuel_intro.html>`_
with secure copy (scp)::
# scp fuel-plugin-ceilometer-redis/ceilometer-redis-1.0-1.0.0-1.noarch.rpm /
# scp fuel-plugin-ceilometer-redis/ceilometer-redis-1.0-1.0.3-1.noarch.rpm /
root@:<the_Fuel_Master_node_IP address>:/tmp
#. Log into the Fuel Master node and install the plugin::
# ssh root@:<the_Fuel_Master_node_IP address>
[root@fuel-master ~]# cd /tmp
[root@fuel-master ~]# fuel plugins --install ceilometer-redis-1.0-1.0.0-1.noarch.rpm
[root@fuel-master ~]# fuel plugins --install ceilometer-redis-1.0-1.0.3-1.noarch.rpm
#. Verify that the plugin is installed correctly::
[root@fuel-master ~]# fuel plugins list
id | name | version | package_version
---|------------------|---------------|----------------
4 | ceilometer-redis | 1.0.2 | 3.0.0
4 | ceilometer-redis | 1.0.3 | 3.0.0

View File

@ -3,7 +3,7 @@ name: ceilometer-redis
# Human-readable name for your plugin
title: Redis plugin for Ceilometer
# Plugin version
version: 1.0.2
version: 1.0.3
# Description
description: Ceilometer extension that provides a workload-partitioning and HA for ceilometer services
# Required fuel version
@ -11,7 +11,7 @@ fuel_version: ['9.0']
# Specify license of your plugin
licenses: ['Apache License Version 2.0']
# Specify author or company name
authors: ['Ivan Berezovskiy', 'Ilya Tyaptin']
authors: ['Ivan Berezovskiy', 'Ilya Tyaptin', 'Nikita Karpin']
# A link to the plugin's page
homepage: 'https://github.com/openstack/fuel-plugin-ceilometer-redis'
# Groups