summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Merge "image: autogenerate docs"Zuul2020-06-095-652/+29
|\
| * image: autogenerate docsEric Fried2020-06-085-652/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $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
* | Merge "identity: autogenerate docs"Zuul2020-06-0948-2449/+255
|\ \ | |/
| * identity: autogenerate docsEric Fried2020-06-0848-2449/+255
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $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
* | Merge "Add OpenStack Client for Manila docs"Zuul2020-06-082-0/+5
|\ \ | |/ |/|
| * Add OpenStack Client for Manila docsMaari Tamm2020-06-062-0/+5
| | | | | | | | | | | | | | | | | | This commit includes documentation about OSC implementation for Manila. bp openstack-client-support Change-Id: Ic91a81e16e506103c08ef42ed0f8634a2b70e1dd
* | Merge "Switch to newer openstackdocstheme and reno versions"Zuul2020-06-051-9/+5
|\ \
| * | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-201-9/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Remove congressAndreas Jaeger2020-06-044-10/+0
|/ / | | | | | | | | | | | | | | | | 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
* | Merge "Add resource option immutable"Zuul2020-04-172-0/+40
|\ \
| * | Add resource option immutableVishakha Agarwal2020-04-082-0/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Cleanup Python 2.7 supportAndreas Jaeger2020-03-301-13/+0
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Adding options to user cliVishakha Agarwal2020-03-261-0/+126
| | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Merge "Fix faulthy state argument choice"5.1.0Zuul2020-03-241-1/+1
|\ \ | |/ |/|
| * Fix faulthy state argument choiceBram Verschueren2019-12-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | The correct state name for a failing volume snapshot deletion is 'error_deleting' instead of 'error-deleting'. [1] [1] https://opendev.org/openstack/cinder/src/commit/89d6a5042fcb2ede5a0b1112d72fae805ea52fcd/cinder/objects/fields.py#L126 Task: #37844 Story: #2007037 Change-Id: Ia99900ece4f1cd29769b22ddaa3965789d719556
* | Merge "Now we can add description for role creation in OSC"Zuul2020-03-201-0/+4
|\ \
| * | Now we can add description for role creation in OSCM V P Nitesh2018-09-181-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now user can add the description when user create's the role using OSC ``openstack role create`` command. User can add the description by adding `--description <Description>` to OSC ``openstack role create`` command. Co-Authored-By: Deepak Mourya<deepakmoriya7@gmail.com> Change-Id: I858e004c3b29c687b6a39c8a1ed5fb029eb19c67 Depends-on: I230af9cc833af13064636b5d9a7ce6334c3f6e9a Closes-Bug: #1669080
* | | Merge "Replace port 35357 with 5000 for "auth_url""Zuul2020-03-202-7/+7
|\ \ \
| * | | Replace port 35357 with 5000 for "auth_url"Nguyen Van Duc2018-09-172-7/+7
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Based on the change in Keystone Install Guide [1], this patch replace port 35357 with 5000 for "auth_url". For more details, please check similar changes which have been done on other projects: Nova [2], Neutron [3], Cinder [4], Glance [5]. [1] https://review.openstack.org/#/c/541857 [2] https://review.openstack.org/#/c/562812 [3] https://review.openstack.org/#/c/566491 [4] https://review.openstack.org/#/c/565464 [5] https://review.openstack.org/#/c/558932 Change-Id: I4faabbb107f912c7ed1cc5d3467ea5a94197d4a0
* | | Merge "Update the content about Import Format"Zuul2020-03-201-9/+12
|\ \ \
| * | | Update the content about Import Formatchenxing2018-05-221-9/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Following by https://git.openstack.org/cgit/openstack-dev/hacking/tree/HACKING.rst#n71 Change-Id: I2f32d773c12d484e8c0e435a78a3fe16d0eeae03
* | | | Merge "Update http links in docs"Zuul2020-03-131-1/+1
|\ \ \ \
| * | | | Update http links in docshuangshan2020-03-091-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch is proposed according to the Direction 10 of doc migration(https://etherpad.openstack.org/p/doc-migration-tracking). Change-Id: I0061bf788a8da89da0077db63f6cecf2ead0d0be
* | | | | Merge "Incorrect title for service provider"Zuul2020-03-131-3/+3
|\ \ \ \ \ | |/ / / / |/| | | |
| * | | | Incorrect title for service providerGeorgina Shippey2020-01-231-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Mistakenly changed to identity provider. Change-Id: I0841a6e5ebd6a27a5375a54c56fc194dff65b370
* | | | | Remove mention of meetings from docsKendall Nelson2020-01-281-6/+5
|/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | | Add support for app cred access rulesColleen Murphy2020-01-172-0/+68
| |_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Deflate .htaccessEric Fried2019-11-051-15/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | compute: autogenerate docsEric Fried2019-11-0512-874/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $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
* | | openstack.cli: autogenerate docsEric Fried2019-11-052-29/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $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
* | | common: autogenerate docsEric Fried2019-11-057-479/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $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>
* | | Update a stale doc reference to use :neutron-doc:Eric Fried2019-11-052-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Merge "neutron: autogenerate docs"Zuul2019-11-0525-4602/+140
|\ \ \
| * | | neutron: autogenerate docsEric Fried2019-11-0125-4602/+140
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $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
* | | | Merge "Use autoprogram-cliff for remaining plugin docs"Zuul2019-11-046-34/+7
|\ \ \ \ | |/ / / |/| | |
| * | | Use autoprogram-cliff for remaining plugin docsEric Fried2019-10-286-34/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | | versions: Fix 'versions show' help messagePierre Prinetti2019-11-011-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The command `openstack versions show --help` shows a copy-paste nit. Change-Id: I9e4e86429ffd630c566bbdf2929e7995c9b0dbe1 Signed-off-by: Pierre Prinetti <pierreprinetti@redhat.com>
* | | | Merge "Doc: launchpad => storyboard"Zuul2019-10-221-5/+5
|\ \ \ \
| * | | | Doc: launchpad => storyboardEric Fried2019-10-221-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A few docs still referred to launchpad, which osc hasn't used in a couple of years. Cut over to storyboard. Change-Id: Ic9abf0fe1e52c255976bd7a019e999a8e610455e
* | | | | Merge "Link to (some) plugin doc pages"Zuul2019-10-224-0/+15
|\ \ \ \ \ | | |/ / / | |/| | |
| * | | | Link to (some) plugin doc pagesEric Fried2019-10-224-0/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | | | Merge "Add plugin doc page for watcher"Zuul2019-10-222-5/+8
|\ \ \ \ \ | |/ / / /
| * | | | Add plugin doc page for watcherEric Fried2019-10-212-5/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | | | Merge "Produce complete content for plugin docs"Zuul2019-10-2220-32/+24
|\ \ \ \ \ | |/ / / /
| * | | | Produce complete content for plugin docsEric Fried2019-10-2120-32/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | | | Merge "Split plugin docs per project"Zuul2019-10-2224-147/+153
|\ \ \ \ \ | |/ / / /
| * | | | Split plugin docs per projectEric Fried2019-10-2124-147/+153
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | | | Merge "Add placement to known plugins"Zuul2019-10-222-0/+7
|\ \ \ \ \ | |/ / / /
| * | | | Add placement to known pluginsEric Fried2019-10-212-0/+7
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | Add the osc-placement project (osc plugin for the placement service) to the list of known plugins. Change-Id: I77b614b38ecf872d0d93473b834994913930b76f
* | | | Merge "Add parent project filter for listing projects"Zuul2019-10-221-0/+7
|\ \ \ \ | |/ / / |/| | |
View Lorry Controller Status