diff --git a/doc/images/influx_grafana_settings.png b/doc/images/influx_grafana_settings.png deleted file mode 100644 index 882013c2..00000000 Binary files a/doc/images/influx_grafana_settings.png and /dev/null differ diff --git a/doc/images/ldap_auth.png b/doc/images/influx_ldap_settings.png similarity index 100% rename from doc/images/ldap_auth.png rename to doc/images/influx_ldap_settings.png diff --git a/doc/images/influx_main_settings.png b/doc/images/influx_main_settings.png new file mode 100644 index 00000000..4767196e Binary files /dev/null and b/doc/images/influx_main_settings.png differ diff --git a/doc/images/influx_mysql_settings.png b/doc/images/influx_mysql_settings.png new file mode 100644 index 00000000..e01c8aaf Binary files /dev/null and b/doc/images/influx_mysql_settings.png differ diff --git a/doc/images/tls_settings.png b/doc/images/influx_tls_settings.png similarity index 100% rename from doc/images/tls_settings.png rename to doc/images/influx_tls_settings.png diff --git a/doc/source/configure_plugin.rst b/doc/source/configure_plugin.rst index 98016dff..c13fd8d2 100644 --- a/doc/source/configure_plugin.rst +++ b/doc/source/configure_plugin.rst @@ -19,7 +19,7 @@ Plugin configuration :guilabel:`The InfluxDB-Grafana Server Plugin` section. You should see a page like this: - .. image:: ../images/influx_grafana_settings.png + .. image:: ../images/influx_main_settings.png :width: 450pt #. Select :guilabel:`The InfluxDB-Grafana Server Plugin` and fill in the @@ -30,11 +30,16 @@ Plugin configuration 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. #. Specify the Grafana username and password. #. The plugin uses a MySQL database to store its configuration data, such as the dashboard templates. + .. image:: ../images/influx_mysql_settings.png + :width: 450pt + a. Select :guilabel:`Local MySQL` if you want to create the Grafana database using the MySQL server of the OpenStack control plane. Otherwise, select :guilabel:`Remote server` and specify the fully @@ -46,7 +51,7 @@ Plugin configuration Grafana credentials (username, password). Then, fill in the required fields as indicated below. - .. image:: ../images/tls_settings.png + .. image:: ../images/influx_tls_settings.png :width: 450pt 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 indicated below. - .. image:: ../images/ldap_auth.png + .. image:: ../images/influx_ldap_settings.png :width: 450pt 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``. #. Deploy your environment as described in `Deploy an OpenStack environment - `_. \ No newline at end of file + `_. diff --git a/doc/source/release_notes.rst b/doc/source/release_notes.rst index e1e0d384..25c69839 100644 --- a/doc/source/release_notes.rst +++ b/doc/source/release_notes.rst @@ -6,6 +6,17 @@ Release notes 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 `_. +* Fixed the UI issue with the LDAP protocol radio button. See + `#1599778 `_. + Version 0.10.0 ++++++++++++++ diff --git a/doc/source/requirements.rst b/doc/source/requirements.rst index 5151bea3..c0d0f740 100644 --- a/doc/source/requirements.rst +++ b/doc/source/requirements.rst @@ -11,7 +11,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 | +| Mirantis OpenStack | 8.0, 9.0, 9.1 | +-----------------------+------------------------------------------------------------------------+ | 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 |