zaqar

History

Jeffrey Zhang ea6a221f68 Add the redis opts to the generate sample shell script * Fix the redis opts typo in setup.cfg * Fix the default value type for reconnect_sleep in redis * add the redis to oslo.config.generator.rc Change-Id: Ibd439e2bdaa46ddf21802724f9fe7fb6f2b61bc5		2014-09-18 00:07:54 +08:00
..
check_uptodate.sh	Update files from oslo-incubator	2014-08-13 15:25:06 +02:00
generate_sample.sh	Update files from oslo-incubator	2014-08-13 15:25:06 +02:00
oslo.config.generator.rc	Add the redis opts to the generate sample shell script	2014-09-18 00:07:54 +08:00
README	Use oslo's config generator to generate sample	2014-03-11 20:14:35 +01: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