[config-ref] Convert telemetry sample-files.xml

Change-Id: I432219d7c9c4a4bc560914818a870fae632e368c
Implements: blueprint config-ref-rst
This commit is contained in:
Gauvain Pocentek 2015-11-30 19:59:13 +01:00
parent ca1bff63b1
commit 769b0cd563
2 changed files with 70 additions and 0 deletions

View File

@ -13,4 +13,5 @@ distribution (`docs.openstack.org <http://docs.openstack.org>`__).
telemetry/telemetry_service_config_opts.rst
telemetry/alarming_service_config_opts.rst
telemetry/sample-configuration-files.rst
tables/conf-changes/ceilometer.rst

View File

@ -0,0 +1,69 @@
====================================
Telemetry sample configuration files
====================================
All the files in this section can be found in the ``/etc/ceilometer/``
directory.
ceilometer.conf
~~~~~~~~~~~~~~~
The configuration for the Telemetry services and agents is found in the
``ceilometer.conf`` file.
This file must be modified after installation.
.. literalinclude:: ../../../common/samples/ceilometer.conf
:language: ini
event_definitions.yaml
~~~~~~~~~~~~~~~~~~~~~~
The ``event_definitions.yaml`` file defines how events received from
other OpenStack components should be translated to Telemetry events.
This file provides a standard set of events and corresponding traits
that may be of interest. This file can be modified to add and drop
traits that operators may find useful.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml?h=stable/liberty
pipeline.yaml
~~~~~~~~~~~~~
Pipelines describe a coupling between sources of samples and the
corresponding sinks for transformation and publication of the data. They
are defined in the ``pipeline.yaml`` file.
This file can be modified to adjust polling intervals and the samples
generated by the Telemetry module.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml?h=stable/liberty
event_pipeline.yaml
~~~~~~~~~~~~~~~~~~~
Event pipelines describe a coupling between notification event_types
and the corresponding sinks for publication of the event data. They are
defined in the ``event_pipeline.yaml`` file.
This file can be modified to adjust which notifications to capture and
where to publish the events.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_pipeline.yaml?h=stable/liberty
policy.json
~~~~~~~~~~~
The ``policy.json`` file defines additional access controls that apply
to the Telemetry service.
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/policy.json?h=stable/liberty