diff --git a/doc/source/conf.py b/doc/source/conf.py index 26fb3ebd6..bb8f53cfe 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -43,8 +43,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.graphviz', 'sphinx_feature_classification.support_matrix', - # TODO(efried): make this work - # 'oslo_config.sphinxconfiggen', + 'oslo_config.sphinxconfiggen', 'oslo_config.sphinxext', 'oslo_policy.sphinxpolicygen', 'oslo_policy.sphinxext', @@ -57,6 +56,9 @@ repository_name = 'openstack/placement' bug_project = 'nova' bug_tag = 'docs' +config_generator_config_file = '../../etc/placement/config-generator.conf' +sample_config_basename = '_static/placement' + policy_generator_config_file = [ ('../../etc/placement/policy-generator.conf', '_static/placement') diff --git a/doc/source/configuration/config.rst b/doc/source/configuration/config.rst new file mode 100644 index 000000000..2d60e1f3c --- /dev/null +++ b/doc/source/configuration/config.rst @@ -0,0 +1,10 @@ +===================== +Configuration Options +===================== + +The following is an overview of all available configuration options in +Placement. For a sample configuration file, refer to +:doc:`/configuration/sample-config`. + +.. show-options:: + :config-file: etc/placement/config-generator.conf diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 5776edb58..cca3bc963 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -2,22 +2,22 @@ Configuration Guide =================== -The static configuration for nova lives in two main files: ``nova.conf`` and -``policy.json``. These are described below. For a bigger picture view on -configuring nova to solve specific problems, refer to the :nova-doc:`Nova Admin -Guide `. +The static configuration for Placement lives in two main files: ``placement.conf`` and +``policy.json``. These are described below. Configuration ------------- -.. TODO(efried):: Get these working +* :doc:`Config Reference `: A complete reference of all + configuration options available in the ``placement.conf`` file. + +* :doc:`Sample Config File `: A sample config + file with inline documentation. + +.. TODO(efried):: Get this working * :nova-doc:`Configuration Guide `: Detailed configuration guides for various parts of you Nova system. Helpful reference for setting up specific hypervisor backends. - * :doc:`Config Reference `: A complete reference of all - configuration options available in the ``nova.conf`` file. - * :doc:`Sample Config File `: A sample config - file with inline documentation. Policy ------ @@ -40,7 +40,5 @@ permissions on REST API actions. policy sample-policy - -.. TODO(efried):: get these working config sample-config diff --git a/doc/source/configuration/sample-config.rst b/doc/source/configuration/sample-config.rst new file mode 100644 index 000000000..d2d098279 --- /dev/null +++ b/doc/source/configuration/sample-config.rst @@ -0,0 +1,19 @@ +========================= +Sample Configuration File +========================= + +The following is a sample Placement configuration for adaptation and use. For a +detailed overview of all available configuration options, refer to +:doc:`/configuration/config`. + +The sample configuration can also be viewed in :download:`file form +`. + +.. important:: + + The sample configuration file is auto-generated from placement when this + documentation is built. You must ensure your version of placement matches + the version of this documentation. + +.. literalinclude:: /_static/placement.conf.sample + diff --git a/doc/source/index.rst b/doc/source/index.rst index a0de47059..fddfc5ae9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -340,7 +340,7 @@ could be making requests to a Newton placement API. Configuration ~~~~~~~~~~~~~ -See the `Configuration Guide ` for information on +See the :doc:`Configuration Guide ` for information on configuring the system, including role-based access control policy rules. Contributors