manila/tools/config
Thomas Bechtold c16feaea5e Use common config generator
Delete Manila's implementation located in tools/conf and replace
it with common config generator located in tools/config. The new config
generator include config options from other modules (olso.messaging,
oslo.db, oslo.db.concurrency) which improves the generated sample config.

Change-Id: I553e1a8ec414383e2d79d445ebd10e0e1ffa1ae4
2014-08-12 16:33:06 +02:00
..
README Add config module from oslo-incubator 2014-08-12 15:12:17 +02:00
check_uptodate.sh Add config module from oslo-incubator 2014-08-12 15:12:17 +02:00
generate_sample.sh Add config module from oslo-incubator 2014-08-12 15:12:17 +02:00
oslo.config.generator.rc Use common config generator 2014-08-12 16:33:06 +02:00

README

This generate_sample.sh tool is used to generate sample config files
from OpenStack project source trees.

Run it by passing the base directory and package name i.e.

  $> generate_sample.sh --base-dir /opt/stack/nova --package-name nova \
                        --output-dir /opt/stack/nova/etc
  $> generate_sample.sh -b /opt/stack/neutron -p nova -o /opt/stack/neutron/etc

Optionally, include libraries that register entry points for option
discovery, such as oslo.messaging:

  $> generate_sample.sh -b /opt/stack/ceilometer -p ceilometer \
                        -o /opt/stack/ceilometer/etc -l oslo.messaging

Watch out for warnings about modules like libvirt, qpid and zmq not
being found - these warnings are significant because they result
in options not appearing in the generated config file.



This check_uptodate.sh tool is used to ensure that the generated sample
config file in the OpenStack project source tree is continually kept up
to date with the code itself.

This can be done by adding a hook to tox.ini. For example, if a project
already had flake8 enabled in a section like this:

  [testenv.pep8]
  commands =
    flake8 {posargs}

This section would be changed to:

  [testenv.pep8]
  commands =
    flake8 {posargs}
    {toxinidir}/tools/config/check_uptodate.sh