Commit Graph

50 Commits

Author SHA1 Message Date
Stephen Finucane d3c952064a Remove 'autogenerate_config_docs'
This tool has been superseded by the 'oslo_config.sphinxext' Sphinx
extension and can finally be put to rest.

[1] https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html

Change-Id: Idae5ba656c3a0da8a26c6f1e63332365c8012c0b
2017-10-04 11:47:56 +01:00
Stephen Finucane e90895e010 Remove swift tooling
Per the comment on change 'If0cf66aa9', we no longer track swift config
files as part of openstack-manuals. As such, we can remove the special
casing for this project.

Change-Id: I135caa57e1dcdd4114033276d89fc87c28a71aac
2017-04-11 15:54:45 +01:00
Jenkins 04d9d3b7d1 Merge "Allow overriding of openstack-manuals dir" 2017-03-21 22:37:58 +00:00
Christian Berendt eb74019d39 Add missing doc for dump in autohelp-wrapper
Change-Id: I3efa253867ddf5696cdc203a98884a9368b82d08
2017-03-14 08:52:54 +00:00
Stephen Finucane 74b981092b Allow overriding of openstack-manuals dir
I already have a (sizable) openstack-manuals repo cloned locally and it
would appear tox does not work in a nested repo. Provide a way to
override this option.

Change-Id: I4ef80825598cc7d98a4046afd5b131484e5a3469
2017-03-10 11:34:20 +00:00
Alexis Lee 855daa63f6 Remove docbook
From autohelp-wrapper and autohelp.py, as it's no longer used.

Change-Id: I44d5c37c70b8b4fc0b938b6ba0c2fed5a448c265
2016-11-22 10:20:20 +00:00
KATO Tomoyuki 9dc0ae8498 [config-ref] add murano and senlin
Change-Id: I854bdeffa3b2765837c3449e65b99f631c087148
2016-07-26 09:27:35 +09:00
ZhiQiang Fan 1b9920beed use environment variables for GITPROJ and GITBASE
Companies may have VPN, and in China, there is a firewall named
G.F.W., they both may block some protocols or ports, so if I run
autohelp-wrapper, it will fail like this:

/opt/stack/openstack-doc-tools/autogenerate_config_docs$ ./autohelp-wrapper update ceilometer
Cloning into '/opt/stack/openstack-doc-tools/autogenerate_config_docs/sources/openstack-manuals'...
fatal: unable to connect to git.openstack.org:
git.openstack.org[0: 104.130.246.128]: errno=Connection timed out
git.openstack.org[1: 2001:4800:7819:103:be76:4eff:fe06:63c]: errno=Network is unreachable

Now we have -g option, which can set GITPROJ, but GITBASE still
use git://git.openstack.org/openstack, so it still fail:

/opt/stack/openstack-doc-tools/autogenerate_config_docs$ ./autohelp-wrapper -g https://github.com/openstack update ceilometer

Here I proposal to use environment variable value for GITPROJ and
GITBASE if they exist, so some devs, like me, can get rid of
hacking autohelp-wrapper to work then restore it when commit.

Change-Id: If7dc3ebe398c71d6461a5983d4aab1bc87984697
Closes-Bug: #1574224
2016-04-25 03:03:18 +08:00
Gauvain Pocentek 87f23f539f Make diff_branches.py work again
Changes to autohelp.py have broken the diff_branches.py script. This
patch fixes the script:

- add a ``dump`` subcommand and a ``-q`` (quiet) option to
  autohelp-wrapprt
- use these options in diff_branches.py
- remove the dependency on python-git as it is not needed anymore.

Change-Id: I5d5a7e7141e1a0df1c86d52daae35fe5f33f239b
2016-03-20 18:44:17 +01:00
Gauvain Pocentek 626476352c autohelp: add zaqar to the default projects
Change-Id: I7271af8834ff29ce92cd1c20fd9864a4895f146d
2016-03-19 07:48:13 +01:00
Gauvain Pocentek 1f17e5daf6 [autohelp] Remove oslo.incubator installation
It is not needed anymore, and is causing setup problems.

Change-Id: Ie0ea8adcb621f1ff873243fa6b23aab3679f148e
2016-02-21 11:25:04 +01:00
KATO Tomoyuki cc8d24c71b Address pep8 warning at autohelp-wrapper
Change-Id: I7f44a6b47f933a01bfa5cea227988d4b17bc6a4d
2016-01-17 18:24:42 +09:00
Gauvain Pocentek e436173ae2 Move the config items in the manuals repository
Modifying configuration options (ignored modules, extra repositories,
hooks) for autohelp requires an update of the doc-tools repository,
which doesn't make much sense since the goal is to update the manuals
repository.

This patch removes the configuration options from the repository and
updates the scripts to use the configuration items in openstack-manuals.

Change-Id: I630d2a2fea690f6360039aa100331678468d18dc
2016-01-11 08:52:33 +01:00
Gauvain Pocentek e3c42a269d `autohelp update` can create the flags file
If the flagmappings file doesn't exist the function will create it,
with all the sections set to Unknown. This mimics the behavior of the
`create`, not needed anymore.

Change-Id: I7a920300b784aa8fca6412c292d807beb4d5c8e5
2016-01-08 09:09:58 +01:00
Gauvain Pocentek 69c7c929c7 autohelp-wrapper: remove leftover "fi"
Change-Id: I3c5719c55f1c210590ec07ed6605c638e190819c
2016-01-04 08:18:27 +01:00
KATO Tomoyuki c8ba535aa1 Skip non-existing test-requirements with pip install
Change-Id: I251445672b46be1e31261c56501b9180f2e1a748
Closes-Bug: #1530421
2016-01-04 05:47:07 +00:00
Gauvain Pocentek 54d05080e6 [autohelp] Simple neutron handling
* Only keep the core projects (neutron and neutron-*aas)
* Fix the installation of addition packages

Change-Id: If98405b17fe94c428812047a406c21dcf54394c3
2015-12-03 21:14:58 +01:00
Gauvain Pocentek 5c930e29bd [autohelp] misc fixes
- wrapper: upgrade setuptools in the generated venvs
- swift: read from docbook on liberty
- swift: ignore :ref: directives
- swift: remove a bogus sys.exit(0)

Change-Id: If983da606e51f39c9e331aa27c3e3598abc695fe
2015-11-25 17:09:10 +01:00
Gauvain Pocentek fca3ac6581 autohelp: add aodh to the projects list
Change-Id: I3fb09034ba1761c3e3a8e92751d99a7b5539309c
2015-11-17 08:04:52 +01:00
Gauvain Pocentek 0e8d8de022 autohelp: keep the projects names sorted
Change-Id: If8b7f0cfeef6db4666527851e4833bca9e790135
2015-11-09 05:18:38 +01:00
Jenkins 4cd707dcc4 Merge "config reference for neutron (networking-zvm)" 2015-11-08 01:51:20 +00:00
Jenkins 4e51e1a448 Merge "Update autohelp-wrapper to support RST output" 2015-10-30 13:31:09 +00:00
Gauvain Pocentek ec0626ab74 Update autohelp-wrapper to support RST output
Change-Id: If5829f7651a56f1651f4becc5af0744609d75310
2015-10-30 18:45:44 +09:00
Gauvain Pocentek 54a6522345 autohelp: use the same extension for configs
Use the .txt extension for all configuration files used by the autohelp
scripts.

Change-Id: I1c8904f977b40dbf7f60d150b3047219c96beb15
2015-10-30 18:34:36 +09:00
Atsushi SAKAI 9db6200de5 Add manila for config ref list
Change-Id: I832f788b1d2d031c63825c2b63dfeef2f60f5826
2015-10-29 22:59:56 +09:00
Atsushi SAKAI a1a7ee5842 config reference for neutron (networking-zvm)
As a workaround, networking-zvm can generate config reference
  by directory copying to neutron tree in source directory.
  
  This patch will be reverted after name space fixation
  in networking-zvm.

  currently name space header uses "neutron",
  This causes conflict with neutron itself.

Change-Id: Ia86eabf8c982431dbf6af727373349d3c2add1a9
Related-Bug: #1503967
2015-10-22 01:21:41 +00:00
Atsushi SAKAI e30f841a2b Sorting in config-reference autogeneration list for neutron
sorting
  in requirements/neutron-master.txt

  removing stackforge/networking-bigswitch
  in requirements/neutron-master.txt
     autohelp-wrapper (name space conversion)

Change-Id: I29d0465f03b21f31f76c2a81abc4db4e1ccc3e52
Related-Bug: #1503967
2015-10-20 17:35:34 +09:00
Atsushi SAKAI 3dbacea2fb Update config reference package list for neutron
This is just for update package list changes.
 Not solved config reference autogeneration problem.

 Remove stackforge package handling in autohelp-wrapper
 Remove modules
   networking-ibm (SDNVE) (It seems no maintained)
   networking-bigswitch (It seems no maintained)
   networking-portforwarding (It seems no maintained)

 Changes from stackforge to openstack
   networking-bagpipe-l2, networking-brocade,
   networking-edge-vpn, networking-hyperv,
   networking-mlnx, networking-nec, networking-ovs-dpdk,
   networking-zvm, networking-6wind

 Add
   octavia

Change-Id: I5ba3b26e110f55b2cc76f37b903a1b07dd6a1202
Related-Bug: #1503967
2015-10-19 16:23:38 +09:00
Jenkins 10aacc6bce Merge "Add neutron plugin modules for Config Reference autogen" 2015-10-14 06:13:50 +00:00
Atsushi SAKAI a846763149 Add verbose options for Config Ref generation tool
Add verbose option to pass autohelp.py from autohelp-wrapper
  You shoud use like
    autohelp-wrapper -v 1 update neutron
    autohelp-wrapper -v 2 update neutron

Change-Id: I5a22905ba357805faf850456e5e8f5e959c6ce2c
Closes-Bug: #1504389
2015-10-09 12:34:06 +09:00
Atsushi SAKAI c77c706b29 Add neutron plugin modules for Config Reference autogen
Item 1 in #1503967)
    Add extra_repos/neutron-master for many plugins
    Add extra_repos/neutron-master-stackforge for stackforge plugins
      also edit autohelp-wrapper to handle stackforge url

  Item 3 in #1503967)
    Add object name re-mapping for
     networking-midonet
     networking-hyperv
     networking-bigswitch
     networking-edge-vpn
     networking-zvm
   on autohelp-wrapper

Change-Id: Ib247fed088446c79b7d9e6a9e1adbbc931108a3b
Partial-Bug: #1503967
2015-10-08 22:39:33 +09:00
Gauvain Pocentek f5c45d41bb Updates to make diff_branches work again
This includes:
* update on requirements/neutron-kilo.txt
* update of autohelp-wrapper to make sure that dependencies are properly
  installed
* update of diff_branches.py itself (to handle the multiple -i arguments passed
  to autohelp.py

Change-Id: I099fba5d09a5e964c93d7e8c677d5556b4fa62eb
2015-08-16 08:07:04 +02:00
Gauvain Pocentek 2e63aba8ac autohelp: support reading options from multiple repos
This change modifies the -i option behavior of autohelp.py to add the
possibility to find configuration options in multiple repositories. The
change implies a few related modifications:

- do not check if the source repository is a git repository
- update autohelp-wrapper to clone and use the additional repositories
  (only for neutron at the moment)

Note: diff_branches.py will not work with this change, it'll be fixed in
another patch.

Closes-Bug: #1448107
Change-Id: I4999aca4f7926e19513acdf38f1e2828b52cee13
2015-07-23 16:49:43 +02:00
Markus Zoeller 8a8ccdfb8e let the autohelp_wrapper use local repos
The autohelp_wrapper uses as git URL for the projects the URL
git://git.openstack.org/openstack. This is not configurable.
Because of that, the build of guides (e.g. the configuration
reference) based on local (not yet commited) branches was not
possible.
This change set offers a new parameter for the script to use
another URL for the projects (e.g. to a local one).

Example:
The command to build the config options table of a local nova branch
(with the name "docs_serial_console") which is in the local folder
"~/git" would look like this:
    ./autohelp-wrapper -g ~/git -b docs_serial_console docbook nova

Change-Id: I03e5491221ac03be596b243183bdeb98c63dd03e
2015-06-03 16:23:38 +02:00
Gauvain Pocentek feba2086be Autohelp: update the scripts for the juno/kilo diff
* include sahara
* remove the keystoneclient workaround
* ignore a problematic neutron import
* handle "None" values

Change-Id: I8f342dcb39f5ddd69b73baec2ecb1f3c6883c01a
2015-04-29 15:08:56 +00:00
Gauvain Pocentek a9b5e1293b autohelp: updated to handle juno
The latest patches have broken the diff_branches script because we lost
compatibility with pre-kilo releases. This patch restores support for
juno.

Change-Id: I8b4067ca925fe4ef39d9853020f28b100054e2db
2015-04-29 17:07:21 +02:00
Gauvain Pocentek d3f4a25d43 autohelp-wrapper: reorganise project dependencies
This patch moves the explicit dependencies for projects in their own
requirement file.

Install a bunch of new neutron dependencies (drivers moved to their own
dependencies).

Change-Id: I8cab9861a5546f270499f626b06e44ad0185477d
2015-04-23 19:01:50 +02:00
Gauvain Pocentek 906d27c9f6 autohelp-wrapper: build one venv per project
To make sure that projects don't import and expose configuration options
that belong to other project we now build a virtual environment for each
project.

The script execution takes more time but the result is more accurate.

Change-Id: Ied1524de7282bca560883c3503d36a86098309b8
2015-04-23 17:55:45 +02:00
Gauvain Pocentek 12729c7275 Include ironic in the autohelp default projects
Change-Id: Id443e2c2aca3e010a2d54b739ad1fb75c6af868a
2015-01-21 19:15:29 +01:00
Gauvain Pocentek 12895f325e wrapper: clean the source dir before a checkout
Git doesn't clear folders containing untracked files when switching to
another branch. The autohelp script uses invalid .pyc files when such
switches happen in the diff_branches.py script. This change removes all
the .pyc files before a checkout to avoid this problem.

Change-Id: I0acd0308a3651b27d158546036de5cb0b42d974c
2014-09-08 06:36:47 +02:00
Andreas Jaeger 9ec7a6f6c1 Fix git checkout
If the branch does not exist locally, create it properly.
Otherwise the script will abort with freshly checkout sources.

Change-Id: I05960ed862fa61f3c9435f6749d941128812887b
2014-09-07 21:25:19 +02:00
Andreas Jaeger 0d91133bef Fix handling of arguments in autohelp-wrapper
The shift should happen after the final processing, otherwise
getopts aborts if more than one parameter is given.

Change-Id: I47e9f390cfe08404e71b26c49b02871b3b34f303
2014-09-07 09:37:12 +02:00
Andreas Jaeger b612a6d598 Add fast option to autohelp-wrapper
Add -f option that uses existing environment and sources for quick
turn around.

Change-Id: I4f7febfb95701316387c640c676fb2da24063303
2014-08-28 15:52:42 +02:00
Gauvain Pocentek 1e6eab3eab autohelp-wrapper: support the create subcommand
This subcommand generates an initial flagmappings file.

Change-Id: Ic1b3b8605ebdbbb3bd5d1852174c9d2f260b6c93
2014-08-26 07:35:31 +02:00
Gauvain Pocentek d0e1a97df9 Improve the autohelp scripts
wrapper:
- Don't modify the openstack-manuals repo if it exists, keep it as is
  git wise (no branch change, no pull)
- Install oslo.i18n and hplefthandclient
- First setup the environment, then do the update/docbook work

autohelp.py:
- Handle projects not using oslo.i18n (mostly for havana)

diff_branches.py:
- Update the output format
- Setup the venv for the requested projects only

Change-Id: I48c45a56f4b7b7298fef0b7595d62e445c92df39
2014-08-23 09:11:17 +02:00
Gauvain Pocentek 3e3beb1e57 Add sahara to the autohelp supported projects
Change-Id: I23885f3b9af3ce874b57071751a0b8006b26869c
2014-07-29 06:46:09 +02:00
Gauvain Pocentek e5d9eeea04 autohelp-wrapper: fix the extract_swift_flags call
Change-Id: Iec1b0153d5289edae45a47898c1e22b5ead3462e
2014-06-28 20:35:24 +02:00
Gauvain Pocentek 0bcd8cb2fb Include swift in the autohelp-wrapper script
Call the extract_swift_flags script when generating the docbook output.

Change-Id: Iafda3ac7f4678d4bb9eb1375e3dc6a072a9679ee
2014-06-13 22:12:18 +02:00
Gauvain Pocentek bdb2f2f003 Provide a script to gerenate options changes
diff_branches.py generates a listing of the configuration options
changes that occured between 2 openstack releases.

This involves a few changes in other tools:
- the 'dump' subcommand for autohelp.py generates the serialized dict of
  options
- add a special case for the 'bindir' option to avoid getting different
  default values in different virtual environments
- the autohelp-wrapper -e switch builds the needed venv without
  running autohelp.py commands

Change-Id: I80da172b91b8d2f0a15f89f4c812864da2fea471
2014-06-10 22:50:46 +02:00
Gauvain Pocentek da7e8c84eb Add a wrapper to simplify the autohelp.py usage
This wrapper handles the setup of a virtual env, installs the
dependencies, clones the repositories and runs the autohelp.py script.

Change-Id: I7cc65b8d458dd62ef97c8f77c9a24812d7ace374
2014-06-01 11:51:05 +02:00