deb-ceilometer/install-guide/source/get_started.rst
Ildiko Vancsa b33f32b714 Add install-guide for ceilometer
This adds ceilometer-specific contents of the OpenStack Installation Guide
in the ceilometer repo per [1]. A separate change will remove the
ceilometer contents from the OpenStack Installation Guide for Newton per [2].

The ceilometer install-guide structure is based on Install Guide
Cookiecutter [3].

Also adds tox.ini environment for install-guide and adds
openstackdocs-theme to test-requirements.txt.

[1] http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html
[2] http://specs.openstack.org/openstack/docs-specs/specs/newton/installguide.html
[3] https://review.openstack.org/#/c/314229/

Partially-Implements: blueprint projectspecificinstallguide
Change-Id: Iffc5d7243e9eeb74c9dd7b559ef3de7123269293
2016-06-24 15:34:51 +02:00

41 lines
1.6 KiB
ReStructuredText

==========================================
Telemetry Data Collection service overview
==========================================
The Telemetry Data Collection services provide the following functions:
* Efficiently polls metering data related to OpenStack services.
* Collects event and metering data by monitoring notifications sent
from services.
* Publishes collected data to various targets including data stores and
message queues.
The Telemetry service consists of the following components:
A compute agent (``ceilometer-agent-compute``)
Runs on each compute node and polls for resource utilization
statistics. There may be other types of agents in the future, but
for now our focus is creating the compute agent.
A central agent (``ceilometer-agent-central``)
Runs on a central management server to poll for resource utilization
statistics for resources not tied to instances or compute nodes.
Multiple agents can be started to scale service horizontally.
A notification agent (``ceilometer-agent-notification``)
Runs on a central management server(s) and consumes messages from
the message queue(s) to build event and metering data.
A collector (``ceilometer-collector``)
Runs on central management server(s) and dispatches collected
telemetry data to a data store or external consumer without
modification.
An API server (``ceilometer-api``)
Runs on one or more central management servers to provide data
access from the data store.
These services communicate by using the OpenStack messaging bus. Only
the collector and API server have access to the data store.