Browse Source

Merge "docs: Add config documentation to operator's section"

changes/21/614421/11
Zuul 8 months ago
parent
commit
947810ada5

+ 1
- 0
deckhand/conf/config.py View File

@@ -112,6 +112,7 @@ def list_opts():
112 112
             ks_loading.get_auth_plugin_conf_options('password') +
113 113
             ks_loading.get_auth_plugin_conf_options('v3password')
114 114
         ),
115
+        engine_group: engine_opts,
115 116
         barbican_group: (
116 117
             barbican_opts +
117 118
             ks_loading.get_session_conf_options() +

+ 5
- 0
doc/source/conf.py View File

@@ -40,6 +40,7 @@ extensions = [
40 40
     'sphinx.ext.todo',
41 41
     'sphinx.ext.viewcode',
42 42
     'sphinxcontrib.apidoc',
43
+    'oslo_config.sphinxconfiggen',
43 44
     'oslo_policy.sphinxpolicygen',
44 45
     # NOTE(fmontei): This is here so that readthedocs can publish releasenotes
45 46
     # as well as documentation on the same domain and to do that we use a
@@ -59,6 +60,10 @@ apidoc_excluded_paths = [
59 60
 ]
60 61
 apidoc_separate_modules = True
61 62
 
63
+# oslo_config.sphinxconfiggen options
64
+config_generator_config_file = '../../etc/deckhand/config-generator.conf'
65
+sample_config_basename = '_static/deckhand'
66
+
62 67
 # oslo_policy.sphinxpolicygen options
63 68
 policy_generator_config_file = '../../etc/deckhand/policy-generator.conf'
64 69
 sample_policy_basename = '_static/deckhand'

+ 49
- 0
doc/source/operators/configuration.rst View File

@@ -0,0 +1,49 @@
1
+..
2
+  Copyright 2018 AT&T Intellectual Property.  All other rights reserved.
3
+
4
+  Licensed under the Apache License, Version 2.0 (the "License");
5
+  you may not use this file except in compliance with the License.
6
+  You may obtain a copy of the License at
7
+
8
+      http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+  Unless required by applicable law or agreed to in writing, software
11
+  distributed under the License is distributed on an "AS IS" BASIS,
12
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+  See the License for the specific language governing permissions and
14
+  limitations under the License.
15
+
16
+
17
+Deckhand Configuration
18
+======================
19
+
20
+Cache Configuration
21
+-------------------
22
+
23
+Deckhand currently uses 3 different caches for the following use cases:
24
+
25
+* Caching rendered documents (see :ref:`rendering`) for faster future look-ups
26
+* Caching Barbican secret payloads
27
+* Caching ``jsonschema`` results for quickly resolving deeply nested dictionary
28
+  data
29
+
30
+All 3 caches are implemented in memory.
31
+
32
+Please reference the configuration groups below to enable or customize the
33
+timeout for each cache:
34
+
35
+* ``[barbican]``
36
+* ``[engine]``
37
+* ``[jsonschema]``
38
+
39
+Sample Configuration File
40
+-------------------------
41
+
42
+The following is a sample Deckhand config file for adaptation and use. It is
43
+auto-generated from Deckhand when this documentation is built, so
44
+if you are having issues with an option, please compare your version of
45
+Deckhand with the version of this documentation.
46
+
47
+The sample configuration can also be viewed in `file form <_static/deckhand.conf.sample>`_.
48
+
49
+.. literalinclude:: ../_static/deckhand.conf.sample

+ 1
- 0
doc/source/operators/index.rst View File

@@ -22,6 +22,7 @@ Operator's Guide
22 22
 
23 23
    api_ref
24 24
    api_client
25
+   configuration
25 26
    exceptions
26 27
 
27 28
 Indices and tables

Loading…
Cancel
Save