Browse Source

Add limitation about an odd controllers number

The plugin may work correctly if installation contains an
odd number of controllers. Add this fact to the docs.
Also, change the plugin version to 1.0-1.0.0-1

Change-Id: Ibf59e3a4b0a624c6936abb84f8f35578fe4e3dd4
Nadya Shakhat 3 years ago
parent
commit
8c37182067
3 changed files with 20 additions and 4 deletions
  1. 9
    1
      doc/content/description.rst
  2. 6
    0
      doc/content/guide.rst
  3. 5
    3
      doc/content/installation.rst

+ 9
- 1
doc/content/description.rst View File

@@ -24,12 +24,20 @@ Fuel                    7.0
24 24
 tooz                    <0.14.0,>=0.13.1
25 25
 ======================= ================
26 26
 
27
+.. _limitations:
28
+
27 29
 Limitations
28 30
 -----------
29 31
 
30
-* The plugin version 1.0.0 provides coordination only for Agent Central service.
32
+* The plugin version 1.0-1.0.0-1 provides coordination only for Agent Central service.
31 33
   Alarm evaluator and Notification agent will be supported in the next plugin
32 34
   version.
33 35
 
36
+* The plugin works correctly only on clouds with odd numbers of controllers.
37
+  This requirement is mandatory because Redis needs an odd number of nodes to
38
+  choose the master successfully.
39
+
34 40
 .. include:: installation.rst
35 41
 .. include:: guide.rst
42
+
43
+

+ 6
- 0
doc/content/guide.rst View File

@@ -28,6 +28,12 @@ Plugin configuration
28 28
    .. image:: images/redis-plugin-on.png
29 29
     :width: 100%
30 30
 
31
+#. When
32
+   `adding nodes to environment and assigning roles to them <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#add-nodes-ug>`_, please consider using odd number of controllers as mentioned in `Limitations`_.
33
+
34
+#. Finish
35
+   `environment configuration <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#configure-your-environment>`_
36
+
31 37
 #. Run `network verification check <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#verify-networks>`_.
32 38
 
33 39
 #. Press `Deploy button <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_ to once you are done with environment configuration.

+ 5
- 3
doc/content/installation.rst View File

@@ -7,6 +7,8 @@ Install the Plugin
7 7
 
8 8
 To install the Redis plugin:
9 9
 
10
+#. Please refer to `Limitations`_ before you proceed.
11
+
10 12
 #. Download the Redis plugin from the
11 13
    `Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
12 14
 
@@ -27,9 +29,9 @@ To install the Redis plugin:
27 29
 #. Verify that the plugin is installed correctly::
28 30
 
29 31
      [root@fuel-master ~]# fuel plugins list
30
-     id | name             | version | package_version
31
-     ---|------------------|---------|----------------
32
-     4  | ceilometer-redis | 1.0.0   | 2.0.0
32
+     id | name             | version       | package_version
33
+     ---|------------------|---------------|----------------
34
+     4  | ceilometer-redis | 1.0.0         | 2.0.0
33 35
 
34 36
 
35 37
 

Loading…
Cancel
Save