Commit Graph

29 Commits

Author SHA1 Message Date
Andreas Jaeger 99af463886 Update autogenerate-config-docs for openstack-doc-tools
Let's keep the flagmappings as part of openstack-manuals and the
tool itself in openstack-doc-tools.

This patch removes the tools and updated the documentation.
A corresponding patch for openstack-doc-tools will be done.

Change-Id: Iad8f0607af9ff8522e6d7567cfa685301813ecfe
2013-12-16 21:48:53 +01:00
Stephen Gordon 4691631c67 Remove glusterfs_disk_util option
The glusterfs_disk_util option has been removed. I have manually
removed this entry from the current configuration tables and the
flag mapping.

As it is no longer in the code it will also no longer appear in
future auto-generated versions of the tables.

Closes-Bug: #1259419

Change-Id: I4aa606b3920347caa896c5b65ddcff6d9faf9881
2013-12-10 22:45:29 -05:00
Stephen Gordon 51f5cc14e2 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
Jenkins 292c139288 Merge "Move libvirt flags to libvirt group (cont.)" 2013-11-22 08:31:10 +00:00
Stephen Gordon 2265b790d3 Move libvirt flags to libvirt group (cont.)
Following Michael's progress on blueprint libvirt-opts-group:

* Rename libvirt_type virt_type and move to libvirt group.
* Rename libvirt_uri conn_uri and move to libvirt group.

Move to libvirt group:

* libvirt_inject_password
* libvirt_inject_key
* libvirt_inject_partition
* libvirt_vif_driver
* libvirt_volume_drivers
* libvirt_disk_prefix
* libvirt_wait_soft_reboot_seconds
* libvirt_non_blocking
* libvirt_cpu_mode
* libvirt_cpu_model
* libvirt_snapshots_directory

Move libvirt_nonblocking to libvirt group and rename to
libvirt_non_blocking, correcting typo. Changes will be picked
up in output next time docs autoconfig is run.

Change-Id: Idbaa7d6c7ab3c4c2df56d0ad995214902fe6c115
Closes-Bug: #1253812
2013-11-22 00:01:33 -05:00
Stephen Gordon 5b787bdbb8 Renamed docker_registry_default_port flag
The docker_registry_default_port flag has been renamed
registry_default_port to reflect that namespacing is
already provided via the context of the "docker" group
that it appears in.

Change-Id: Ia26f747a67b36fb96f72d3cc98016342e124b152
Closes-Bug: #1249441
2013-11-21 23:59:02 -05:00
Stephen Gordon 8069caf2b5 Removed references to unused libvirt_ovs_bridge flag.
The libvirt_ovs_bridge flag was unused in the code and removed under bug
1251813. This update removes it from the configuration mapping and the
current output (I didn't want to regenerate the entire configuration
tables this early in the cycle to avoid impacting backports too badly).

Change-Id: I91f6e58a7190279447a0f9439f7e30d662e7befd
Closes-Bug: #1251813
2013-11-19 09:49:14 -05:00
Jenkins 367d1b2969 Merge "Adding guidance on software installation" 2013-11-11 16:32:55 +00:00
Michael Davies fb4c56edeb Adding guidance on software installation
Change-Id: Ia415dd7971e94b866c31648dd821df738dd3bba3
2013-11-08 07:03:31 +10:30
Michael Davies 6828d0b299 Fix typo on error message
Change-Id: Id4a50e789e38d67a9aa66e68350303897699983c
2013-11-04 21:56:50 -08:00
Vipin Balachandran 1e8460409f VMware: Using auto-gen table in cinder driver doc
Currently, the configuration options for VMware VMDK drivers are
hard-coded in the reference source xml (doc/config-reference/
block-storage/drivers/vmware-vmdk-driver.xml). This change replaces
the hard-coded configuration options with a reference to auto-generated
config options file at doc/common/tables/cinder-vmware.xml.

Closes-Bug: #1245784
backport: havana
Change-Id: I4efb85ef0d1e082eac77daa1722b6bab831ae67d
2013-10-29 19:06:20 +05:30
Andreas Jaeger e6e62dd87c Move coraid_esm_address to coraid table
Regenerated cinder tables

Needed by https://review.openstack.org/49810

Change-Id: I12e6432a9e5265ebee2911b13b84c2840d775a30
2013-10-11 22:44:37 +02:00
Justin Hammond 3d44dd50c6 Updates conf reference for neutron ml2 plugin
Fixes-Bug: 1229237
Fixes-Bug: 1237662
Change-Id: I6974ea7d857b5186f39913baf43f3a8c321cc4ba
2013-10-10 13:26:31 +11:00
Tom Fifield bb680dfdc7 Update conf option tables for cinder
This re-runs the autodoc tool to generate new flagmappings for
cinder from the recent trunk. It starts to separate out
the 'storage' category into various driver components.

Change-Id: Iaa8770001fcb182403ce9f1b756d4732d06bc3f6
2013-10-07 12:30:27 +00:00
Jenkins d0e72a6852 Merge "Autogenerate neutron tables" 2013-09-24 17:10:57 +00:00
Andreas Jaeger 5936d70882 Autogenerate neutron tables
Some entries were duplicated (Related-bug: #1226464) and removed
manually.

Change-Id: Ic5d117dcde0bc9d4c4ba0efb212d13620c8565cf
2013-09-22 15:05:19 +02:00
Andreas Jaeger 9d09a0d1a2 Modularize cinder tables and use them in Config Guide
Change-Id: I21954262ba32e706e2a175fb46a45a132fbd0182
2013-09-21 14:21:46 +02:00
Jenkins db82f69bea Merge "Update cinder flags with autogenerate tools" 2013-09-20 21:00:52 +00:00
Andreas Jaeger cfbed0920a Update glance autogenerated tables
Change-Id: Ide438e97568314219e941c9085a3fa10516ef732
2013-09-19 22:35:29 +02:00
Andreas Jaeger e01c8909d0 Update cinder flags with autogenerate tools
Also create new tables cinder-backups_ceph, cinder-backup_swift,
cinder_backups_tsm, cinder-gpfs_volume so that the tables can
be used by these patches:
https://review.openstack.org/#/c/47118
https://review.openstack.org/#/c/47044/

Additional tables have been split up so that they can be used
in the configuration reference.

Change-Id: Ic87f80d4604bd9fdb5d8f9d3b0e0fe69dffb1e40
2013-09-19 20:56:44 +02:00
Andreas Jaeger da7f087c8a Update common/tables/nova*
Update via autotools

Change-Id: I7eabe9c8547ce5bc3f34922dee07de28b68bafa6
2013-09-19 16:33:54 +02:00
Tom Fifield 0930aab61a Updated nova config tables after feature freeze
Update the flagmappings after the feature freeze for nova,
and produce the new tables.

Change-Id: I6a41a4c92f793ac1f676b07e453519281136171e
2013-09-15 10:39:40 +08:00
Tom Fifield 0769c4de63 Update autogenerate tools for new directory struct
This patch fixes autogenerate tool references to directories
that will be moved during the Great Rename Of 2013

Change-Id: Ia20455d74e5bcdb172ccd09dacce5fa76c688e90
2013-09-07 12:29:27 -07:00
Tom Fifield dea0e970d1 Make swift config tables the source of truth
As discussed on the mailing list, this patch will make the swift
configuration tables found in common a source of truth for the
helptext. The script that generates them has been updated for this,
and will now only add/remove options, update default values, and
replace helptext where it does not exist in the tables. Another
run of the script was done and tables were updated.

Backstory: All projects other than Swift use OpenStack Common for
configuration, and define option, default value and help text in the
code in a way that it's possible to extract.

Since the code is able to act in this way, we can stop maintaining
separate instructive lines for configuration options, and instead
fix any text problems in the code itself. This both improves the
quality of the code and fixes our double maintenance problem.

For swift, we needed a different approach. Unfortunately, I think we
don't have the ability to treat the code as the definitive source and
move all maintenance there. The lack of instruction for every option,
and absence of structure precludes this.

So I wrote some nasty scraping things (from RST and sample conf file)
to seed an initial list of configuration options.

My plan from here was to make the 'update' portion of the script
treat the textual descriptions in common/tables/swift-*.xml as
definitive.

The script would still search the swift code to add or remove
options, so we could guarantee completeness, and after an initial
push to write out proper help text the maintenance becomes far
simpler.

Change-Id: I2464f5c63cb0da110e1871a09a59380dad9b6b27
2013-09-05 11:23:17 -07:00
Tom Fifield 298ac05625 Swift work for config reference
This patch re-works swift content for the new configuration reference
structure.

The Object Storage configuration section is pared down, with
additional/optional features moved to a new file and section of the
document - adding to what was previously there in the Object Storage
Admin Guide.

New stub sections added for drive-audit, static web and form post.

One of the big changes is the move of all option tables to
common/tables.

These have been generated with a new script which converts swift
 conf files into docbook tables, and attempts to find descriptions
of those configuration options in swift's devref documentation.

Future work for this script: merged in with the autodoc tool
structure, add an 'update' mode.

Change-Id: I75a3c442e4734594bec202fecbe4a4272d297ac7
lp:restructure-documentation
2013-08-29 10:16:23 -05:00
Jenkins 03e2cbe3ac Merge "Update flagmappings" 2013-08-17 17:54:14 +00:00
Christian Berendt 91a5ef283f strip spaces before writing the files
Without stripping the spaces tools/validate.py will not accept
the generated XML files.

Change-Id: I67d58cdf602107be05c6152eb59e4c12a2c0afd4
2013-08-13 11:03:15 +02:00
Tom Fifield 74fdfefd13 Update flagmappings
Just a quick run of the autogenerate tool to update the flagmappings and tables for
nova, cinder and neutron

Change-Id: Ic75b54480fc86780577521a7a6faec0335adf400
2013-08-13 08:56:41 +00:00
Tom Fifield eae9f5b9b5 Add Autogenerate-config-doc code to tools
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
2013-08-10 09:43:55 +08:00