Browse Source

Add sample configuration files to documentation

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

Change-Id: I38d3fa5d1d7a32670dc84e4b10ffe1400e220a69
Artur Basiak 1 year ago
parent
commit
ae9f8255db
2 changed files with 58 additions and 0 deletions
  1. 7
    0
      doc/source/configuration/index.rst
  2. 51
    0
      doc/source/configuration/sample.rst

+ 7
- 0
doc/source/configuration/index.rst View File

@@ -1,3 +1,10 @@
1 1
 =============
2 2
 Configuration
3 3
 =============
4
+
5
+This section describes the configuration settings that can be specified.
6
+
7
+.. toctree::
8
+   :maxdepth: 1
9
+
10
+   sample

+ 51
- 0
doc/source/configuration/sample.rst View File

@@ -0,0 +1,51 @@
1
+.. _sample_configuration:
2
+
3
+-------
4
+Samples
5
+-------
6
+
7
+The following sections show sample configuration files for monasca-events-api
8
+and related utilities. These are generated from the code (apart from
9
+the samples for logging and paste) and reflect the current state of code in the
10
+monasca-events-api repository.
11
+
12
+
13
+.. _sample-configuration-api:
14
+
15
+Sample Configuration For Application
16
+------------------------------------
17
+
18
+This sample configuration can also be viewed in `events-api.conf.sample
19
+<../_static/events-api.conf.sample>`_.
20
+
21
+.. literalinclude:: ../_static/events-api.conf.sample
22
+
23
+.. _sample-configuration-logging:
24
+
25
+Sample Configuration for Logging
26
+--------------------------------
27
+
28
+This sample configuration can also be viewed in `events-api-logging.conf
29
+<../../../etc/monasca/events-api-logging.conf>`_.
30
+
31
+.. literalinclude:: ../../../etc/monasca/events-api-logging.conf
32
+
33
+
34
+Sample Configuration for Paste
35
+------------------------------
36
+
37
+This sample configuration can also be viewed in `events-api-paste.ini
38
+<../../../etc/monasca/events-api-paste.ini>`_.
39
+
40
+.. literalinclude:: ../../../etc/monasca/events-api-paste.ini
41
+
42
+
43
+.. _sample-configuration-policies:
44
+
45
+Sample Configuration for Policies
46
+---------------------------------
47
+
48
+This sample configuration can also be viewed in `events-api.policy.yaml.sample
49
+<../_static/events-api.policy.yaml.sample>`_ .
50
+
51
+.. literalinclude:: ../_static/events-api.policy.yaml.sample

Loading…
Cancel
Save