docs: create a page which shows config options

[Markus Zoeller (markus_z)]

I think we should show our config options in our official docs. Nova does it like this: http://docs.openstack.org/developer/nova/sample_config.html

The use the oslo-config-generator for that in their "tox.ini" file:

    [testenv:genconfig]
    commands = oslo-config-generator --config-file=etc/nova/nova-config-generator.conf

https://github.com/openstack/nova/blob/master/tox.ini#L89

The rendered result should be at: http://nova-dpm.readthedocs.io/en/latest/

Our config options are already centrally available at: https://github.com/openstack/nova-dpm/blob/master/nova_dpm/conf/dpm.py

[Sreeram Vancheeswaran (sreeram-vancheeswaran)]

Yes, agreed. I will work on it

[Andreas Maier (maiera)]

The documentation of the config options must clarify which options are required, and which options are optional and what their default is if not specified.

[Andreas Scheuring (andreas-scheuring)]

Had a brief chat with the powervm guys. Their option tables looks pretty nice [1] - but they created it manually.. :/

[1] http://nova-powervm.readthedocs.io/en/latest/devref/usage.html#configuration-file-options

[Andreas Scheuring (andreas-scheuring)]

FYI: This does the trick for networking-dpm: https://review.openstack.org/#/c/425279/

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/425575

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/425575
Committed: https://git.openstack.org/cgit/openstack/nova-dpm/commit/?id=8f82f0a442c39c0a70a17644ffa677a9f70b2b74
Submitter: Jenkins
Branch: master

commit 8f82f0a442c39c0a70a17644ffa677a9f70b2b74
Author: Andreas Scheuring <email address hidden>
Date: Thu Jan 26 09:05:21 2017 +0100

    Enable configfile autogeneration

    This patch enables configfile autogeneration. It is triggered

    * implicitly on every sphinx build
      output dir: doc/source/html/_static/nova_dpm.conf.sample
      for doc inclusion
    * explicilty by tox -egenconfig
      output dir: etc/nova/nova_dpm.conf.sample
    * explicitly by tox -edocs
      output dir: etc/nova/nova_dpm.conf.sample

    In addition the return type of nova_dpm.conf.dpm.list_opts needed
    to be changed to the default format (list of tuples).

    Change-Id: Ib298b274f877d651dd846cac6525789c458da407
    Closes-Bug: #1657701