summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-11-05 18:05:49 +0000
committerGerrit Code Review <review@openstack.org>2018-11-05 18:05:49 +0000
commit947810ada5fb2f92e28b9eac6f6ebf8dedb460f1 (patch)
tree86a8006742e4f7320d134426635bf1eb8e96795b
parentb03a4522cbf68c6661406216828b0548ab15850e (diff)
parentb34156ae7bec2e5992bba115746d25502ec437ce (diff)
Merge "docs: Add config documentation to operator's section"
-rw-r--r--deckhand/conf/config.py1
-rw-r--r--doc/source/conf.py5
-rw-r--r--doc/source/operators/configuration.rst49
-rw-r--r--doc/source/operators/index.rst1
4 files changed, 56 insertions, 0 deletions
diff --git a/deckhand/conf/config.py b/deckhand/conf/config.py
index 17835ce..5f602df 100644
--- a/deckhand/conf/config.py
+++ b/deckhand/conf/config.py
@@ -112,6 +112,7 @@ def list_opts():
112 ks_loading.get_auth_plugin_conf_options('password') + 112 ks_loading.get_auth_plugin_conf_options('password') +
113 ks_loading.get_auth_plugin_conf_options('v3password') 113 ks_loading.get_auth_plugin_conf_options('v3password')
114 ), 114 ),
115 engine_group: engine_opts,
115 barbican_group: ( 116 barbican_group: (
116 barbican_opts + 117 barbican_opts +
117 ks_loading.get_session_conf_options() + 118 ks_loading.get_session_conf_options() +
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 3954a92..62f3c11 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -40,6 +40,7 @@ extensions = [
40 'sphinx.ext.todo', 40 'sphinx.ext.todo',
41 'sphinx.ext.viewcode', 41 'sphinx.ext.viewcode',
42 'sphinxcontrib.apidoc', 42 'sphinxcontrib.apidoc',
43 'oslo_config.sphinxconfiggen',
43 'oslo_policy.sphinxpolicygen', 44 'oslo_policy.sphinxpolicygen',
44 # NOTE(fmontei): This is here so that readthedocs can publish releasenotes 45 # NOTE(fmontei): This is here so that readthedocs can publish releasenotes
45 # as well as documentation on the same domain and to do that we use a 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]
60apidoc_separate_modules = True 61apidoc_separate_modules = True
61 62
63# oslo_config.sphinxconfiggen options
64config_generator_config_file = '../../etc/deckhand/config-generator.conf'
65sample_config_basename = '_static/deckhand'
66
62# oslo_policy.sphinxpolicygen options 67# oslo_policy.sphinxpolicygen options
63policy_generator_config_file = '../../etc/deckhand/policy-generator.conf' 68policy_generator_config_file = '../../etc/deckhand/policy-generator.conf'
64sample_policy_basename = '_static/deckhand' 69sample_policy_basename = '_static/deckhand'
diff --git a/doc/source/operators/configuration.rst b/doc/source/operators/configuration.rst
new file mode 100644
index 0000000..6b071c0
--- /dev/null
+++ b/doc/source/operators/configuration.rst
@@ -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
17Deckhand Configuration
18======================
19
20Cache Configuration
21-------------------
22
23Deckhand 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
30All 3 caches are implemented in memory.
31
32Please reference the configuration groups below to enable or customize the
33timeout for each cache:
34
35* ``[barbican]``
36* ``[engine]``
37* ``[jsonschema]``
38
39Sample Configuration File
40-------------------------
41
42The following is a sample Deckhand config file for adaptation and use. It is
43auto-generated from Deckhand when this documentation is built, so
44if you are having issues with an option, please compare your version of
45Deckhand with the version of this documentation.
46
47The sample configuration can also be viewed in `file form <_static/deckhand.conf.sample>`_.
48
49.. literalinclude:: ../_static/deckhand.conf.sample
diff --git a/doc/source/operators/index.rst b/doc/source/operators/index.rst
index d997564..63b27c0 100644
--- a/doc/source/operators/index.rst
+++ b/doc/source/operators/index.rst
@@ -22,6 +22,7 @@ Operator's Guide
22 22
23 api_ref 23 api_ref
24 api_client 24 api_client
25 configuration
25 exceptions 26 exceptions
26 27
27Indices and tables 28Indices and tables