eae9f5b9b5
This patch brings the auto-generate-config doc tool into
the openstack-manuals repo, where it can be used to update
the configuration option tables.
patchset2 fixes obvious things noted by reviewers, likely
needs more fixing.
patchset 4 adds update feature, fixes pep8
patchset 5 removes debugging print
patchset 6 adds warning to tables regarding their
automatically generated nature
patchset 7 updated nova flagmappings for H2 and
adds updated nova tables
patchset 8 adds a seciton in the readme with a worked example
from a recent use of the script
patchset 10 fixes for cinder
patchset 11 testing, fixing
patchset 12 testing, fixing
patchset 13 adds categories to cinder.flagmappings, generates
docbook tables for cinder
patchset 14 adds mappings for neutron, and generates docbook
tables based on these
patchset 15 adds list of bugs this patch will fix
patchset 16 fixes whitespace error in automatically generated tables :(
fixes bug 1192225
Partial-Bug 1207550
Partial-Bug 1207549
fixes bug 1206827
Partial-Bug 1206336
fixes bug 1204484
Partial-Bug 1204205
fixes bug 1202260
fixes bug 1201710
fixes bug 1200794
Partial-Bug 1200740
Partial-Bug 1200418
Partial-Bug 1200047
Partial-Bug 1199209
Partial-Bug 1197657
fixes bug 1197653
fixes bug 1197295
Partial-Bug 1197088
Partial-Bug 1195900
fixes bug 1195560
fixes bug 1195433
Partial-Bug 1192752
fixes bug 1187278
Partial-Bug 1106428
Change-Id: Icd3f4496850c375c9359a10eddb25ab5c722595e
bp:autogenerate-config-tables
106 lines
3.1 KiB
Markdown
106 lines
3.1 KiB
Markdown
autogenerate-config-docs
|
|
========================
|
|
|
|
Automatically generate configuration tables to document OpenStack.
|
|
|
|
|
|
Dependencies: python-git (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
|
|
|
|
then, checkout the repository you are working with:
|
|
|
|
$ git clone https://github.com/openstack/nova.git
|
|
|
|
(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 https://github.com/openstack/openstack-manuals.git
|
|
|
|
|
|
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
|
|
|
|
$ ./autohelp.py --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.
|
|
|
|
eg
|
|
|
|
$ head flagmappings/glance.flagmappings
|
|
admin\_password registry
|
|
admin\_role api
|
|
admin\_tenant\_name registry
|
|
admin\_user registry
|
|
...
|
|
|
|
3) Creation of docbook-formatted configuration table files
|
|
|
|
eg
|
|
|
|
$ ./autohelp.py --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://github.com/openstack/openstack-manuals.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://github.com/openstack/$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
|
|
|
|
./autohelp.py -vvv --action update -i flagmappings/nova.flagmappings -o names --path ~/nova | more
|
|
|
|
At this point, seach through flagmappings/nova.flagmappings.new for anything labelled Unknown and fix,
|
|
once that is done use:
|
|
|
|
./autohelp.py -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
|