Renamed sitemap file to avoid module name conflict
when importing at the sitemap unittest
Added py.test tox environment
Change-Id: I94480e374b29802414b62591a51c04ecd804905e
Closes-Bug: #1387716
The word "automatically" sometimes makes people confused.
This patch changes the message to more accurate.
Change-Id: If7cdfff7ad2931f5ea261257868dd93d8bdbd8ff
The original command breaks the line between the
command option with hyphen.
But, it looks strange to users.
This patch addresses the issue as work around
until the upstream code will be fixed.
Change-Id: I243c3bc73c65928e893f23308dd288da5d1dc80c
Related-Bug: #1599066
- added --version option.
- added support for printing help if no options given, or if
'help' was used (i.e. 'openstack-auto-commands help')
openstack-manuals was also added to .gitignore so that
running the 'doc-tools-update-cli-reference' script will
not affect the os_doc_tools repo if the tool is run
within the repo.
Change-Id: I4c5ac6e7f207cd953040ce7b40cf1a5f13acf709
- added ability to supply multiple clients at a time.
- added flag to continue processing clients even if an error
occurs.
- fixed issue where an empty file was created if the client
wasn't found.
- fixed issue where specifying --all-api and --all-manage would
result in only --all-api being generated.
Change-Id: I8586279d884e1223ee7eb8ab12f50aa5ddc82561
- fixed issue where 'complete' generated wrong subcommands
if they were hyphenated.
- fixed issue where 'hardcoded' subcommands (in clients.yaml)
were ignored.
- added 'auth' to list of swift commands
Change-Id: If929299e38f21f3420d3fcb70a11daaa11c067bf
To use the heading level 2 for service API version,
the heading level of subcommands uses level 3.
Also, this change doesn't affect the command
that doesn't have explicit service API version description.
Change-Id: I90d0f791c01f233d8033ad17302b0fd27ea81c89
The generated nova cli-reference have a long line option
which causing jenkins error, so it is corrected
Reference: https://review.openstack.org/#/c/287587/
Change-Id: Ie762f60d37d1973c9edbe643065150b9c856865c
To improve readability, simplify the Sphinx table of contents.
For example, Positional arguments, Optional arguments.
Change-Id: I84f27cee9ce69629927e2751c702a1712d61affa
The python-troveclinet 2.0.0 has the new option
--instance "<opt=value,opt=value,...>"
on trove cluster-create.
Change-Id: I11de253d33b2051175d09e9b3e760f2055931d0e
To migrate CLI Reference from DockBook to RST,
output the documentation in RST format,
with a few work around for RST/Sphinx specific issue.
Change-Id: I32b4cfefa978436061d882f7520bbc92c1645b4e
Implements: blueprint cli-ref-rst
gnocchi commands supports complete only (not supported bash-completion)
For supporting, it adds bash-completion/complete detection
in generate_command.
Instead, it removes specify "bash-completion" in generate_subcommand.
i.e call relation is follows
generate_subcommand <= remove specify "bash-completion"
remove set subcommands
generate_command <= add method detection
newly set subcommands
discover_and_generate_subcommands
discover_subcommands <= use subcommands
for bash-completion or complete
Change-Id: Ia076114aa7fda218ed6fc349951df536e11fb710
Closes-Bug: #1514705
In patch 221559 with change id Ic3fc9ed5f3644497e4dd25a92ded01ee0224cdef,
a couple of calls to generate_subcommands() were not replaced with the
new method discover_and_generate_subcommands(). Fixing it in this patch.
Change-Id: I4f46d275a15685dc76e42b24b21b4930a94bc184
The current client reference manual contains openstackclient subcommands for
default versions of all project APIs. For identity API, the default is v2.
Which means subcommands related to "domain" and other identity v3 concepts are
not listed. This patch generates a separate section for the new openstack
subcommands obtained by using v3 identity API. Note that we list only the
diff in the new section rather than the complete subcommand list since
non-identity subcommands (e.g. neutron, glance, etc) will not vary by changing
identity API version.
An alternate solution might be to simply change identity API version to v3
instead of the current v2 and not bother about generating separate sections
for v2 and v3. I verified that v3 subcommands are not a strict superset of
v2 commands (we lose 2 subcommands). So, we need separate sections.
Change-Id: Ic3fc9ed5f3644497e4dd25a92ded01ee0224cdef
Co-Authored-By: Shashirekha Gundur <shashirekha.j.gundur@intel.com>
Closes-Bug: #1477935
* explicitly set --os-image-api-version 1
This is necessary because python-glanceclient 1.0.0 will use v2 when v2
is accessible.
* only extract subcommands from lastline of bash-completion output
This is necessary because 'glance bash-completion' outputs a
warning starting with python-glanceclient 1.0.0.
---snip---
WARNING: The client is falling back to v1 because the accessing to v2
failed. This behavior will be removed in future versions
---snap---
Change-Id: I936f5704e3badd4cb12d3d9c0753eb154bf594b2
Fix os_doc_tools/commands.py for python 3:
* check_output needs to return unicode
* Remove extra whitespace for print
Change-Id: I6edf08cf2efd3fb5dd77309d10883786a9e320de
Remove check_output that is in python 2.7 and newer but not in
python 2.6. Thus, we do not support python 2.6 anymore.
Change-Id: Ie953ce43d792b95e348a55fea4665b1ef59b468d
* new command for trove-manage
* automatically identify deprecated subcommands
* move client definitions into a YAML resource file
* support of the complete subcommand
* add new clients: barbican, designate, manila, magnetodb,
manila, mistral, tuskar
Clients to be added in the future:
* congress (module for python-openstackclient)
* magnum (no released version)
* murano (missing --version parameter)
* zaqar (module for python-openstackclient)
Change-Id: I5ccb5af887749ec22a9d980e3b031de6a247041e
* add support for bash-completion for python-glanceclient
* add missing commands for python-swiftclient
Change-Id: I495ab17e0acbf0f33c3d306ec0a5bdf0d5d41560
With the deprecation of python-keystoneclient the output of keystone
--version changed to:
DeprecationWarning: The keystone CLI is deprecated in favor of
python-openstackclient. For a Python library, continue using
python-keystoneclient. 'python-keystoneclient.', DeprecationWarning)
1.3.0
Because of that it is necessary to only handle the last line of the
output to extract the version string.
Change-Id: Ibdfaa1de4f1c8880ce1a049fec9bea3004c11fea
After the merge of I14c9479ef7ded7b7c62b0d976706e3d7e26a6cd6 the
additional parameter --os-auth-type token is used for every client. This
is wrong, the additonal parameter should only be used when generating
documentation for the python-openstackclient.
Change-Id: I801637691bfd4298859ee539c5adaf0943330836
* suppress deprecation warning messages
UserWarning: Module novaclient.v1_1 is deprecated (taken as a basis for
novaclient.v2). The preferable way to get client class or object you can
find in novaclient.client module.
warnings.warn("Module novaclient.v1_1 is deprecated (taken as a basis
for "
* use --os-auth-type token to make the openstack help command workable
ERROR: openstack Authentication type must be selected with
--os-auth-type
* add new commands
Change-Id: I14c9479ef7ded7b7c62b0d976706e3d7e26a6cd6
KATO Tomoyuki
Percila
Christian Berendt
Peter Stachowski
venkatamahesh
Atsushi SAKAI
Gauvain Pocentek
Christian Berendt
syed ahsan shamim zaidi
Deepti Ramakrishna
Andreas Jaeger
Ekaterina Chernova
Christian Berendt