From 8c37182067063a8d34b88961d7dfce8b7c17c5ad Mon Sep 17 00:00:00 2001 From: Nadya Shakhat Date: Thu, 19 Nov 2015 17:13:52 +0300 Subject: [PATCH] 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 --- doc/content/description.rst | 10 +++++++++- doc/content/guide.rst | 6 ++++++ doc/content/installation.rst | 8 +++++--- 3 files changed, 20 insertions(+), 4 deletions(-) diff --git a/doc/content/description.rst b/doc/content/description.rst index 2a219cd..ddd931d 100644 --- a/doc/content/description.rst +++ b/doc/content/description.rst @@ -24,12 +24,20 @@ Fuel 7.0 tooz <0.14.0,>=0.13.1 ======================= ================ +.. _limitations: + Limitations ----------- -* The plugin version 1.0.0 provides coordination only for Agent Central service. +* The plugin version 1.0-1.0.0-1 provides coordination only for Agent Central service. Alarm evaluator and Notification agent will be supported in the next plugin version. +* The plugin works correctly only on clouds with odd numbers of controllers. + This requirement is mandatory because Redis needs an odd number of nodes to + choose the master successfully. + .. include:: installation.rst .. include:: guide.rst + + diff --git a/doc/content/guide.rst b/doc/content/guide.rst index e91f88a..ba428fb 100644 --- a/doc/content/guide.rst +++ b/doc/content/guide.rst @@ -28,6 +28,12 @@ Plugin configuration .. image:: images/redis-plugin-on.png :width: 100% +#. When + `adding nodes to environment and assigning roles to them `_, please consider using odd number of controllers as mentioned in `Limitations`_. + +#. Finish + `environment configuration `_ + #. Run `network verification check `_. #. Press `Deploy button `_ to once you are done with environment configuration. diff --git a/doc/content/installation.rst b/doc/content/installation.rst index 9715e29..0fb6742 100644 --- a/doc/content/installation.rst +++ b/doc/content/installation.rst @@ -7,6 +7,8 @@ Install the Plugin To install the Redis plugin: +#. Please refer to `Limitations`_ before you proceed. + #. Download the Redis plugin from the `Fuel Plugins Catalog `_. @@ -27,9 +29,9 @@ To install the Redis plugin: #. Verify that the plugin is installed correctly:: [root@fuel-master ~]# fuel plugins list - id | name | version | package_version - ---|------------------|---------|---------------- - 4 | ceilometer-redis | 1.0.0 | 2.0.0 + id | name | version | package_version + ---|------------------|---------------|---------------- + 4 | ceilometer-redis | 1.0.0 | 2.0.0