From c05f78da0006e52df8387ac1d8ca58aed2f6700d Mon Sep 17 00:00:00 2001 From: Maria Zlatkova Date: Tue, 18 Oct 2016 14:07:46 +0300 Subject: [PATCH] [Docs] Edits Adds some editorial changes to the docs. Change-Id: Ib67b22b2ccbb371bc1c3fa59c9fb36381a928614 --- doc/source/install.rst | 20 ++++++++++++++------ doc/source/requirements.rst | 6 +++--- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/doc/source/install.rst b/doc/source/install.rst index c588cb9..a32a64c 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -23,7 +23,7 @@ Infrastructure Alerting plugin: Install using the RPM file -------------------------- -**To install the StackLight Infrastructure Alerting Plugin using the RPM file +**To install the StackLight Infrastructure Alerting plugin using the RPM file of the Fuel plugins catalog:** #. Go to the `Fuel Plugins Catalog `_. @@ -66,7 +66,7 @@ customize the plugin. .. note:: Running a Fuel plugin that you built yourself is at your own risk and will not be supported. -To install the StackLight Infrastructure Alerting Plugin from source, first +To install the StackLight Infrastructure Alerting plugin from source, first prepare an environment to build the RPM file. The recommended approach is to build the RPM file directly onto the Fuel Master node, so that you will not have to copy that file later on. @@ -119,9 +119,17 @@ have to copy that file later on. **To install the plugin:** -Now that you have created the RPM file, install the plugin using the -:command:`fuel plugins --install` command: +#. Once you have created the RPM file, install the plugin: -.. code-block:: console + .. code-block:: console - [root@fuel ~] fuel plugins --install ./fuel-plugin-lma-infrastructure-alerting/*.rpm + [root@fuel ~] fuel plugins --install ./fuel-plugin-lma-infrastructure-alerting/*.rpm + +#. Verify that the plugin is installed correctly: + + .. code-block:: console + + [root@fuel ~]# fuel plugins --list + id | name | version | package_version + ---|-----------------------------|---------|---------------- + 1 | lma_infrastructure_alerting | 1.0.0 | 4.0.0 diff --git a/doc/source/requirements.rst b/doc/source/requirements.rst index 881df66..dbf14c5 100644 --- a/doc/source/requirements.rst +++ b/doc/source/requirements.rst @@ -23,12 +23,12 @@ requirements: | | A typical setup would at least require a quad-core server with 8 GB of RAM and fast disks| | | (ideally, SSDs). | +------------------------+------------------------------------------------------------------------------------------+ -| Mirantis OpenStack | 8.0, 9.0 | +| Mirantis OpenStack | 8.0, 9.x | +------------------------+------------------------------------------------------------------------------------------+ -| The StackLight | 0.10 | +| The StackLight | 1.0 | | Collector Plugin | | +------------------------+------------------------------------------------------------------------------------------+ -| The StackLight InfluxDB| 0.10 | +| The StackLight InfluxDB| 1.0 | | Grafana Plugin | | | | This is optional and only needed if you want to create alarms in Nagios for | | | time-series stored in InfluxDB. |