Stephen Gordon b02b294503 Update nova flagmappings for libvirt group
Updated Nova flag mappings to reflect that libvirt specific flags are
moving to a "libvirt" group. This will take effect in the output when
the autoconfig tables are next generated.

Change-Id: Ia5e13ba6cc5678098018678edcc79ef91f31aca6
Closes-Bug: #1253822
2013-11-22 06:53:30 -05:00
flagmappings Update nova flagmappings for libvirt group 2013-11-22 06:53:30 -05:00
test Add Autogenerate-config-doc code to tools 2013-08-10 09:43:55 +08:00
.gitignore Add Autogenerate-config-doc code to tools 2013-08-10 09:43:55 +08:00 Adding guidance on software installation 2013-11-08 07:03:31 +10:30 Add Autogenerate-config-doc code to tools 2013-08-10 09:43:55 +08:00 Fix typo on error message 2013-11-04 21:56:50 -08:00 Update autogenerate tools for new directory struct 2013-09-07 12:29:27 -07:00
flow.dia Add Autogenerate-config-doc code to tools 2013-08-10 09:43:55 +08:00


Automatically generate configuration tables to document OpenStack.

Dependencies: python-git (at least version 0.3.2 RC1), oslo.config

Setting up your environment

Note: This tool is best run in a fresh VM environment, as running it requires installing the dependencies of the particular OpenStack product you are working with. Installing all of that on your normal machine could leave you with a bunch of cruft!

First install git and python-pip,

$ sudo apt-get install git python-pip

next, install oslo.config and GitPython

$ sudo pip install oslo.config "GitPython>=0.3.2.RC1"

then, checkout the repository you are working with:

$ git clone

(this guide makes reference to a /repos directory, so you should record the directory you are using and replace as appropriate below)

and the tool itself:

$ git clone

and finally, the dependencies for the product you are working with:

$ sudo pip install -r nova/requirements.txt

Now you are ready to use the tool.

Using the tool

This tool is divided into three parts:

  1. Extraction of flags names eg

    $ ./ --action create -i flagmappings/nova.flagmappings -o names --path /repos/nova

  2. Grouping of flags

This is currently done manually, by using the flag name file and placing a category after a space.


 $ head flagmappings/glance.flagmappings
 admin\_password registry
 admin\_role api
 admin\_tenant\_name registry
 admin\_user registry
  1. Creation of docbook-formatted configuration table files


$ ./ --action create -i flagmappings/nova.flagmappings -o docbook --path /repos/nova

A worked example - updating the docs for H2

update automatically generated tables - from scratch

$ sudo apt-get update
$ sudo apt-get install git python-pip python-dev
$ sudo pip install git-review GitPython
$ git clone git://
$ cd openstack-manuals/
$ git review -d 35726
$ cd tools/autogenerate-config-docs/

Now, cloning and installing requirements for nova, glance, quantum

$ for i in nova glance quantum; do git clone git://$i.git; done
$ for i in nova glance quantum; do sudo pip install -r $i/requirements.txt; done

This missed some requirements for nova, which were fixed by:

$ sudo pip install python-glanceclient websockify pyasn1 python-cinderclient error_util
$ sudo apt-get install python-ldap python-lxml

Making the flag names update

./ -vvv --action update -i flagmappings/nova.flagmappings -o names --path ~/nova | more

At this point, seach through flagmappings/ for anything labelled Unknown and fix, once that is done use:

./ -vvv --action create -i flagmappings/nova.flagmappings -o docbook --path ~/nova

to generate the XML files and move those into the appropriate part ofthe git repo