[Docs] Minor edits

Editorial changes.

Change-Id: I7a3c899ed46a2b1589b64925c6134c20fa2573ec
This commit is contained in:
Maria Zlatkova 2016-10-11 14:40:22 +03:00
parent 46a8749663
commit 7b7392b6b4
4 changed files with 32 additions and 33 deletions

View File

@ -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

View File

@ -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`

View File

@ -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 <https://github.com/openstack/fuel-plugin-ceilometer-redis>`_.
* The OpenStack Telemetry plugin cannot be used if the
`Redis plugin <https://github.com/openstack/fuel-plugin-ceilometer-redis>`_
is already enabled in the environment.

View File

@ -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: