Browse Source

Docs and version are updated for MOS 9.0 compatibility

Change-Id: I757ee2599758aea94addd0c087b038259703a2e3
Nadya Shakhat 2 years ago
parent
commit
e8e20c95fa

+ 1
- 1
doc/source/conf.py View File

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

+ 17
- 15
doc/source/description.rst View File

@@ -5,11 +5,13 @@ The *Ceilometer Redis Plugin* installs `Redis <http://redis.io>`_ and
5 5
 the `Tooz library <http://docs.openstack.org/developer/tooz/>`_, in a
6 6
 Mirantis OpenStack (MOS) environment deployed by Fuel.
7 7
 Both Redis and the Tooz library should be installed on all the controller
8
-nodes of the environment.
8
+nodes of the environment. Starting from MOS 9.0, Ceilometer alarming service was
9
+moved to the project called Aodh.
10
+
9 11
 
10 12
 The *Ceilometer Redis Plugin* is used to provide coordination mechanisms to
11
-enable the horizontal scaling of the Ceilometer services. Using the plugin,
12
-the Ceilometer services are joined into a so-called **coordination group**,
13
+enable the horizontal scaling of the Ceilometer/Aodh services. Using the plugin,
14
+the Ceilometer/Aodh services are joined into a so-called **coordination group**,
13 15
 which allows for resources and alarms sharding.
14 16
 There is one coordination group per service type.
15 17
 
@@ -17,7 +19,7 @@ Please refer to the `Telemetry architecture
17 19
 <http://docs.openstack.org/admin-guide/telemetry-system-architecture.html>`_
18 20
 documentation for more information about the Ceilometer services.
19 21
 
20
-In MOS 7.0 and MOS 8.0, the *Ceilometer Redis Plugin* enables coordination
22
+In MOS 9.0, the *Ceilometer Redis Plugin* enables coordination
21 23
 for both:
22 24
 
23 25
   * The **ceilometer-agent-central service**.
@@ -34,20 +36,20 @@ for both:
34 36
     across multiple instances of the ceilometer-agent-central using disjoint sets
35 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.
40
-    By default, there is only one ceilometer-alarm-evaluator running per environment.
41
-    Without coordination, there can be only one ceilometer-alarm-evaluator running at a time.
42
-    This is because, as for the ceilometer-agent-central, the ceilometer-alarm-evaluator works
43
-    with an entire set of alarms. Running multiple ceilometer-alarm-evaluator
41
+    The **aodh-evaluator** service is responsible for evaluating the Ceilometer alarms.
42
+    By default, there is only one aodh-evaluator running per environment.
43
+    Without coordination, there can be only one aodh-evaluator running at a time.
44
+    This is because, as for the ceilometer-agent-central, the aodh-evaluator works
45
+    with an entire set of alarms. Running multiple aodh-evaluator
44 46
     without coordination would evaluate all the alarms as many times as the number of evaluators
45 47
     running on the controller nodes every evaluation interval. To cope with this problem,
46 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 50
     using disjoint sets of alarms.
49 51
 
50
-Please note that with MOS 8.0, the *Ceilometer Redis Plugin* doesn't provide support
52
+Please note that starting from MOS 8.0, the *Ceilometer Redis Plugin* doesn't provide support
51 53
 (out-of-the-box) for the coordination of the **ceilometer-agent-notification** service because
52 54
 it 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 58
    In Liberty, the transformation of the samples was moved
57 59
    to the **ceilometer-agent-notification** service, but after thorough performance analysis
58 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 62
    to the ceilometer-agent-compute service.
61 63
 
62 64
    * cpu_util
@@ -72,7 +74,7 @@ it is not needed for the most common samples transformations.
72 74
    * network.incoming.packets.rate
73 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 78
    in coordination mode unless you need to maintain the transformation of custom samples that
77 79
    are not listed above. In this case, it is possible to enable coordination for the
78 80
    ceilometer-agent-notification service manually event though, it is not recommended
@@ -93,7 +95,7 @@ Requirements
93 95
 ======================= ================
94 96
 Requirements            Version/Comment
95 97
 ======================= ================
96
-MOS                     7.0, 8.0
98
+MOS                     9.0
97 99
 Tooz                    <0.14.0,>=0.13.1
98 100
 ======================= ================
99 101
 

+ 10
- 23
doc/source/guide.rst View File

@@ -3,10 +3,10 @@ User Guide
3 3
 
4 4
 Once the *Ceilometer Redis Plugin* is installed following the instructions of
5 5
 the :ref:`Installation Guide`, you can create a Mirantis OpenStack (MOS) environment
6
-with Ceilometer whose **ceilometer-agent-central** and **ceilometer-alarm-evaluator**
6
+with Ceilometer and Aodh whose **ceilometer-agent-central** and **aodh-evaluator**
7 7
 services will work in **workload partitioned** mode.
8
-This plugin was created to enable the scale-out of these Ceilometer services.
9
-It is useless and **shouldn't be used if Ceilometer is not installed**.
8
+This plugin was created to enable the scale-out of these Ceilometer/Aodh services.
9
+It is useless and **shouldn't be used if Ceilometer and Aodh are not installed**.
10 10
 
11 11
 Plugin Configuration
12 12
 --------------------
@@ -21,29 +21,16 @@ with the `Telemetry service
21 21
 
22 22
    Go to the *Plugins* tab. You should see the following:
23 23
 
24
-   On Mos 8.0
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
24
+   .. image:: images/redis-plugin-on9-0.png
32 25
     :width: 100%
33 26
 
34 27
 2. Enable the plugin.
35 28
 
36 29
    Go to the *Environments* tab and select the *Redis plugin for Ceilometer* checkbox:
37 30
 
38
-   On Mos 8.0
39
-
40
-   .. image:: images/redis-plugin-8-0.png
31
+   .. image:: images/redis-plugin-9-0.png
41 32
     :width: 100%
42 33
 
43
-   On Mos 7.0
44
-
45
-   .. image:: images/redis-plugin-on.png
46
-    :width: 100%
47 34
 
48 35
 3.  Add nodes to your environment to which you will assign the **controller role**.
49 36
 
@@ -63,15 +50,15 @@ with the `Telemetry service
63 50
 Plugin 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 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 58
      Clone Set: clone_p_ceilometer-agent-central [p_ceilometer-agent-central]
72 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 62
        Started: [ node-21.domain.tld node-27.domain.tld node-33.domain.tld ]
76 63
 
77 64
    The *Started* list should contain all controllers.
@@ -104,6 +91,6 @@ Plugin Verification
104 91
 #. For the alarm evaluator, it is possible to see that everything works as expected
105 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.

BIN
doc/source/images/redis-plugin-8-0.png View File


BIN
doc/source/images/redis-plugin-9-0.png View File


BIN
doc/source/images/redis-plugin-on.png View File


BIN
doc/source/images/redis-plugin-on8-0.png View File


BIN
doc/source/images/redis-plugin-on9-0.png View File


BIN
doc/source/images/redis-plugin.png View File


+ 3
- 3
doc/source/installation.rst View File

@@ -18,18 +18,18 @@ To install the *Ceilometer Redis Plugin*, you need to follow these steps.
18 18
    <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide/intro/intro_fuel_intro.html>`_
19 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 22
      root@:<the_Fuel_Master_node_IP address>:/tmp
23 23
 
24 24
 #. Log into the Fuel Master node and install the plugin::
25 25
 
26 26
     # ssh root@:<the_Fuel_Master_node_IP address>
27 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 30
 #. Verify that the plugin is installed correctly::
31 31
 
32 32
     [root@fuel-master ~]# fuel plugins list
33 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

+ 2
- 2
metadata.yaml View File

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

Loading…
Cancel
Save