Use some regexes to reduce the number of lines in .htaccess and
hopefully make it slightly clearer which groupings of files redirect to
which new locations.
Also collapse one redundant double-redirect.
Change-Id: I65c4960856985d71076291f175df17f27a5ab8cc
Adds a dependency on and invocation of the `whereto` command to validate
redirects in the .htaccess file during doc builds.
Change-Id: Ib6cc2953f0fd774de3c3a0c8a2bd6cff49667c14
$namespace = openstack.compute.v2
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
Many of these were already being generated. Some were missing a few
sub-subcommands, so those are added.
Change-Id: I1aa4b2655bafd2f6a5d83b658742f65d180eb128
$namespace = openstack.cli
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
Change-Id: I1f7e9d0e5748f887dbc35200c3c8b4407da43e0b
$namespace = openstack.common
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
This incorporates a correction to `openstack versions show`: The command
`openstack versions show --help` showed a copy/paste error, using
<region-name> for the metavar for both --service and --status. Fix.
Change-Id: I7658fed40d71f4c20ee27908ade433534657cfe5
Co-Authored-By: Pierre Prinetti <pierreprinetti@redhat.com>
Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>
The help page for network auto allocated topology had a link to a
newton-era networking guide document that has been superseded and is
now maintained in the neutron repository.
This commit adds 'neutron' to the openstackdocstheme configuration so
that the :neutron-doc: role works, and updates the link to point to the
modern version therein.
Change-Id: I5bcb40e265b22f15ff2f5ca4936160e231bb4075
$namespace = openstack.network.v2
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
This one turned out to be quite involved, because we support both
neutron and nova-network. When running in a real cloud, the command
classes detect whether the neutron service is present, assume
nova-network if that service is not found, and only add parser options
relevant to the detected service. But the docs need to present both sets
of options. This was easy enough when they were hardcoded, but required
a bit of additional infrastructure for generated docs.
Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
The command `openstack versions show --help` shows a copy-paste nit.
Change-Id: I9e4e86429ffd630c566bbdf2929e7995c9b0dbe1
Signed-off-by: Pierre Prinetti <pierreprinetti@redhat.com>
Sphinx errors have been fixed in the plugin projects for octavia, rsd,
trove, watcher, and zun, so we can now use autoprogram-cliff to generate
the docs for those.
Change-Id: Ia7790c5e86957afd0aec8f9a04ffc7aa968b4eeb
Story: #1735016
Task: #37241
A few docs still referred to launchpad, which osc hasn't used in a
couple of years. Cut over to storyboard.
Change-Id: Ic9abf0fe1e52c255976bd7a019e999a8e610455e
We would like to use autoprogram-cliff to generate full docs inline for
each plugin. But for the following projects, that breaks the build:
- octavia
- rsd
- trove
- watcher
- zun
For those projects, we're using list-plugins instead, because that
builds, and it's better than nothing; but it only provides summaries of
the commands.
So with this commit, we add a link to the plugin documentation from the
actual plugin project where such documentation exists, which currently
is just:
- octavia
- watcher
- zun
(For rsd, I couldn't find openstack-published docs at all; for trove,
published docs exist, but the osc plugin isn't documented.)
Change-Id: I7c826ecef4319bead239e11b5f975302b2f24d1b
Story: #1735016
Task: #37244
This was being omitted because whenever the plugin page was produced,
python-watcherclient wasn't in global-requirements. It is now, so
include a page for it in the plugin docs.
NOTE: We would like to use autoprogram-cliff to make the documentation
complete, but that breaks the build. For now, this is better than
nothing.
Change-Id: I49822242b9a0c031a053d6c2fd9f644a585f4ba5
Plugin documentation previously used ``.. list-plugins::`` for each
plugin command, which just produced the summary line. This might be
useful if there were also a link to the complete (per-project) docs for
the commands; but since we have the content available, we might as well
produce the complete plugin docs inline. That's going to be most useful
to a reader anyway.
So this commit switches from ``list-plugins`` to ``autoprogram-cliff``
-- except for the following, whose docs break the build when this is
done:
- octavia
- rsd
- trove
- zun
These fixups are tracked under task #37241 under this same story.
Change-Id: I2f17e203fe3da92a709884c9052c8e39ff87f4c8
Story: #1735016
Task: #37240
Once [1] fixed plugin doc generation, the (single) page it produced was
unusably huge. This commit splits it into one page per project.
Note that there are four plugin projects that didn't have sections
included:
- cue
- murano
- tripleo
- watcher
These were noted in hidden rst which is preserved in the (new) index
page.
[1] Id9be39971110fd2eb4519a0582c9bf2514cdcacd
Change-Id: I0214ddb00a5a292a46d7cfb539d6dcc540fdae79
Story: #1735016
Task: #37239
Add the osc-placement project (osc plugin for the placement service) to
the list of known plugins.
Change-Id: I77b614b38ecf872d0d93473b834994913930b76f
Documentation for plugins wasn't being generated because the plugin
projects weren't being installed in the docs environment. Add them to
doc/requirements.txt to make this work.
Change-Id: Id9be39971110fd2eb4519a0582c9bf2514cdcacd
Story: #1735016
Task: #13825
This patch introduces a new option --parent into project list,
to specify a parent project to filter projects which has
the given project as their parent.
Depends-on: https://review.opendev.org/#/c/677101
Change-Id: I6725262cf040e0ec6ceca9cf0462ce59224049c6
Add following commands:
floating ip port forwarding create
floating ip port forwarding delete
floating ip port forwarding list
floating ip port forwarding set
floating ip port forwarding show
Closes-Bug: #1811352
Change-Id: I6a5642e8acce28fc830410d4fa3180597b862761
The token_endpoint was a compatibility auth type to maintain support
for the --url global option that dated back to the beginning of
OpenStack CLI auth. The common keystoneauth library implements
'admin_token' which provides the same functionality using
--endpoint rather than --url.
Change-Id: I1b9fbb96e447889a41b705324725a2ffc8ecfd9f
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
With compute API microversion 2.53, nova-compute services
can only be deleted with the ID as a UUID to uniquely identify
the service in a multi-cell deployment. This documents that for
the "compute service delete <service>" argument. The description
of the "compute service list" command is also updated to mention
that the ID can be retrieved as a UUID using 2.53 or greater.
Change-Id: If7d4a27c0aaef588bcd77dd9edddec1e535fbf31
Story: 2005349
Task: 30302
This simply updates the docs for the compute service set --up
and --down options to mention that --os-compute-api-version 2.11
or greater is required to use those options.
Change-Id: I52891fe36c84d0df3e868ab4f3c8e2357e9ba529
When adding a security group rule, if no IP address is given
we will use '0.0.0.0/0', but if the ethertype is IPv6 we will
leave it as None. Change this to be '::/0' to match what we
do for IPv4 - use the "any" address. The neutron server
treats them both the same when checking for duplicates.
Because there are most likely entries in the DB using None
for the IP, print them as '0.0.0.0/0' or '::/0' so it is more
obvious what address they are actually referring to.
Also change to display the Ethertype column by default
instead of with --long, since easily knowing IPv4 or IPv6
is useful.
Change-Id: Ic396fc23caa66b6b0034c5d30b27c6ed499de5a6
Closes-bug: #1735575
The compute service commands emit a "Binary" in the output but
the --service filter option isn't as clear that it's the binary
(for set it is but not list) nor do the docs give an example
of a binary (typically nova-compute but could be others like
nova-conductor, nova-scheduler, etc). This simply mentions that
the --service option is the binary for "compute service list"
and gives an example value for the option in both list and set
help.
Change-Id: If87fc37352c3a251cc89041723adbe04dedf4f8a
