Docs: Arrange Configuration Guide

Change-Id: Iaea6ac7645150d72a50fed0813b265152c2510e5

doc/source/conf.py

@@ -23,7 +23,9 @@ extensions = [
     'sphinx.ext.autodoc',
     # 'sphinx.ext.intersphinx',
     'openstackdocstheme',
-    'reno.sphinxext'
+    'reno.sphinxext',
+    'oslo_config.sphinxext',
+    'oslo_config.sphinxconfiggen',
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -41,6 +43,11 @@ exclude_patterns = [
     'api/karbor.services.protection.protection_plugins.*',
 ]
 
+config_generator_config_file = [
+    ('../../etc/oslo-config-generator/karbor.conf',
+     '_static/karbor'),
+]
+
 # The suffix of source filenames.
 source_suffix = '.rst'
 

doc/source/configuration/index.rst

@@ -0,0 +1,14 @@
+.. _configuring:
+
+=====================
+Configuration Options
+=====================
+
+This section provides a list of all possible options for each configuration
+file.
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   *

doc/source/configuration/karbor.rst

@@ -0,0 +1,8 @@
+.. _karbor.conf:
+
+-----------
+karbor.conf
+-----------
+
+.. show-options::
+   :config-file: etc/oslo-config-generator/karbor.conf

doc/source/index.rst

@@ -19,6 +19,7 @@ through a unified interface
    :maxdepth: 1
 
    install/index
+   configuration/index
 
 Using Karbor
 ============

etc/oslo-config-generator/karbor.conf

@@ -2,8 +2,6 @@
 output_file = etc/karbor.conf.sample
 namespace = karbor.common.opts
 namespace = keystonemiddleware.auth_token
-namespace = oslo.messaging
 namespace = oslo.concurrency
 namespace = oslo.db
-namespace = oslo.log
 namespace = oslo.policy

karbor/common/opts.py

@@ -77,7 +77,7 @@ _opts = [
         volume_snapshot_plugin.volume_snapshot_opts))),
     ('manila_snapshot_plugin', list(itertools.chain(
         share_snapshot_plugin.manila_snapshot_opts))),
-    (None, list(itertools.chain(
+    ('DEFAULT', list(itertools.chain(
         karbor.common.config.core_opts,
         karbor.common.config.debug_opts,
         karbor.common.config.global_opts,