openstack/glance
Code Issues Proposed changes

Merge "Generate and include sample config as part of docs"

Browse Source
This commit is contained in:
Jenkins 2016-08-02 17:42:54 +00:00 committed by Gerrit Code Review
commit 5308ec65a1
4 changed files with 68 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/conf.py
View File

@ -52,8 +52,24 @@ extensions = ['sphinx.ext.coverage',
'oslo_config.sphinxext',
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'oslo_config.sphinxconfiggen',
]
config_generator_config_file = [
('../../etc/oslo-config-generator/glance-api.conf',
'_static/glance-api'),
('../../etc/oslo-config-generator/glance-cache.conf',
'_static/glance-cache'),
('../../etc/oslo-config-generator/glance-glare.conf',
'_static/glance-glare'),
('../../etc/oslo-config-generator/glance-manage.conf',
'_static/glance-manage'),
('../../etc/oslo-config-generator/glance-registry.conf',
'_static/glance-registry'),
('../../etc/oslo-config-generator/glance-scrubber.conf',
'_static/glance-scrubber'),
]
# Add any paths that contain templates here, relative to this directory.
# templates_path = []

7
doc/source/configuring.rst
View File

@ -42,10 +42,9 @@ installed Glance via your operating system's package management system, it
is likely that you will have sample configuration files installed in
``/etc/glance``.
In addition to this documentation page, you can check the
``etc/glance-api.conf`` and ``etc/glance-registry.conf`` sample configuration
files distributed with Glance for example configuration files for each server
application with detailed comments on what each options does.
In addition, sample configuration files for each server application with
detailed comments are available in the :doc:`Glance Sample Configuration
<sample-configuration>` section.
The PasteDeploy configuration (controlling the deployment of the WSGI
application for each component) may be found by default in

1
doc/source/index.rst
View File

@ -69,6 +69,7 @@ Installing/Configuring Glance
installing
configuring
sample-configuration
authentication
policies
image-location-strategy-modules

48
doc/source/sample-configuration.rst Normal file
View File

@ -0,0 +1,48 @@
===========================
Glance Sample Configuration
===========================
The following are sample configuration files for all Glance services and
utilities. These are generated from code and reflect the current state of code
in the Glance repository.
Sample configuration for Glance API
-----------------------------------
This sample configuration can also be viewed in `file form <_static/glance-api.conf.sample>`_.
.. literalinclude:: _static/glance-api.conf.sample
Sample configuration for Glance Registry
----------------------------------------
This sample configuration can also be viewed in `file form <_static/glance-registry.conf.sample>`_.
.. literalinclude:: _static/glance-registry.conf.sample
Sample configuration for Glance Scrubber
----------------------------------------
This sample configuration can also be viewed in `file form <_static/glance-scrubber.conf.sample>`_.
.. literalinclude:: _static/glance-scrubber.conf.sample
Sample configuration for Glance Manage
--------------------------------------
This sample configuration can also be viewed in `file form <_static/glance-manage.conf.sample>`_.
.. literalinclude:: _static/glance-manage.conf.sample
Sample configuration for Glance Cache
-------------------------------------
This sample configuration can also be viewed in `file form <_static/glance-cache.conf.sample>`_.
.. literalinclude:: _static/glance-cache.conf.sample
Sample configuration for Glare
------------------------------
This sample configuration can also be viewed in `file form <_static/glance-glare.conf.sample>`_.
.. literalinclude:: _static/glance-glare.conf.sample