From 26cda19a35f25940f5b866d52dc4e59ccb88df38 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sat, 2 Jul 2016 05:29:17 +0000 Subject: [PATCH] [config-ref] reorganize Telemetry sample configuration files Change-Id: Ic25175acf79ba1aa921516ffb1784972b98c7621 --- doc/config-reference/source/telemetry.rst | 2 +- .../telemetry/sample-configuration-files.rst | 69 ------------------- .../telemetry/samples/ceilometer.conf.rst | 11 +++ .../samples/event_definitions.yaml.rst | 14 ++++ .../telemetry/samples/event_pipeline.yaml.rst | 14 ++++ .../source/telemetry/samples/index.rst | 14 ++++ .../telemetry/samples/pipeline.yaml.rst | 14 ++++ .../source/telemetry/samples/policy.json.rst | 10 +++ 8 files changed, 78 insertions(+), 70 deletions(-) delete mode 100644 doc/config-reference/source/telemetry/sample-configuration-files.rst create mode 100644 doc/config-reference/source/telemetry/samples/ceilometer.conf.rst create mode 100644 doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst create mode 100644 doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst create mode 100644 doc/config-reference/source/telemetry/samples/index.rst create mode 100644 doc/config-reference/source/telemetry/samples/pipeline.yaml.rst create mode 100644 doc/config-reference/source/telemetry/samples/policy.json.rst diff --git a/doc/config-reference/source/telemetry.rst b/doc/config-reference/source/telemetry.rst index bf0efe66a2..75ee3ca62f 100644 --- a/doc/config-reference/source/telemetry.rst +++ b/doc/config-reference/source/telemetry.rst @@ -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 diff --git a/doc/config-reference/source/telemetry/sample-configuration-files.rst b/doc/config-reference/source/telemetry/sample-configuration-files.rst deleted file mode 100644 index a6538982b2..0000000000 --- a/doc/config-reference/source/telemetry/sample-configuration-files.rst +++ /dev/null @@ -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 diff --git a/doc/config-reference/source/telemetry/samples/ceilometer.conf.rst b/doc/config-reference/source/telemetry/samples/ceilometer.conf.rst new file mode 100644 index 0000000000..73436f6320 --- /dev/null +++ b/doc/config-reference/source/telemetry/samples/ceilometer.conf.rst @@ -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 diff --git a/doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst b/doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst new file mode 100644 index 0000000000..255cdd9962 --- /dev/null +++ b/doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst @@ -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 diff --git a/doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst b/doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst new file mode 100644 index 0000000000..34559c0ba2 --- /dev/null +++ b/doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst @@ -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 diff --git a/doc/config-reference/source/telemetry/samples/index.rst b/doc/config-reference/source/telemetry/samples/index.rst new file mode 100644 index 0000000000..64d5fa1092 --- /dev/null +++ b/doc/config-reference/source/telemetry/samples/index.rst @@ -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 diff --git a/doc/config-reference/source/telemetry/samples/pipeline.yaml.rst b/doc/config-reference/source/telemetry/samples/pipeline.yaml.rst new file mode 100644 index 0000000000..01bb7c89ba --- /dev/null +++ b/doc/config-reference/source/telemetry/samples/pipeline.yaml.rst @@ -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 diff --git a/doc/config-reference/source/telemetry/samples/policy.json.rst b/doc/config-reference/source/telemetry/samples/policy.json.rst new file mode 100644 index 0000000000..806979129e --- /dev/null +++ b/doc/config-reference/source/telemetry/samples/policy.json.rst @@ -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