summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNadya Shakhat <nprivalova@mirantis.com>2016-07-27 15:42:28 +0300
committerNadya Shakhat <nprivalova@mirantis.com>2016-07-27 18:29:00 +0300
commite8e20c95fa5e9688b3e47de43b402e72445d75a6 (patch)
tree287c1e2f4d252bb2ed7c2c869095071122e7e76f
parent5ef85431960fe73ebd36273af0d10854e171c849 (diff)
Docs and version are updated for MOS 9.0 compatibilityHEADmaster
Notes
Notes (review): Code-Review+2: Nadya Shakhat <nprivalova@mirantis.com> Workflow+1: Nadya Shakhat <nprivalova@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 29 Jul 2016 10:39:18 +0000 Reviewed-on: https://review.openstack.org/347807 Project: openstack/fuel-plugin-ceilometer-redis Branch: refs/heads/master
-rw-r--r--doc/source/conf.py2
-rw-r--r--doc/source/description.rst32
-rw-r--r--doc/source/guide.rst33
-rw-r--r--doc/source/images/redis-plugin-8-0.pngbin84459 -> 0 bytes
-rw-r--r--doc/source/images/redis-plugin-9-0.pngbin0 -> 104932 bytes
-rw-r--r--doc/source/images/redis-plugin-on.pngbin104845 -> 0 bytes
-rw-r--r--doc/source/images/redis-plugin-on8-0.pngbin70348 -> 0 bytes
-rw-r--r--doc/source/images/redis-plugin-on9-0.pngbin0 -> 70945 bytes
-rw-r--r--doc/source/images/redis-plugin.pngbin65217 -> 0 bytes
-rw-r--r--doc/source/installation.rst6
-rw-r--r--metadata.yaml4
11 files changed, 33 insertions, 44 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f30d55f..8b142a5 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -7,7 +7,7 @@ master_doc = 'index'
7project = u'The Ceilometer Redis Plugin' 7project = u'The Ceilometer Redis Plugin'
8copyright = u'2016, Mirantis Inc.' 8copyright = u'2016, Mirantis Inc.'
9version = '0.1' 9version = '0.1'
10release = '0.1.2' 10release = '1.0.3'
11exclude_patterns = [ 11exclude_patterns = [
12] 12]
13pygments_style = 'sphinx' 13pygments_style = 'sphinx'
diff --git a/doc/source/description.rst b/doc/source/description.rst
index 3c3d115..061e3ae 100644
--- a/doc/source/description.rst
+++ b/doc/source/description.rst
@@ -5,11 +5,13 @@ The *Ceilometer Redis Plugin* installs `Redis <http://redis.io>`_ and
5the `Tooz library <http://docs.openstack.org/developer/tooz/>`_, in a 5the `Tooz library <http://docs.openstack.org/developer/tooz/>`_, in a
6Mirantis OpenStack (MOS) environment deployed by Fuel. 6Mirantis OpenStack (MOS) environment deployed by Fuel.
7Both Redis and the Tooz library should be installed on all the controller 7Both Redis and the Tooz library should be installed on all the controller
8nodes of the environment. 8nodes of the environment. Starting from MOS 9.0, Ceilometer alarming service was
9moved to the project called Aodh.
10
9 11
10The *Ceilometer Redis Plugin* is used to provide coordination mechanisms to 12The *Ceilometer Redis Plugin* is used to provide coordination mechanisms to
11enable the horizontal scaling of the Ceilometer services. Using the plugin, 13enable the horizontal scaling of the Ceilometer/Aodh services. Using the plugin,
12the Ceilometer services are joined into a so-called **coordination group**, 14the Ceilometer/Aodh services are joined into a so-called **coordination group**,
13which allows for resources and alarms sharding. 15which allows for resources and alarms sharding.
14There is one coordination group per service type. 16There is one coordination group per service type.
15 17
@@ -17,7 +19,7 @@ Please refer to the `Telemetry architecture
17<http://docs.openstack.org/admin-guide/telemetry-system-architecture.html>`_ 19<http://docs.openstack.org/admin-guide/telemetry-system-architecture.html>`_
18documentation for more information about the Ceilometer services. 20documentation for more information about the Ceilometer services.
19 21
20In MOS 7.0 and MOS 8.0, the *Ceilometer Redis Plugin* enables coordination 22In MOS 9.0, the *Ceilometer Redis Plugin* enables coordination
21for both: 23for both:
22 24
23 * The **ceilometer-agent-central service**. 25 * The **ceilometer-agent-central service**.
@@ -34,20 +36,20 @@ for both:
34 across multiple instances of the ceilometer-agent-central using disjoint sets 36 across multiple instances of the ceilometer-agent-central using disjoint sets
35 of resources. 37 of resources.
36 38
37 * The **ceilometer-alarm-evaluator service**. 39 * The **aodh-evaluator service**.
38 40
39 The **ceilometer-alarm-evaluator** service is responsible for evaluating the Ceilometer alarms. 41 The **aodh-evaluator** service is responsible for evaluating the Ceilometer alarms.
40 By default, there is only one ceilometer-alarm-evaluator running per environment. 42 By default, there is only one aodh-evaluator running per environment.
41 Without coordination, there can be only one ceilometer-alarm-evaluator running at a time. 43 Without coordination, there can be only one aodh-evaluator running at a time.
42 This is because, as for the ceilometer-agent-central, the ceilometer-alarm-evaluator works 44 This is because, as for the ceilometer-agent-central, the aodh-evaluator works
43 with an entire set of alarms. Running multiple ceilometer-alarm-evaluator 45 with an entire set of alarms. Running multiple aodh-evaluator
44 without coordination would evaluate all the alarms as many times as the number of evaluators 46 without coordination would evaluate all the alarms as many times as the number of evaluators
45 running on the controller nodes every evaluation interval. To cope with this problem, 47 running on the controller nodes every evaluation interval. To cope with this problem,
46 the coordination mechanism provided by the *Ceilometer Redis Plugin* allows distributing 48 the coordination mechanism provided by the *Ceilometer Redis Plugin* allows distributing
47 the alarms evaluation workload across multiple instances of the ceilometer-alarm-evaluator 49 the alarms evaluation workload across multiple instances of the aodh-evaluator
48 using disjoint sets of alarms. 50 using disjoint sets of alarms.
49 51
50Please note that with MOS 8.0, the *Ceilometer Redis Plugin* doesn't provide support 52Please note that starting from MOS 8.0, the *Ceilometer Redis Plugin* doesn't provide support
51(out-of-the-box) for the coordination of the **ceilometer-agent-notification** service because 53(out-of-the-box) for the coordination of the **ceilometer-agent-notification** service because
52it is not needed for the most common samples transformations. 54it is not needed for the most common samples transformations.
53 55
@@ -56,7 +58,7 @@ it is not needed for the most common samples transformations.
56 In Liberty, the transformation of the samples was moved 58 In Liberty, the transformation of the samples was moved
57 to the **ceilometer-agent-notification** service, but after thorough performance analysis 59 to the **ceilometer-agent-notification** service, but after thorough performance analysis
58 of Ceilometer at scale, we discovered that this change has a bad impact on performance. 60 of Ceilometer at scale, we discovered that this change has a bad impact on performance.
59 In MOS 8.0, the transformations for the following list of measurements were moved back 61 Starting from MOS 8.0, the transformations for the following list of measurements were moved back
60 to the ceilometer-agent-compute service. 62 to the ceilometer-agent-compute service.
61 63
62 * cpu_util 64 * cpu_util
@@ -72,7 +74,7 @@ it is not needed for the most common samples transformations.
72 * network.incoming.packets.rate 74 * network.incoming.packets.rate
73 * network.outgoing.packets.rate 75 * network.outgoing.packets.rate
74 76
75 As a result, in MOS 8.0, there is no need to run the ceilometer-agent-notification 77 As a result, starting from MOS 8.0, there is no need to run the ceilometer-agent-notification
76 in coordination mode unless you need to maintain the transformation of custom samples that 78 in coordination mode unless you need to maintain the transformation of custom samples that
77 are not listed above. In this case, it is possible to enable coordination for the 79 are not listed above. In this case, it is possible to enable coordination for the
78 ceilometer-agent-notification service manually event though, it is not recommended 80 ceilometer-agent-notification service manually event though, it is not recommended
@@ -93,7 +95,7 @@ Requirements
93======================= ================ 95======================= ================
94Requirements Version/Comment 96Requirements Version/Comment
95======================= ================ 97======================= ================
96MOS 7.0, 8.0 98MOS 9.0
97Tooz <0.14.0,>=0.13.1 99Tooz <0.14.0,>=0.13.1
98======================= ================ 100======================= ================
99 101
diff --git a/doc/source/guide.rst b/doc/source/guide.rst
index 6a179e1..2449c8d 100644
--- a/doc/source/guide.rst
+++ b/doc/source/guide.rst
@@ -3,10 +3,10 @@ User Guide
3 3
4Once the *Ceilometer Redis Plugin* is installed following the instructions of 4Once the *Ceilometer Redis Plugin* is installed following the instructions of
5the :ref:`Installation Guide`, you can create a Mirantis OpenStack (MOS) environment 5the :ref:`Installation Guide`, you can create a Mirantis OpenStack (MOS) environment
6with Ceilometer whose **ceilometer-agent-central** and **ceilometer-alarm-evaluator** 6with Ceilometer and Aodh whose **ceilometer-agent-central** and **aodh-evaluator**
7services will work in **workload partitioned** mode. 7services will work in **workload partitioned** mode.
8This plugin was created to enable the scale-out of these Ceilometer services. 8This plugin was created to enable the scale-out of these Ceilometer/Aodh services.
9It is useless and **shouldn't be used if Ceilometer is not installed**. 9It is useless and **shouldn't be used if Ceilometer and Aodh are not installed**.
10 10
11Plugin Configuration 11Plugin Configuration
12-------------------- 12--------------------
@@ -21,29 +21,16 @@ with the `Telemetry service
21 21
22 Go to the *Plugins* tab. You should see the following: 22 Go to the *Plugins* tab. You should see the following:
23 23
24 On Mos 8.0 24 .. image:: images/redis-plugin-on9-0.png
25
26 .. image:: images/redis-plugin.png
27 :width: 100%
28
29 On Mos 7.0
30
31 .. image:: images/redis-plugin-on8-0.png
32 :width: 100% 25 :width: 100%
33 26
342. Enable the plugin. 272. Enable the plugin.
35 28
36 Go to the *Environments* tab and select the *Redis plugin for Ceilometer* checkbox: 29 Go to the *Environments* tab and select the *Redis plugin for Ceilometer* checkbox:
37 30
38 On Mos 8.0 31 .. image:: images/redis-plugin-9-0.png
39
40 .. image:: images/redis-plugin-8-0.png
41 :width: 100% 32 :width: 100%
42 33
43 On Mos 7.0
44
45 .. image:: images/redis-plugin-on.png
46 :width: 100%
47 34
483. Add nodes to your environment to which you will assign the **controller role**. 353. Add nodes to your environment to which you will assign the **controller role**.
49 36
@@ -63,15 +50,15 @@ with the `Telemetry service
63Plugin Verification 50Plugin Verification
64------------------- 51-------------------
65 52
66#. Check that the ceilometer-agent-central and ceilometer-alarm-evaluator services are running 53#. Check that the ceilometer-agent-central and aodh-evaluator services are running
67 on each controller. 54 on each controller.
68 55
69 Run ``pcs resource``. You should see the following in the output:: 56 Run ``http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html`. You should see the following in the output::
70 57
71 Clone Set: clone_p_ceilometer-agent-central [p_ceilometer-agent-central] 58 Clone Set: clone_p_ceilometer-agent-central [p_ceilometer-agent-central]
72 Started: [ node-21.domain.tld node-27.domain.tld node-33.domain.tld ] 59 Started: [ node-21.domain.tld node-27.domain.tld node-33.domain.tld ]
73 60
74 Clone Set: clone_p_ceilometer-alarm-evaluator [p_ceilometer-alarm-evaluator] 61 Clone Set: clone_p_aodh-evaluator [p_aodh-evaluator]
75 Started: [ node-21.domain.tld node-27.domain.tld node-33.domain.tld ] 62 Started: [ node-21.domain.tld node-27.domain.tld node-33.domain.tld ]
76 63
77 The *Started* list should contain all controllers. 64 The *Started* list should contain all controllers.
@@ -104,6 +91,6 @@ Plugin Verification
104#. For the alarm evaluator, it is possible to see that everything works as expected 91#. For the alarm evaluator, it is possible to see that everything works as expected
105 only from the logs:: 92 only from the logs::
106 93
107 # grep extract_my_subset /var/log/ceilometer/ceilometer-alarm-evaluator.log 94 # grep extract_my_subset /var/log/aodh/aodh-evaluator.log
108 95
109 There should be different *My subset: [* results for the ceilometer-alarm-evaluator instances. 96 There should be different *My subset: [* results for the aodh-evaluator instances.
diff --git a/doc/source/images/redis-plugin-8-0.png b/doc/source/images/redis-plugin-8-0.png
deleted file mode 100644
index 680fca9..0000000
--- a/doc/source/images/redis-plugin-8-0.png
+++ /dev/null
Binary files differ
diff --git a/doc/source/images/redis-plugin-9-0.png b/doc/source/images/redis-plugin-9-0.png
new file mode 100644
index 0000000..8e2d86e
--- /dev/null
+++ b/doc/source/images/redis-plugin-9-0.png
Binary files differ
diff --git a/doc/source/images/redis-plugin-on.png b/doc/source/images/redis-plugin-on.png
deleted file mode 100644
index b7c5fb6..0000000
--- a/doc/source/images/redis-plugin-on.png
+++ /dev/null
Binary files differ
diff --git a/doc/source/images/redis-plugin-on8-0.png b/doc/source/images/redis-plugin-on8-0.png
deleted file mode 100644
index d25cc00..0000000
--- a/doc/source/images/redis-plugin-on8-0.png
+++ /dev/null
Binary files differ
diff --git a/doc/source/images/redis-plugin-on9-0.png b/doc/source/images/redis-plugin-on9-0.png
new file mode 100644
index 0000000..bc25795
--- /dev/null
+++ b/doc/source/images/redis-plugin-on9-0.png
Binary files differ
diff --git a/doc/source/images/redis-plugin.png b/doc/source/images/redis-plugin.png
deleted file mode 100644
index bad25b8..0000000
--- a/doc/source/images/redis-plugin.png
+++ /dev/null
Binary files differ
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index aca0aa4..763e0c5 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -18,18 +18,18 @@ To install the *Ceilometer Redis Plugin*, you need to follow these steps.
18 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/intro/intro_fuel_intro.html>`_ 18 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/intro/intro_fuel_intro.html>`_
19 with secure copy (scp):: 19 with secure copy (scp)::
20 20
21 # scp fuel-plugin-ceilometer-redis/ceilometer-redis-1.0-1.0.0-1.noarch.rpm / 21 # scp fuel-plugin-ceilometer-redis/ceilometer-redis-1.0-1.0.3-1.noarch.rpm /
22 root@:<the_Fuel_Master_node_IP address>:/tmp 22 root@:<the_Fuel_Master_node_IP address>:/tmp
23 23
24#. Log into the Fuel Master node and install the plugin:: 24#. Log into the Fuel Master node and install the plugin::
25 25
26 # ssh root@:<the_Fuel_Master_node_IP address> 26 # ssh root@:<the_Fuel_Master_node_IP address>
27 [root@fuel-master ~]# cd /tmp 27 [root@fuel-master ~]# cd /tmp
28 [root@fuel-master ~]# fuel plugins --install ceilometer-redis-1.0-1.0.0-1.noarch.rpm 28 [root@fuel-master ~]# fuel plugins --install ceilometer-redis-1.0-1.0.3-1.noarch.rpm
29 29
30#. Verify that the plugin is installed correctly:: 30#. Verify that the plugin is installed correctly::
31 31
32 [root@fuel-master ~]# fuel plugins list 32 [root@fuel-master ~]# fuel plugins list
33 id | name | version | package_version 33 id | name | version | package_version
34 ---|------------------|---------------|---------------- 34 ---|------------------|---------------|----------------
35 4 | ceilometer-redis | 1.0.2 | 3.0.0 35 4 | ceilometer-redis | 1.0.3 | 3.0.0
diff --git a/metadata.yaml b/metadata.yaml
index 8dd01ff..30412fb 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -3,7 +3,7 @@ name: ceilometer-redis
3# Human-readable name for your plugin 3# Human-readable name for your plugin
4title: Redis plugin for Ceilometer 4title: Redis plugin for Ceilometer
5# Plugin version 5# Plugin version
6version: 1.0.2 6version: 1.0.3
7# Description 7# Description
8description: Ceilometer extension that provides a workload-partitioning and HA for ceilometer services 8description: Ceilometer extension that provides a workload-partitioning and HA for ceilometer services
9# Required fuel version 9# Required fuel version
@@ -11,7 +11,7 @@ fuel_version: ['9.0']
11# Specify license of your plugin 11# Specify license of your plugin
12licenses: ['Apache License Version 2.0'] 12licenses: ['Apache License Version 2.0']
13# Specify author or company name 13# Specify author or company name
14authors: ['Ivan Berezovskiy', 'Ilya Tyaptin'] 14authors: ['Ivan Berezovskiy', 'Ilya Tyaptin', 'Nikita Karpin']
15# A link to the plugin's page 15# A link to the plugin's page
16homepage: 'https://github.com/openstack/fuel-plugin-ceilometer-redis' 16homepage: 'https://github.com/openstack/fuel-plugin-ceilometer-redis'
17# Groups 17# Groups