openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] reorganize Telemetry sample configuration files

Browse Source 
Change-Id: Ic25175acf79ba1aa921516ffb1784972b98c7621
This commit is contained in:
KATO Tomoyuki 2016-07-02 05:29:17 +00:00
parent 868a6564c8
commit 26cda19a35
8 changed files with 78 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/config-reference/source/telemetry.rst
View File

@ -7,7 +7,7 @@ Telemetry service
telemetry/telemetry_service_config_opts.rst
telemetry/alarming_service_config_opts.rst
telemetry/logs.rst
telemetry/sample-configuration-files.rst
telemetry/samples/index.rst
tables/conf-changes/aodh.rst
tables/conf-changes/ceilometer.rst

69
doc/config-reference/source/telemetry/sample-configuration-files.rst
View File

@ -1,69 +0,0 @@
====================================
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:: ../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/mitaka
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/mitaka
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/mitaka
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/mitaka

11
doc/config-reference/source/telemetry/samples/ceilometer.conf.rst Normal file
View File

@ -0,0 +1,11 @@
===============
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:: ../../samples/ceilometer.conf
:language: ini

14
doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst Normal file
View File

@ -0,0 +1,14 @@
======================
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/mitaka

14
doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst Normal file
View File

@ -0,0 +1,14 @@
===================
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/mitaka

14
doc/config-reference/source/telemetry/samples/index.rst Normal file
View File

@ -0,0 +1,14 @@
====================================
Telemetry sample configuration files
====================================
All the files in this section can be found in the ``/etc/ceilometer/``
directory.
.. toctree::
ceilometer.conf.rst
event_definitions.yaml.rst
pipeline.yaml.rst
event_pipeline.yaml.rst
policy.json.rst

14
doc/config-reference/source/telemetry/samples/pipeline.yaml.rst Normal file
View File

@ -0,0 +1,14 @@
=============
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/mitaka

10
doc/config-reference/source/telemetry/samples/policy.json.rst Normal file
View File

@ -0,0 +1,10 @@
===========
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/mitaka