summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/ec2-credentials.rst
diff options
context:
space:
mode:
authorEric Fried <openstack@fried.cc>2019-11-04 17:16:34 -0600
committerMonty Taylor <mordred@inaugust.com>2020-06-08 16:34:27 -0500
commit26878e7d53a531adb67c9ddde8fd6d3c3092ce34 (patch)
tree1ebf5ccc543312981f9861fb21e813959f82d2fd /doc/source/cli/command-objects/ec2-credentials.rst
parent00e88822e3fcb288d9fe8d019ee7d1bf8dd74630 (diff)
downloadpython-openstackclient-26878e7d53a531adb67c9ddde8fd6d3c3092ce34.tar.gz
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
Diffstat (limited to 'doc/source/cli/command-objects/ec2-credentials.rst')
-rw-r--r--doc/source/cli/command-objects/ec2-credentials.rst138
1 files changed, 0 insertions, 138 deletions
diff --git a/doc/source/cli/command-objects/ec2-credentials.rst b/doc/source/cli/command-objects/ec2-credentials.rst
deleted file mode 100644
index 9174b041..00000000
--- a/doc/source/cli/command-objects/ec2-credentials.rst
+++ /dev/null
@@ -1,138 +0,0 @@
-===============
-ec2 credentials
-===============
-
-Identity v2
-
-ec2 credentials create
-----------------------
-
-Create EC2 credentials
-
-.. program:: ec2 credentials create
-.. code-block:: bash
-
- openstack ec2 credentials create
- [--project <project>]
- [--user <user>]
- [--user-domain <user-domain>]
- [--project-domain <project-domain>]
-
-.. option:: --project <project>
-
- Create credentials in project (name or ID; default: current authenticated project)
-
-.. option:: --user <user>
-
- Create credentials for user (name or ID; default: current authenticated user)
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. option:: --project-domain <project-domain>
-
- Domain the project belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-The :option:`--project` and :option:`--user` options are typically only
-useful for admin users, but may be allowed for other users depending on
-the policy of the cloud and the roles granted to the user.
-
-ec2 credentials delete
-----------------------
-
-Delete EC2 credentials
-
-.. program:: ec2 credentials delete
-.. code-block:: bash
-
- openstack ec2 credentials delete
- [--user <user>]
- [--user-domain <user-domain>]
- <access-key> [<access-key> ...]
-
-.. option:: --user <user>
-
- Delete credentials for user (name or ID)
-
-.. option:: --user-domain <user-domain>
-
- Select user from a specific domain (name or ID)
- This can be used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. _ec2_credentials_delete-access-key:
-.. describe:: access-key
-
- Credentials access key(s)
-
-The :option:`--user` option is typically only useful for admin users, but
-may be allowed for other users depending on the policy of the cloud and
-the roles granted to the user.
-
-ec2 credentials list
---------------------
-
-List EC2 credentials
-
-.. program:: ec2 credentials list
-.. code-block:: bash
-
- openstack ec2 credentials list
- [--user <user>]
- [--user-domain <user-domain>]
-
-.. option:: --user <user>
-
- Filter list by <user> (name or ID)
-
-.. option:: --user-domain <user-domain>
-
- Select user from a specific domain (name or ID)
- This can be used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-The :option:`--user` option is typically only useful for admin users, but
-may be allowed for other users depending on the policy of the cloud and
-the roles granted to the user.
-
-ec2 credentials show
---------------------
-
-Display EC2 credentials details
-
-.. program:: ec2 credentials show
-.. code-block:: bash
-
- openstack ec2 credentials show
- [--user <user>]
- [--user-domain <user-domain>]
- <access-key>
-
-.. option:: --user <user>
-
- Show credentials for user (name or ID)
-
-.. option:: --user-domain <user-domain>
-
- Select user from a specific domain (name or ID)
- This can be used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. _ec2_credentials_show-access-key:
-.. describe:: access-key
-
- Credentials access key
-
-The :option:`--user` option is typically only useful for admin users, but
-may be allowed for other users depending on the policy of the cloud and
-the roles granted to the user.