oslo-incubator

History

Ben Nemec f6a1848688 Be smarter about config generator default package name Using python setup.py --name instead of the current working directory will allow the config generator to work correctly by default even if the local source tree was cloned into a directory that doesn't match the project name. Change-Id: Iea529e7e691d94402f658e7095387dc3e98e32fe Closes-Bug: #1288417		2014-03-10 19:52:02 +00:00
..
README	Use entry points to discover options in libraries	2014-01-15 22:13:16 +00:00
check_uptodate.sh	Add check_uptodate to tools/config	2013-12-27 15:33:01 -08:00
generate_sample.sh	Be smarter about config generator default package name	2014-03-10 19:52:02 +00: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