summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/role.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/role.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/role.rst')
-rw-r--r--doc/source/cli/command-objects/role.rst312
1 files changed, 0 insertions, 312 deletions
diff --git a/doc/source/cli/command-objects/role.rst b/doc/source/cli/command-objects/role.rst
deleted file mode 100644
index f9fd28eb..00000000
--- a/doc/source/cli/command-objects/role.rst
+++ /dev/null
@@ -1,312 +0,0 @@
-====
-role
-====
-
-Identity v2, v3
-
-role add
---------
-
-Add role assignment to a user or group in a project or domain
-
-.. program:: role add
-.. code:: bash
-
- openstack role add
- --system <system> | --domain <domain> | --project <project> [--project-domain <project-domain>]
- --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
- --role-domain <role-domain>
- --inherited
- <role>
-
-.. option:: --system <system>
-
- Include <system>
-
- System or service to grant authorization to. Currently only ``all`` is
- supported which encompasses the entire deployment system.
-
- .. versionadded:: 3
-
-.. option:: --domain <domain>
-
- Include <domain> (name or ID)
-
- .. versionadded:: 3
-
-.. option:: --project <project>
-
- Include <project> (name or ID)
-
-.. option:: --user <user>
-
- Include <user> (name or ID)
-
-.. option:: --group <group>
-
- Include <group> (name or ID)
-
- .. versionadded:: 3
-
-.. 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:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID).
- This can be used in case collisions between group 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 project names exist.
-
- .. versionadded:: 3
-
-.. option:: --inherited
-
- Specifies if the role grant is inheritable to the sub projects.
-
- .. versionadded:: 3
-
-.. option:: --role-domain <role-domain>
-
- Domain the role belongs to (name or ID).
- This must be specified when the name of a domain specific role is used.
-
- .. versionadded:: 3
-
-.. describe:: <role>
-
- Role to add to <project>:<user> (name or ID)
-
-role create
------------
-
-Create new role
-
-.. program:: role create
-.. code:: bash
-
- openstack role create
- [--or-show]
- [--domain <domain>]
- [--immutable | --no-immutable]
- <name>
-
-.. option:: --domain <domain>
-
- Domain the role belongs to (name or ID).
-
- .. versionadded:: 3
-
-.. option:: --or-show
-
- Return existing role
-
- If the role already exists return the existing role data and do not fail.
-
-.. describe:: <name>
-
- New role name
-
-.. option:: --description <description>
-
- Add description about the role
-
-.. option:: --immutable
-
- Make role immutable. An immutable role may not be deleted or modified
- except to remove the immutable flag
-
-.. option:: --no-immutable
-
- Make role mutable (default)
-
-role delete
------------
-
-Delete role(s)
-
-.. program:: role delete
-.. code:: bash
-
- openstack role delete
- <role> [<role> ...]
- [--domain <domain>]
-
-.. describe:: <role>
-
- Role to delete (name or ID)
-
-.. option:: --domain <domain>
-
- Domain the role belongs to (name or ID).
-
- .. versionadded:: 3
-
-role list
----------
-
-List roles
-
-.. program:: role list
-.. code:: bash
-
- openstack role list
- [--domain <domain>]
-
-.. option:: --domain <domain>
-
- Filter roles by <domain> (name or ID)
-
- .. versionadded:: 3
-
-role remove
------------
-
-Remove role assignment from domain/project : user/group
-
-.. program:: role remove
-.. code:: bash
-
- openstack role remove
- --system <system> | --domain <domain> | --project <project> [--project-domain <project-domain>]
- --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
- --role-domain <role-domain>
- --inherited
- <role>
-
-.. option:: --system <system>
-
- Include <system>
-
- System or service to remove authorization from. Currently only ``all`` is
- supported which encompasses the entire deployment system.
-
- .. versionadded:: 3
-
-.. option:: --domain <domain>
-
- Include <domain> (name or ID)
-
- .. versionadded:: 3
-
-.. option:: --project <project>
-
- Include <project> (name or ID)
-
-.. option:: --user <user>
-
- Include <user> (name or ID)
-
-.. option:: --group <group>
-
- Include <group> (name or ID)
-
- .. versionadded:: 3
-
-.. 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:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID).
- This can be used in case collisions between group 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 project names exist.
-
- .. versionadded:: 3
-
-.. option:: --inherited
-
- Specifies if the role grant is inheritable to the sub projects.
-
- .. versionadded:: 3
-
-.. option:: --role-domain <role-domain>
-
- Domain the role belongs to (name or ID).
- This must be specified when the name of a domain specific role is used.
-
- .. versionadded:: 3
-
-.. describe:: <role>
-
- Role to remove (name or ID)
-
-role set
---------
-
-Set role properties
-
-.. versionadded:: 3
-
-.. program:: role set
-.. code:: bash
-
- openstack role set
- [--name <name>]
- [--domain <domain>]
- [--immutable | --no-immutable]
- <role>
-
-.. option:: --name <name>
-
- Set role name
-
-.. option:: --domain <domain>
-
- Domain the role belongs to (name or ID).
-
- .. versionadded:: 3
-
-.. describe:: <role>
-
- Role to modify (name or ID)
-
-.. option:: --immutable
-
- Make role immutable. An immutable role may not be deleted or modified
- except to remove the immutable flag
-
-.. option:: --no-immutable
-
- Make role mutable (default)
-
-role show
----------
-
-Display role details
-
-.. program:: role show
-.. code:: bash
-
- openstack role show
- [--domain <domain>]
- <role>
-
-.. option:: --domain <domain>
-
- Domain the role belongs to (name or ID).
-
- .. versionadded:: 3
-
-.. describe:: <role>
-
- Role to display (name or ID)