From 7b7392b6b4fd25271847301c7cbe9685620b8433 Mon Sep 17 00:00:00 2001 From: Maria Zlatkova Date: Tue, 11 Oct 2016 14:40:22 +0300 Subject: [PATCH] [Docs] Minor edits Editorial changes. Change-Id: I7a3c899ed46a2b1589b64925c6134c20fa2573ec --- docs/source/configure.rst | 10 +++++----- docs/source/intro.rst | 17 ++++++++--------- docs/source/limitations.rst | 22 +++++++++++----------- docs/source/requirements.rst | 16 ++++++++-------- 4 files changed, 32 insertions(+), 33 deletions(-) diff --git a/docs/source/configure.rst b/docs/source/configure.rst index c513b9f..677dce4 100644 --- a/docs/source/configure.rst +++ b/docs/source/configure.rst @@ -29,13 +29,13 @@ Once installed, configure the OpenStack Telemetry plugin. .. image:: images/advanced_settings.png :width: 450pt - If selected, configure Elasticsearch that stores Ceilometer events and - resources: + Once selected, configure the Elasticsearch cluster that stores Ceilometer + events and resources: * Select :guilabel:`Use local Elasticsearch` if you have deployed the Elasticsearch-Kibana plugin. * Otherwise, select :guilabel:`Use External Elasticsearch` and define the - IP and port for the Elasticsearch you want to use. + IP or DNS name and port for the Elasticsearch cluster you want to use. #. Configure InfluxDB: @@ -46,9 +46,9 @@ Once installed, configure the OpenStack Telemetry plugin. InfluxDB-Grafana plugin. * Otherwise, select :guilabel:`Use External InfluxDB` and define the IP or DNS name, port, database name, username, and password for the - Elasticsearch you want to use to keep the Ceilometer-related data. + InfluxDB server you want to use to store the Ceilometer-related data. -#. Configure additional metadata to be kept along with Ceilometer samples in +#. Configure additional metadata to be stored along with Ceilometer samples in InfluxDB: .. image:: images/metadata.png diff --git a/docs/source/intro.rst b/docs/source/intro.rst index 05a3523..4636378 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -4,9 +4,11 @@ Introduction ------------ The OpenStack Telemetry plugin collects metrics about OpenStack resources and -provides this data through Ceilometer API. This plugin implements all -Ceilometer functionality except complex queries with InfluxDB and Elasticsearch -as back ends for samples and events. +provides this data through the Ceilometer API. By default, the plugin supports +only sample and statistics API. However, you can enable full Ceilometer API +support. The OpenStack Telemetry plugin implements all the Ceilometer +functionality except complex queries with InfluxDB and Elasticsearch as back +ends for samples and events. The OpenStack Telemetry plugin uses the following Ceilometer components: @@ -14,14 +16,14 @@ The OpenStack Telemetry plugin uses the following Ceilometer components: * Notification agent * Ceilometer API agent -Ceilometer Collector is not used. Instead, the Telemetry plugin uses its own +Ceilometer collector is not used. Instead, the Telemetry plugin uses its own tools to collect telemetry data from the Ceilometer agents. The Telemetry plugin provides a better functionality if deployed together with the Kafka plugin. In this case, the Telemetry plugin configures Kafka as a message bus for the Ceilometer agents and OpenStack services still send -notifications to RabbitMQ. To process this correctly, Ceilometer notification -agent listens to Kafka and RabbitMQ simultaneously. +notifications to RabbitMQ. To process this correctly, the Ceilometer +notification agent listens to Kafka and RabbitMQ simultaneously. However, the Telemetry plugin works without Kafka as well, but there are some scalability limitations. For more information, see :ref:`limitations`. @@ -37,9 +39,6 @@ We recommend installing the Telemetry plugin along with the StackLight plugins. In this case, the Telemetry plugin will use the same databases as StackLight: InfluxDB and Elasticsearch. Otherwise, you can configure external storages. -By default, the OpenStack Telemetry plugin supports only sample and statistics -API. However, you can enable full Ceilometer API support. - .. seealso:: * :ref:`architecture` \ No newline at end of file diff --git a/docs/source/limitations.rst b/docs/source/limitations.rst index 194b9ad..6061ac0 100644 --- a/docs/source/limitations.rst +++ b/docs/source/limitations.rst @@ -13,12 +13,12 @@ The OpenStack Telemetry plugin for Fuel has the following limitations: * ``ceilometer sample-list`` * ``ceilometer statistics`` - * If :guilabel:`Resource API` is enabled: + * If the :guilabel:`Resource API` is enabled: * ``ceilometer resource-list`` * ``ceilometer meter-list`` - * If :guilabel:`Event API` is enabled: + * If the :guilabel:`Event API` is enabled: * ``ceilometer event-list`` @@ -27,8 +27,7 @@ The OpenStack Telemetry plugin for Fuel has the following limitations: are not supported. * The Telemetry plugin does not store all the OpenStack resources metadata - along with Ceilometer Samples in InfluxDB. Using the Fuel web UI, you can - configure the list of metadata. The default values are as follows: + along with the Ceilometer Samples. The default list is as follows: | ``status`` | ``deleted`` @@ -49,14 +48,15 @@ The OpenStack Telemetry plugin for Fuel has the following limitations: | ``state`` | ``user_metadata.stack`` - To use Ceilometer API requests based on metadata, add the required metadata - as described in :ref:`configure`. + To use the Ceilometer API requests based on metadata, add the required + metadata as described in :ref:`configure`. -* Coordination for Ceilometer central agent and Aodh alarm evaluator services - are switched off if RabbitMQ is used. The Telemetry plugin is based on - the Ceilometer used in Mirantis OpenStack. Therefore, the notification +* The coordination for Ceilometer central agent and Aodh alarm evaluator + services is switched off if RabbitMQ is used. The Telemetry plugin is based + on the Ceilometer used in Mirantis OpenStack. Therefore, the notification agents do not require coordination. The coordination through tooz with Zookeeper back end is supported if the Kafka plugin is installed. -* The OpenStack Telemetry plugin is incompatible with the - `Redis plugin `_. \ No newline at end of file +* The OpenStack Telemetry plugin cannot be used if the + `Redis plugin `_ + is already enabled in the environment. \ No newline at end of file diff --git a/docs/source/requirements.rst b/docs/source/requirements.rst index 3772e37..7529ad7 100644 --- a/docs/source/requirements.rst +++ b/docs/source/requirements.rst @@ -11,7 +11,7 @@ Requirement Version/Comment Fuel 9.0 on Mitaka ======================= ================================= -If you use external storages: +If you use external back ends: +----------------------------------+-----------------------------------------+ | Requirement | Version/Comment | @@ -32,13 +32,13 @@ The OpenStack Telemetry plugin is compatible with the following plugins: * To install the back-end services automatically, use the following StackLight plugins: - ============================ ====================================== - Plugin Version/Comment - ============================ ====================================== - StackLight InfluxDB-Grafana 0.10.0 or newer - StackLight ES-Kibana 0.10.2 or newer. If Resource API - is disabled, the version may be 0.10.0 - ============================ ====================================== + =============================== ====================================== + Plugin Version/Comment + =============================== ====================================== + StackLight InfluxDB-Grafana 0.10.0 or newer + StackLight Elasticsearch-Kibana 0.10.2 or newer. If the Resource API + is disabled, the version may be 0.10.0 + =============================== ====================================== * To use Kafka as a message queue, install: