openstack
/
oslo.service
Code Issues Proposed changes

Documentation on the use of the oslo-config-generator 

Describe the entry points of the oslo.service library for the oslo.config generator.

Change-Id: I88016e24bd982bfe56c5eb7f9528eb8acbb73a14
Closes-Bug: 1469066
This commit is contained in:
Sergey Vilgelm 2015-06-26 22:19:25 +02:00
parent eea13af645
commit 1971e8bdb3
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/source/usage.rst
View File

@ -41,3 +41,27 @@ When using oslo.service
CONF = cfg.CONF
launcher = service.launch(CONF, service, workers=2)
Using oslo.service with oslo-config-generator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``oslo.service`` provides several entry points to generate a configuration
files.
* :func:`oslo.service.service <oslo_service.service.list_opts>`
The options from the service and eventlet_backdoor modules for
the [DEFAULT] section.
* :func:`oslo.service.periodic_task <oslo_service.periodic_task.list_opts>`
The options from the periodic_task module for the [DEFAULT] section.
* :func:`oslo.service.sslutils <oslo_service.sslutils.list_opts>`
The options from the sslutils module for the [ssl] section.
**ATTENTION:** The library doesn't provide an oslo.service entry point.
.. code-block:: bash
$ oslo-config-generator --namespace oslo.service.service \
--namespace oslo.service.periodic_task \
--namespace oslo.service.sslutils