1411 Commits

Author SHA1 Message Date
Zuul
7f08bf7577 Merge "image: autogenerate docs" 2020-06-09 02:10:31 +00:00
Zuul
09970d48e0 Merge "identity: autogenerate docs" 2020-06-09 02:10:29 +00:00
Zuul
730a8505f6 Merge "Add OpenStack Client for Manila docs" 2020-06-08 23:17:53 +00:00
Eric Fried
da3c3bde24 image: autogenerate docs
$namespace = openstack.image.v{1|2}

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.

Some reorganization happened here. The `image` subcommand name is shared
by image v1 and v2. Previously the hardcoded document had them combined
and interleaved. Attempting to preserve this with autoprogram-cliff
would have required significant additional infrastructure. However,
since most readers care completely about one and not at all about the
other, we instead split the v1 and v2 versions of these commands into
separate pages. In case links to the old pages exist in the wild, they
are preserved, but moved (with redirects) to a hidden directory, and
populated simply with links to the new version-specific generated
documents.

Change-Id: I24dc6dc10671c7f1267c27002542f61f8a3c18ae
2020-06-08 16:34:28 -05:00
Eric Fried
26878e7d53 identity: autogenerate docs
$namespace = openstack.identity.v{2|3}

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.

Special things:

- Some reorganization happened here. Certain subcommand names, such as
  `endpoint` and `project`, are shared by identify v2 and v3. Previously
  the hardcoded documents had them combined and interleaved. Attempting
  to preserve this with autoprogram-cliff would have required
  significant additional infrastructure. However, since most readers
  care completely about one and not at all about the other, we instead
  split the v2 and v3 versions of these commands into separate pages. In
  case links to the old pages exist in the wild, they are preserved, but
  moved (with redirects) to a hidden directory, and populated simply
  with links to the new version-specific generated documents.

- The `federation domain` and `federation project` subcommands were
  previously absent from the docs. They are added. These are such small
  commands and they seem related, so they're put into a single document.

- Some pages were already being generated but were listing operations
  individually instead of using wildcards (possibly because they were
  created before wildcarding was supported by cliff). These are changed
  to use wildcarding. (We want to do this wherever possible as it is
  more future-proof in the event that more operations are added to a
  subcommand later.)

- The `service provider` document was incorrectly titled `identity
  provider`. Fixed.

Change-Id: I2030f9fe370038c5908b6eb6bed9692a73fe5067
2020-06-08 16:34:27 -05:00
Maari Tamm
aa7b84fd08 Add OpenStack Client for Manila docs
This commit includes documentation about OSC
implementation for Manila.

bp openstack-client-support

Change-Id: Ic91a81e16e506103c08ef42ed0f8634a2b70e1dd
2020-06-06 15:48:10 +00:00
Zuul
57c02953ac Merge "Switch to newer openstackdocstheme and reno versions" 2020-06-05 18:32:11 +00:00
Andreas Jaeger
b5389dab02 Remove congress
Congress and python-congressclient have been retired and also
removed from global requirements, thus requirements-check job fails.

Remove congress from this repo.

Change-Id: Ibf68fee49e69264a1c46b2f456901d2620befe3c
2020-06-04 18:29:49 +02:00
Andreas Jaeger
709dfd9c21 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Set openstackdocs_auto_name to use 'project' as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Depends-On: https://review.opendev.org/729744
Change-Id: Id3989cabdbf2204821531b00149aa0f1cb8a4955
2020-05-20 21:54:12 +02:00
Zuul
790ead00bb Merge "Add resource option immutable" 2020-04-17 10:25:30 +00:00
Vishakha Agarwal
7f66273d3f Add resource option immutable
This patch adds the --immutable and --no-immutable option to the
role, project and domain CLI.

Related-Patch: https://review.opendev.org/#/c/712182/

Change-Id: I9c3bdd741f28bf558267fb217818d947597ce13e
2020-04-08 13:51:01 +00:00
Andreas Jaeger
f01a0f336c Cleanup Python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add python-requires to setup.cfg so that pypi and pip know
  about support Python version
- Remove ancient sections from setup.cfg
- Remove version_info setting from conf.py, openstackdocstheme does this
  automatically nowadays.

Change-Id: I5b9c159752c932f874015f20822862c70562c2bd
2020-03-30 20:00:41 +02:00
Vishakha Agarwal
05da145eae Adding options to user cli
User options [1] can be set by making POST and PATCH
request for /v3/users API calls but cannot by openstack
CLI because of no user options defined in create and update
user CLI [2]. This patch adds the user options [1] in
create user and update user CLI.

[1] https://docs.openstack.org/keystone/latest/admin/resource-options.html#multi-factor-auth-rules
[2] https://docs.openstack.org/api-ref/identity/v3/#create-user

Change-Id: I4e41bae2e8cfbe92d52b14d856991bedcd44164f
2020-03-26 22:24:39 +05:30
Zuul
81dcc91214 Merge "Fix faulthy state argument choice" 2020-03-24 21:34:44 +00:00
Zuul
fc12033f1d Merge "Now we can add description for role creation in OSC" 2020-03-20 18:59:44 +00:00
Zuul
9277fd471a Merge "Replace port 35357 with 5000 for "auth_url"" 2020-03-20 17:07:25 +00:00
Zuul
da7226a556 Merge "Update the content about Import Format" 2020-03-20 17:07:24 +00:00
Zuul
fdc411ad68 Merge "Update http links in docs" 2020-03-13 21:23:45 +00:00
Zuul
56f095cb2e Merge "Incorrect title for service provider" 2020-03-13 21:23:43 +00:00
huangshan
519296d762 Update http links in docs
This patch is proposed according to the Direction 10 of doc
migration(https://etherpad.openstack.org/p/doc-migration-tracking).

Change-Id: I0061bf788a8da89da0077db63f6cecf2ead0d0be
2020-03-09 21:13:29 -05:00
Zuul
e07324e30f Merge "Complete "Drop python2 support" goal" 2020-02-05 17:21:38 +00:00
Monty Taylor
e6e4b73efa Complete "Drop python2 support" goal
We stopped testing python2, but there are more things to be cleanup.

- Remove python2 entries from setup.cfg
- Add releasenotes
- remove universal wheel since this is only python 3 now

Change-Id: Ie2bbb4d34b8411939ad5cfd750fc76c933779542
2020-02-05 05:58:51 +00:00
Kendall Nelson
27b16df7f8 Remove mention of meetings from docs
Since the OpenStackClient team doesn't meet anymore, I removed
the mention of meetings and added mention of the IRC channel in the
communication section of the docs..

Change-Id: Iefa95878f95bf84bd9fc22ea4c914effc30dffa7
2020-01-28 05:54:20 +00:00
Georgina Shippey
cb265774ac Incorrect title for service provider
Mistakenly changed to identity provider.

Change-Id: I0841a6e5ebd6a27a5375a54c56fc194dff65b370
2020-01-23 15:14:16 +01:00
Colleen Murphy
70ab3f9dd5 Add support for app cred access rules
This commit introduces the --access-rules option for 'application
credential create' as well as new 'access rule' commands for listing,
showing, and deleting access rules.

bp whitelist-extension-for-app-creds

Change-Id: I04834b2874ec2a70da456a380b5bef03a392effa
2020-01-17 11:14:51 -08:00
Bram Verschueren
69870ae439
Fix faulthy state argument choice
The correct state name for a failing volume snapshot deletion is
'error_deleting' instead of 'error-deleting'. [1]

[1] 89d6a5042f/cinder/objects/fields.py (L126)

Task: #37844
Story: #2007037

Change-Id: Ia99900ece4f1cd29769b22ddaa3965789d719556
2019-12-19 09:48:17 +01:00
Eric Fried
e2d8dc0f1c Deflate .htaccess
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
2019-11-05 07:09:05 -06:00
Eric Fried
6f07828bf0 Add redirect testing
Adds a dependency on and invocation of the `whereto` command to validate
redirects in the .htaccess file during doc builds.

Change-Id: Ib6cc2953f0fd774de3c3a0c8a2bd6cff49667c14
2019-11-05 07:09:05 -06:00
Eric Fried
c6266b5ab2 compute: autogenerate docs
$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
2019-11-05 07:09:05 -06:00
Eric Fried
da56b8f4cf openstack.cli: autogenerate docs
$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
2019-11-05 07:09:05 -06:00
Eric Fried
4c0f3bfa89 common: autogenerate docs
$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>
2019-11-05 07:09:05 -06:00
Eric Fried
c7dbe85705 Update a stale doc reference to use :neutron-doc:
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
2019-11-05 07:09:05 -06:00
Zuul
d17a1c8039 Merge "neutron: autogenerate docs" 2019-11-05 00:41:31 +00:00
Zuul
d2f44e645e Merge "Use autoprogram-cliff for remaining plugin docs" 2019-11-04 22:09:27 +00:00
Eric Fried
cd6c285cc6 neutron: autogenerate docs
$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
2019-11-01 14:24:30 -05:00
Pierre Prinetti
61ad83b575
versions: Fix 'versions show' help message
The command `openstack versions show --help` shows a copy-paste nit.

Change-Id: I9e4e86429ffd630c566bbdf2929e7995c9b0dbe1
Signed-off-by: Pierre Prinetti <pierreprinetti@redhat.com>
2019-11-01 11:25:40 +01:00
Eric Fried
977b0c8591 Use autoprogram-cliff for remaining plugin docs
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
2019-10-28 14:05:37 -05:00
Zuul
45af14ca72 Merge "Doc: launchpad => storyboard" 2019-10-22 21:54:02 +00:00
Zuul
aeb094e765 Merge "Link to (some) plugin doc pages" 2019-10-22 21:43:04 +00:00
Zuul
77b5e9da35 Merge "Add plugin doc page for watcher" 2019-10-22 21:43:03 +00:00
Zuul
9974eb0453 Merge "Produce complete content for plugin docs" 2019-10-22 21:16:52 +00:00
Zuul
50325ff5ca Merge "Split plugin docs per project" 2019-10-22 21:16:49 +00:00
Zuul
e27a290087 Merge "Add placement to known plugins" 2019-10-22 21:16:47 +00:00
Zuul
86eddf701b Merge "Fix plugin autodoc generation" 2019-10-22 21:16:43 +00:00
Zuul
7e98aaefa9 Merge "Add parent project filter for listing projects" 2019-10-22 21:16:40 +00:00
Eric Fried
d0bfef807d Doc: launchpad => storyboard
A few docs still referred to launchpad, which osc hasn't used in a
couple of years. Cut over to storyboard.

Change-Id: Ic9abf0fe1e52c255976bd7a019e999a8e610455e
2019-10-22 15:13:40 -05:00
Eric Fried
fcae62841f Link to (some) plugin doc pages
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
2019-10-22 10:27:24 -05:00
Eric Fried
67a5654d49 Add plugin doc page for watcher
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
2019-10-21 18:08:41 -05:00
Eric Fried
3fd63c0021 Produce complete content for plugin docs
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
2019-10-21 17:45:35 -05:00
Eric Fried
85c83530ee Split plugin docs per project
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
2019-10-21 17:44:15 -05:00