From 769b0cd5635dcdfcb1ba131f39817dcfa1251187 Mon Sep 17 00:00:00 2001
From: Gauvain Pocentek <gauvain.pocentek@objectif-libre.com>
Date: Mon, 30 Nov 2015 19:59:13 +0100
Subject: [PATCH] [config-ref] Convert telemetry sample-files.xml

Change-Id: I432219d7c9c4a4bc560914818a870fae632e368c
Implements: blueprint config-ref-rst
---
 doc/config-ref-rst/source/telemetry.rst       |  1 +
 .../telemetry/sample-configuration-files.rst  | 69 +++++++++++++++++++
 2 files changed, 70 insertions(+)
 create mode 100644 doc/config-ref-rst/source/telemetry/sample-configuration-files.rst

diff --git a/doc/config-ref-rst/source/telemetry.rst b/doc/config-ref-rst/source/telemetry.rst
index 7a9d5190d4..3b54a9b743 100644
--- a/doc/config-ref-rst/source/telemetry.rst
+++ b/doc/config-ref-rst/source/telemetry.rst
@@ -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
diff --git a/doc/config-ref-rst/source/telemetry/sample-configuration-files.rst b/doc/config-ref-rst/source/telemetry/sample-configuration-files.rst
new file mode 100644
index 0000000000..18e374c3ae
--- /dev/null
+++ b/doc/config-ref-rst/source/telemetry/sample-configuration-files.rst
@@ -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