From 718a04644734aaa7ba841d375949db401e3d4b1c Mon Sep 17 00:00:00 2001 From: Samriddhi Jain Date: Mon, 3 Jul 2017 04:27:19 +0530 Subject: [PATCH] Added configuration options using oslo.config There are auto generated configuration and policy guides which were earlier manually copied and referenced. Used sphinext module in oslo_config and oslo_policy to automatically render those pages. Change-Id: I2b49eb0083661cce70c5b9457fe5bd32dfe5e5e8 --- doc/source/conf.py | 2 ++ doc/source/configuration/config-options.rst | 26 +++++++++++++++++++++ doc/source/configuration/policy.rst | 9 +++++++ doc/source/index.rst | 4 +++- 4 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 doc/source/configuration/config-options.rst create mode 100644 doc/source/configuration/policy.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 23d014c69d..7369758835 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -49,8 +49,10 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'oslo_config.sphinxconfiggen', + 'oslo_config.sphinxext', 'oslo_policy.sphinxpolicygen', 'openstackdocstheme', + 'oslo_policy.sphinxext', 'ext.support_matrix', ] diff --git a/doc/source/configuration/config-options.rst b/doc/source/configuration/config-options.rst new file mode 100644 index 0000000000..8882db30e2 --- /dev/null +++ b/doc/source/configuration/config-options.rst @@ -0,0 +1,26 @@ +========================= +API Configuration options +========================= + +Configuration +~~~~~~~~~~~~~ + +The Identity service is configured in the ``/etc/keystone/keystone.conf`` file. + +The following tables provide a comprehensive list of the Identity +service options. For a sample configuration file, refer to +:doc:`/sample_files/sample_config`. + +.. show-options:: + :config-file: config-generator/keystone.conf + +Domain-specific Identity drivers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Identity service supports domain-specific Identity drivers +installed on an SQL or LDAP back end, and supports domain-specific +Identity configuration options, which are stored in domain-specific +configuration files. See the +`Admin guide Identity Management Chapter +`_ +for more information. diff --git a/doc/source/configuration/policy.rst b/doc/source/configuration/policy.rst new file mode 100644 index 0000000000..38ed3ae6f7 --- /dev/null +++ b/doc/source/configuration/policy.rst @@ -0,0 +1,9 @@ +==================== +Policy configuration +==================== + +The following is an overview of all available policies in Keystone. For a sample +configuration file, refer to :doc:`/sample_files/sample_policy`. + +.. show-options:: + :config-file: config-generator/keystone-policy-generator.conf diff --git a/doc/source/index.rst b/doc/source/index.rst index a67bf8eab0..f41bb283be 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -100,8 +100,10 @@ Configuration Options ~~~~~~~~~~~~~~~~~~~~~ .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + configuration/config-options.rst + configuration/policy.rst configuration/samples/index.rst API Documentation