diff --git a/doc/source/configure_plugin.rst b/doc/source/configure_plugin.rst index c13fd8d2..1ca7798e 100644 --- a/doc/source/configure_plugin.rst +++ b/doc/source/configure_plugin.rst @@ -16,22 +16,22 @@ Plugin configuration :guilabel:`Other` category. #. Scroll down through the settings until you find - :guilabel:`The InfluxDB-Grafana Server Plugin` section. You should see a - page like this: + :guilabel:`The StackLight InfluxDB-Grafana Server Plugin` section: .. image:: ../images/influx_main_settings.png :width: 450pt -#. Select :guilabel:`The InfluxDB-Grafana Server Plugin` and fill in the - required fields as indicated below. +#. Select :guilabel:`The StackLight InfluxDB-Grafana Server Plugin` and fill + in the required fields as indicated below. a. Specify the number of days of retention for your data. #. Specify the InfluxDB admin password (called root password in the InfluxDB - documentation. + documentation). #. Specify the database name (the default is ``lma``). #. Specify the InfluxDB username and password. - #. You can use the temporary file storage to store Write-Ahead-Log files in - memory instead of disk. This improve performance but data can be lost. + #. To store the Write-Ahead-Log files in a temporary file storage instead + of the disk, select :guilabel:`Store WAL files in memory`. This will + improve performance but the data can be lost. #. Specify the Grafana username and password. #. The plugin uses a MySQL database to store its configuration data, such as diff --git a/doc/source/index.rst b/doc/source/index.rst index 95392568..a09be02c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,8 +16,8 @@ Overview licenses references -Installing and configuring StackLight InfluxDB-Grafana plugin -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Installing and configuring the StackLight InfluxDB-Grafana plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 1 @@ -26,8 +26,8 @@ Installing and configuring StackLight InfluxDB-Grafana plugin configure_plugin verification -Using StackLight InfluxDB-Grafana plugin -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Using StackLight the InfluxDB-Grafana plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 1 diff --git a/doc/source/install.rst b/doc/source/install.rst index 4fc513a2..07964f02 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -118,9 +118,17 @@ 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-influxdb-grafana/*.noarch.rpm + [root@fuel ~] fuel plugins --install ./fuel-plugin-influxdb-grafana/*.noarch.rpm + +#. Verify that the plugin is installed correctly: + + .. code-block:: console + + [root@fuel ~]# fuel plugins --list + id | name | version | package_version + ---|----------------------|---------|---------------- + 1 | influxdb_grafana | 1.0.0 | 4.0.0 \ No newline at end of file diff --git a/doc/source/licenses.rst b/doc/source/licenses.rst index f1789a06..7d3c5d02 100644 --- a/doc/source/licenses.rst +++ b/doc/source/licenses.rst @@ -1,9 +1,5 @@ .. _licenses: -.. raw:: latex - - \pagebreak - Licenses -------- diff --git a/doc/source/release_notes.rst b/doc/source/release_notes.rst index 25c69839..b62344b2 100644 --- a/doc/source/release_notes.rst +++ b/doc/source/release_notes.rst @@ -8,10 +8,10 @@ Version 1.0.0 The StackLight InfluxDB-Grafana plugin 1.0.0 contains the following updates: -* Add an option to store the InfluxDB WAL in memory. This option is disabled +* Added an option to store the InfluxDB WAL in memory. This option is disabled by default. -* Updated the documentation to emphasize the need to use fast disks like an - SSD. +* Updated the documentation to emphasize the need to use fast disks, such as + SSDs. * Added support for wildcard SSL certificates. See `#1608665 `_. * Fixed the UI issue with the LDAP protocol radio button. See diff --git a/doc/source/requirements.rst b/doc/source/requirements.rst index c0d0f740..60d8217c 100644 --- a/doc/source/requirements.rst +++ b/doc/source/requirements.rst @@ -3,6 +3,8 @@ Requirements ------------ +The StackLight InfluxDB-Grafana plugin 1.0.0 has the following requirements: + +-----------------------+------------------------------------------------------------------------+ | **Requirement** | **Version/Comment** | +=======================+========================================================================+ @@ -11,7 +13,7 @@ Requirements | | Therefore, the installation of the plugin will fail if there is less | | | than 55 GB of disk space available on the node. | +-----------------------+------------------------------------------------------------------------+ -| Mirantis OpenStack | 8.0, 9.0, 9.1 | +| Mirantis OpenStack | 8.0, 9.x | +-----------------------+------------------------------------------------------------------------+ | Hardware configuration| The hardware configuration (RAM, CPU, disk(s)) required by this plugin | | | depends on the size of your cloud environment and other factors like |