Update documentation for 1.0

Change-Id: Ic7af094d6a4cd2422369384034808f618d258cf3
This commit is contained in:
Guillaume Thouvenin 2016-10-14 09:01:27 +02:00
parent bbe8ee7550
commit 5f68b8579a
8 changed files with 21 additions and 5 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 180 KiB

View File

Before

Width:  |  Height:  |  Size: 270 KiB

After

Width:  |  Height:  |  Size: 270 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

@ -19,7 +19,7 @@ Plugin configuration
:guilabel:`The InfluxDB-Grafana Server Plugin` section. You should see a :guilabel:`The InfluxDB-Grafana Server Plugin` section. You should see a
page like this: page like this:
.. image:: ../images/influx_grafana_settings.png .. image:: ../images/influx_main_settings.png
:width: 450pt :width: 450pt
#. Select :guilabel:`The InfluxDB-Grafana Server Plugin` and fill in the #. Select :guilabel:`The InfluxDB-Grafana Server Plugin` and fill in the
@ -30,11 +30,16 @@ Plugin configuration
documentation. documentation.
#. Specify the database name (the default is ``lma``). #. Specify the database name (the default is ``lma``).
#. Specify the InfluxDB username and password. #. 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.
#. Specify the Grafana username and password. #. Specify the Grafana username and password.
#. The plugin uses a MySQL database to store its configuration data, such as #. The plugin uses a MySQL database to store its configuration data, such as
the dashboard templates. the dashboard templates.
.. image:: ../images/influx_mysql_settings.png
:width: 450pt
a. Select :guilabel:`Local MySQL` if you want to create the Grafana a. Select :guilabel:`Local MySQL` if you want to create the Grafana
database using the MySQL server of the OpenStack control plane. database using the MySQL server of the OpenStack control plane.
Otherwise, select :guilabel:`Remote server` and specify the fully Otherwise, select :guilabel:`Remote server` and specify the fully
@ -46,7 +51,7 @@ Plugin configuration
Grafana credentials (username, password). Then, fill in the required Grafana credentials (username, password). Then, fill in the required
fields as indicated below. fields as indicated below.
.. image:: ../images/tls_settings.png .. image:: ../images/influx_tls_settings.png
:width: 450pt :width: 450pt
a. Specify the DNS name of the Grafana server. This parameter is used to a. Specify the DNS name of the Grafana server. This parameter is used to
@ -59,7 +64,7 @@ Plugin configuration
authenticate to Grafana through LDAP. Then, fill in the required fields as authenticate to Grafana through LDAP. Then, fill in the required fields as
indicated below. indicated below.
.. image:: ../images/ldap_auth.png .. image:: ../images/influx_ldap_settings.png
:width: 450pt :width: 450pt
a. Select :guilabel:`LDAPS` if you want to enable LDAP authentication over a. Select :guilabel:`LDAPS` if you want to enable LDAP authentication over
@ -144,4 +149,4 @@ Plugin configuration
* At least 30 GB for the InfluxDB database in ``/var/lib/influxdb``. * At least 30 GB for the InfluxDB database in ``/var/lib/influxdb``.
#. Deploy your environment as described in `Deploy an OpenStack environment #. Deploy your environment as described in `Deploy an OpenStack environment
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_. <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.

View File

@ -6,6 +6,17 @@ Release notes
Version 1.0.0 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
by default.
* Updated the documentation to emphasize the need to use fast disks like an
SSD.
* Added support for wildcard SSL certificates. See
`#1608665 <https://bugs.launchpad.net/lma-toolchain/+bug/1608665>`_.
* Fixed the UI issue with the LDAP protocol radio button. See
`#1599778 <https://bugs.launchpad.net/lma-toolchain/+bug/1599778>`_.
Version 0.10.0 Version 0.10.0
++++++++++++++ ++++++++++++++

View File

@ -11,7 +11,7 @@ Requirements
| | Therefore, the installation of the plugin will fail if there is less | | | Therefore, the installation of the plugin will fail if there is less |
| | than 55 GB of disk space available on the node. | | | than 55 GB of disk space available on the node. |
+-----------------------+------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+
| Mirantis OpenStack | 8.0, 9.0 | | Mirantis OpenStack | 8.0, 9.0, 9.1 |
+-----------------------+------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+
| Hardware configuration| The hardware configuration (RAM, CPU, disk(s)) required by this plugin | | 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 | | | depends on the size of your cloud environment and other factors like |