Add sample configuration files to documentation

Add sample configuration files to documentation.
Add files about:
- configuration
- paste
- logging
- policies

Change-Id: I38d3fa5d1d7a32670dc84e4b10ffe1400e220a69
This commit is contained in:
Artur Basiak 2017-08-01 15:40:14 +02:00
parent 32c4560c3b
commit ae9f8255db
2 changed files with 58 additions and 0 deletions

View File

@ -1,3 +1,10 @@
=============
Configuration
=============
This section describes the configuration settings that can be specified.
.. toctree::
:maxdepth: 1
sample

View File

@ -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