From 9526e05b96de510f548bb3c3a927a2e30f533b43 Mon Sep 17 00:00:00 2001 From: Ronald Bradford Date: Thu, 21 Jan 2016 11:54:36 -0500 Subject: [PATCH] Generate page of all config options in docs Use oslo_config.sphinxext to automatically document the available configuration options in the sphinx documentation. See https://etherpad.openstack.org/p/automating-oslo-config-documentation for work to implement this to each project. Glance is one of the first six projects for a consolidated operators configuration reference. Change-Id: If701f7dfa240075457e6e149bcb12ff713a8c79b --- doc/source/conf.py | 1 + doc/source/configuring.rst | 1 + doc/source/index.rst | 1 + doc/source/man/glancescrubber.rst | 2 +- doc/source/opts.rst | 199 ++++++++++++++++++++++++++++++ 5 files changed, 203 insertions(+), 1 deletion(-) create mode 100644 doc/source/opts.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 9ff92983ad..6f4e342bd8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -49,6 +49,7 @@ extensions = ['sphinx.ext.coverage', 'sphinx.ext.graphviz', 'oslosphinx', 'stevedore.sphinxext', + 'oslo_config.sphinxext', ] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/source/configuring.rst b/doc/source/configuring.rst index 6a690f5034..cd723c999f 100644 --- a/doc/source/configuring.rst +++ b/doc/source/configuring.rst @@ -1414,6 +1414,7 @@ to or less than this value. The ``glance-cache-pruner`` executable is designed to be run via cron on a regular basis. See more about this executable in :doc:`Controlling the Growth of the Image Cache ` +.. _configuring-the-glance-registry: Configuring the Glance Registry ------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 5a0092f151..7e977efa90 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -74,6 +74,7 @@ Installing/Configuring Glance artifact-types flows property-protections + opts Operating Glance ================ diff --git a/doc/source/man/glancescrubber.rst b/doc/source/man/glancescrubber.rst index 754d5d26de..5d1d989182 100644 --- a/doc/source/man/glancescrubber.rst +++ b/doc/source/man/glancescrubber.rst @@ -60,4 +60,4 @@ FILES **/etc/glance/glance-scrubber.conf** Default configuration file for the Glance Scrubber -. include:: footer.rst +.. include:: footer.rst diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 0000000000..939dabc205 --- /dev/null +++ b/doc/source/opts.rst @@ -0,0 +1,199 @@ +============================= + Glance Configuration Options +============================= + +Glance uses the following configuration files for its various services. + +* :ref:`glance-api.conf` +* :ref:`glance-cache.conf` +* :ref:`glance-registry.conf` +* :ref:`glance-manage.conf` +* :ref:`glance-scrubber.conf` + +This documentation page provides a list of all possible options for each +configuration file. Refer to :doc:`Basic Configuration ` +for a detailed guide in getting started with various option settings. + +.. _glance-api.conf: + +--------------- +glance-api.conf +--------------- + +.. show-options:: glance.api +.. show-options:: glance.store + +Additional Common Configuration ++++++++++++++++++++++++++++++++ + +This configuration file also includes options from the following common +libraries. + +* :ref:`keystonemiddleware.auth_token` +* :ref:`oslo.concurrency` +* :ref:`oslo.messaging` +* :ref:`oslo.db` +* :ref:`oslo.db.concurrency` +* :ref:`oslo.policy` + +.. _glance-cache.conf: + +----------------- +glance-cache.conf +----------------- + +.. show-options:: glance.cache + +Additional Common Configuration ++++++++++++++++++++++++++++++++ + +This configuration file also includes options from the following common +libraries. + +* :ref:`oslo.policy` +* :ref:`oslo.log` + +.. _glance-registry.conf: + +-------------------- +glance-registry.conf +-------------------- + +This configuration file controls how the register server operates. More +information can be found in :ref:`configuring-the-glance-registry`. + +.. show-options:: glance.registry + +Additional Common Configuration ++++++++++++++++++++++++++++++++ + +This configuration file also includes options from the following common +libraries. + +* glance.store + +* :ref:`keystonemiddleware.auth_token` +* :ref:`oslo.messaging` +* :ref:`oslo.db` +* :ref:`oslo.db.concurrency` +* :ref:`oslo.policy` +* :ref:`oslo.log` + +.. _glance-manage.conf: + +------------------ +glance-manage.conf +------------------ + +.. show-options:: glance.manage + +Additional Common Configuration ++++++++++++++++++++++++++++++++ + +This configuration file also includes options from the following common +libraries. + +* :ref:`oslo.db` +* :ref:`oslo.db.concurrency` +* :ref:`oslo.log` + +.. _glance-scrubber.conf: + +-------------------- +glance-scrubber.conf +-------------------- + +.. show-options:: glance.scrubber + +Additional Common Configuration ++++++++++++++++++++++++++++++++ + +This configuration file also includes options from the following common +libraries. + +* :ref:`oslo.concurrency` +* :ref:`oslo.db` +* :ref:`oslo.db.concurrency` +* :ref:`oslo.log` +* :ref:`oslo.policy` + +======================= + Common Library Options +======================= + +.. _keystonemiddleware.auth_token: + +------------------- +Keystone Middleware +------------------- + +Options from the `Keystone Middleware`_ library. + +.. show-options:: keystonemiddleware.auth_token + +.. _oslo.concurrency: + +---------------- +Oslo Concurrency +---------------- + +Options from the `Oslo Concurrency`_ library. + +.. show-options:: oslo.concurrency + +.. _oslo.db: + +------- +Oslo DB +------- + +Options from the `Oslo DB`_ library. + +.. show-options:: oslo.db + +.. _oslo.db.concurrency: + +------------------- +Oslo DB Concurrency +------------------- + +Options from Oslo DB Concurrency. + +.. show-options:: oslo.db.concurrency + +.. _oslo.log: + +-------- +Oslo Log +-------- + +Options from the `Oslo Log`_ library. + +.. show-options:: oslo.log + +.. _oslo.messaging: + +-------------- +Oslo Messaging +-------------- + +Options from the `Oslo Messaging`_ library. + +.. show-options:: oslo.messaging + +.. _oslo.policy: + +----------- +Oslo Policy +----------- + +Options from the `Oslo Policy`_ library. + +.. show-options:: oslo.policy + +.. _Keystone Middleware: http://docs.openstack.org/developer/keystonemiddleware/middlewarearchitecture.html#configuration-options +.. _Oslo Concurrency: http://docs.openstack.org/developer/oslo.concurrency/opts.html +.. _Oslo DB: http://docs.openstack.org/developer/oslo.db/opts.html +.. _Oslo Log: http://docs.openstack.org/developer/oslo.log/opts.html +.. _Oslo Policy: http://docs.openstack.org/developer/oslo.policy/opts.html +.. _Oslo Messaging: http://docs.openstack.org/developer/oslo.messaging/opts.html