From ae9f8255db3d42fc13ad31f183b636683b51e93f Mon Sep 17 00:00:00 2001 From: Artur Basiak Date: Tue, 1 Aug 2017 15:40:14 +0200 Subject: [PATCH] Add sample configuration files to documentation Add sample configuration files to documentation. Add files about: - configuration - paste - logging - policies Change-Id: I38d3fa5d1d7a32670dc84e4b10ffe1400e220a69 --- doc/source/configuration/index.rst | 7 ++++ doc/source/configuration/sample.rst | 51 +++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 doc/source/configuration/sample.rst diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index e5cda69..f067b1c 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -1,3 +1,10 @@ ============= Configuration ============= + +This section describes the configuration settings that can be specified. + +.. toctree:: + :maxdepth: 1 + + sample diff --git a/doc/source/configuration/sample.rst b/doc/source/configuration/sample.rst new file mode 100644 index 0000000..b676e3c --- /dev/null +++ b/doc/source/configuration/sample.rst @@ -0,0 +1,51 @@ +.. _sample_configuration: + +------- +Samples +------- + +The following sections show sample configuration files for monasca-events-api +and related utilities. These are generated from the code (apart from +the samples for logging and paste) and reflect the current state of code in the +monasca-events-api repository. + + +.. _sample-configuration-api: + +Sample Configuration For Application +------------------------------------ + +This sample configuration can also be viewed in `events-api.conf.sample +<../_static/events-api.conf.sample>`_. + +.. literalinclude:: ../_static/events-api.conf.sample + +.. _sample-configuration-logging: + +Sample Configuration for Logging +-------------------------------- + +This sample configuration can also be viewed in `events-api-logging.conf +<../../../etc/monasca/events-api-logging.conf>`_. + +.. literalinclude:: ../../../etc/monasca/events-api-logging.conf + + +Sample Configuration for Paste +------------------------------ + +This sample configuration can also be viewed in `events-api-paste.ini +<../../../etc/monasca/events-api-paste.ini>`_. + +.. literalinclude:: ../../../etc/monasca/events-api-paste.ini + + +.. _sample-configuration-policies: + +Sample Configuration for Policies +--------------------------------- + +This sample configuration can also be viewed in `events-api.policy.yaml.sample +<../_static/events-api.policy.yaml.sample>`_ . + +.. literalinclude:: ../_static/events-api.policy.yaml.sample