diff options
Diffstat (limited to 'doc/source')
64 files changed, 329 insertions, 2984 deletions
diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess index 513deddb..8c0a0054 100644 --- a/doc/source/_extra/.htaccess +++ b/doc/source/_extra/.htaccess @@ -9,3 +9,8 @@ redirectmatch 301 ^/python-openstackclient/([^/]+)/specs/([^/.]+).html$ /python- redirectmatch 301 ^/python-openstackclient/([^/]+)/(command-(beta|errors|logs|options|wrappers)|developing|humaninterfaceguide|plugins).html$ /python-openstackclient/$1/contributor/$2.html redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/plugin-commands.html$ /python-openstackclient/$1/cli/plugin-commands/index.html +# For common subcommand names: +# - identity pages were split into -v2 and -v3 +# - image pages were split into -v1 and -v2 +# The unversioned page is hidden but contains links to the versioned pages so links in the wild redirect somewhere sane. +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(ec2-credentials|endpoint|image|project|role|service|token|user).html$ /python-openstackclient/$1/cli/_hidden/$2.html diff --git a/doc/source/cli/_hidden/ec2-credentials.rst b/doc/source/cli/_hidden/ec2-credentials.rst new file mode 100644 index 00000000..c54459d8 --- /dev/null +++ b/doc/source/cli/_hidden/ec2-credentials.rst @@ -0,0 +1,13 @@ +=============== +ec2 credentials +=============== + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/ec2-credentials-v2 + ../command-objects/ec2-credentials-v3 diff --git a/doc/source/cli/_hidden/endpoint.rst b/doc/source/cli/_hidden/endpoint.rst new file mode 100644 index 00000000..744e3bad --- /dev/null +++ b/doc/source/cli/_hidden/endpoint.rst @@ -0,0 +1,13 @@ +======== +endpoint +======== + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/endpoint-v2 + ../command-objects/endpoint-v3 diff --git a/doc/source/cli/_hidden/image.rst b/doc/source/cli/_hidden/image.rst new file mode 100644 index 00000000..85ffde6f --- /dev/null +++ b/doc/source/cli/_hidden/image.rst @@ -0,0 +1,13 @@ +===== +image +===== + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/image-v1 + ../command-objects/image-v2 diff --git a/doc/source/cli/_hidden/project.rst b/doc/source/cli/_hidden/project.rst new file mode 100644 index 00000000..209a3129 --- /dev/null +++ b/doc/source/cli/_hidden/project.rst @@ -0,0 +1,13 @@ +======= +project +======= + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/project-v2 + ../command-objects/project-v3 diff --git a/doc/source/cli/_hidden/role.rst b/doc/source/cli/_hidden/role.rst new file mode 100644 index 00000000..c85f4814 --- /dev/null +++ b/doc/source/cli/_hidden/role.rst @@ -0,0 +1,13 @@ +==== +role +==== + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/role-v2 + ../command-objects/role-v3 diff --git a/doc/source/cli/_hidden/service.rst b/doc/source/cli/_hidden/service.rst new file mode 100644 index 00000000..8b336386 --- /dev/null +++ b/doc/source/cli/_hidden/service.rst @@ -0,0 +1,13 @@ +======= +service +======= + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/service-v2 + ../command-objects/service-v3 diff --git a/doc/source/cli/_hidden/token.rst b/doc/source/cli/_hidden/token.rst new file mode 100644 index 00000000..6ebf801b --- /dev/null +++ b/doc/source/cli/_hidden/token.rst @@ -0,0 +1,13 @@ +===== +token +===== + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/token-v2 + ../command-objects/token-v3 diff --git a/doc/source/cli/_hidden/user.rst b/doc/source/cli/_hidden/user.rst new file mode 100644 index 00000000..34eb5995 --- /dev/null +++ b/doc/source/cli/_hidden/user.rst @@ -0,0 +1,13 @@ +==== +user +==== + +.. NOTE(efried): This page is hidden from the main TOC; it's here so links in + the wild redirect somewhere sane, because previously identity v2 and v3 were + combined in a single page. + +.. toctree:: + :maxdepth: 2 + + ../command-objects/user-v2 + ../command-objects/user-v3 diff --git a/doc/source/cli/command-objects/application-credentials.rst b/doc/source/cli/command-objects/application-credentials.rst index 047f5ab6..cef3ef0d 100644 --- a/doc/source/cli/command-objects/application-credentials.rst +++ b/doc/source/cli/command-objects/application-credentials.rst @@ -8,109 +8,6 @@ With application credentials, a user can grant their applications limited access to their cloud resources. Once created, users can authenticate with an application credential by using the ``v3applicationcredential`` auth type. -application credential create ------------------------------ -Create new application credential - -.. program:: application credential create -.. code:: bash - - openstack application credential create - [--secret <secret>] - [--role <role>] - [--expiration <expiration>] - [--description <description>] - [--restricted|--unrestricted] - [--access-rules <access-rules>] - <name> - -.. option:: --secret <secret> - - Secret to use for authentication (if not provided, one will be generated) - -.. option:: --role <role> - - Roles to authorize (name or ID) (repeat option to set multiple values) - -.. option:: --expiration <expiration> - - Sets an expiration date for the application credential (format of - YYYY-mm-ddTHH:MM:SS) - -.. option:: --description <description> - - Application credential description - -.. option:: --unrestricted - - Enable application credential to create and delete other application - credentials and trusts (this is potentially dangerous behavior and is - disabled by default) - -.. option:: --restricted - - Prohibit application credential from creating and deleting other - application credentials and trusts (this is the default behavior) - -.. option:: --access-rules - - Either a string or file path containing a JSON-formatted list of access - rules, each containing a request method, path, and service, for example - '[{"method": "GET", "path": "/v2.1/servers", "service": "compute"}]' - -.. describe:: <name> - - Name of the application credential - - -application credential delete ------------------------------ - -Delete application credential(s) - -.. program:: application credential delete -.. code:: bash - - openstack application credential delete - <application-credential> [<application-credential> ...] - -.. describe:: <application-credential> - - Application credential(s) to delete (name or ID) - -application credential list ---------------------------- - -List application credentials - -.. program:: application credential list -.. code:: bash - - openstack application credential list - [--user <user>] - [--user-domain <user-domain>] - -.. option:: --user - - User whose application credentials to list (name or ID) - -.. option:: --user-domain - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -application credential show ---------------------------- - -Display application credential details - -.. program:: application credential show -.. code:: bash - - openstack application credential show - <application-credential> - -.. describe:: <application-credential> - - Application credential to display (name or ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: application credential * diff --git a/doc/source/cli/command-objects/catalog.rst b/doc/source/cli/command-objects/catalog.rst index 6db8227e..84cd160a 100644 --- a/doc/source/cli/command-objects/catalog.rst +++ b/doc/source/cli/command-objects/catalog.rst @@ -6,7 +6,4 @@ A **catalog** lists OpenStack services that are available on the cloud. Applicable to Identity v2 and v3 .. autoprogram-cliff:: openstack.identity.v3 - :command: catalog list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: catalog show + :command: catalog * diff --git a/doc/source/cli/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst index 8f6dda0a..17cfc0c9 100644 --- a/doc/source/cli/command-objects/consumer.rst +++ b/doc/source/cli/command-objects/consumer.rst @@ -7,16 +7,4 @@ is used to create a **request token** and **access token**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: consumer create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: consumer delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: consumer list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: consumer set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: consumer show + :command: consumer * diff --git a/doc/source/cli/command-objects/credential.rst b/doc/source/cli/command-objects/credential.rst index 7fe57310..f490f1cf 100644 --- a/doc/source/cli/command-objects/credential.rst +++ b/doc/source/cli/command-objects/credential.rst @@ -4,125 +4,5 @@ credential Identity v3 -credential create ------------------ - -Create new credential - -.. program:: credential create -.. code:: bash - - openstack credential create - [--type <type>] - [--project <project>] - <user> <data> - -.. option:: --type <type> - - New credential type: cert, ec2, totp and so on - -.. option:: --project <project> - - Project which limits the scope of the credential (name or ID) - -.. _credential_create: -.. describe:: <user> - - User that owns the credential (name or ID) - -.. describe:: <data> - - New credential data - -credential delete ------------------ - -Delete credential(s) - -.. program:: credential delete -.. code:: bash - - openstack credential delete - <credential-id> [<credential-id> ...] - -.. _credential_delete: -.. describe:: <credential-id> - - ID(s) of credential to delete - -credential list ---------------- - -List credentials - -.. program:: credential list -.. code:: bash - - openstack credential list - [--user <user> [--user-domain <user-domain>]] - [--type <type>] - -.. option:: --user <user> - - Filter credentials by <user> (name or ID) - -.. option:: --user-domain <user-domain> - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. option:: --type <type> - - Filter credentials by type: cert, ec2, totp and so on - -credential set --------------- - -Set credential properties - -.. program:: credential set -.. code:: bash - - openstack credential set - [--user <user>] - [--type <type>] - [--data <data>] - [--project <project>] - <credential-id> - -.. option:: --user <user> - - User that owns the credential (name or ID) - -.. option:: --type <type> - - New credential type: cert, ec2, totp and so on. - -.. option:: --data <data> - - New credential data - -.. option:: --project <project> - - Project which limits the scope of the credential (name or ID) - -.. _credential_set: -.. describe:: <credential-id> - - ID of credential to change - -credential show ---------------- - -Display credential details - -.. program:: credential show -.. code:: bash - - openstack credential show - <credential-id> - -.. _credential_show: -.. describe:: <credential-id> - - ID of credential to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: credential * diff --git a/doc/source/cli/command-objects/ec2-credentials-v2.rst b/doc/source/cli/command-objects/ec2-credentials-v2.rst new file mode 100644 index 00000000..ace3d84e --- /dev/null +++ b/doc/source/cli/command-objects/ec2-credentials-v2.rst @@ -0,0 +1,6 @@ +============================= +ec2 credentials (Identity v2) +============================= + +.. autoprogram-cliff:: openstack.identity.v2 + :command: ec2 credentials * diff --git a/doc/source/cli/command-objects/ec2-credentials-v3.rst b/doc/source/cli/command-objects/ec2-credentials-v3.rst new file mode 100644 index 00000000..761d4280 --- /dev/null +++ b/doc/source/cli/command-objects/ec2-credentials-v3.rst @@ -0,0 +1,6 @@ +============================= +ec2 credentials (Identity v3) +============================= + +.. autoprogram-cliff:: openstack.identity.v3 + :command: ec2 credentials * 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. diff --git a/doc/source/cli/command-objects/endpoint-v2.rst b/doc/source/cli/command-objects/endpoint-v2.rst new file mode 100644 index 00000000..7badfd40 --- /dev/null +++ b/doc/source/cli/command-objects/endpoint-v2.rst @@ -0,0 +1,6 @@ +====================== +endpoint (Identity v2) +====================== + +.. autoprogram-cliff:: openstack.identity.v2 + :command: endpoint * diff --git a/doc/source/cli/command-objects/endpoint-v3.rst b/doc/source/cli/command-objects/endpoint-v3.rst new file mode 100644 index 00000000..f12063fb --- /dev/null +++ b/doc/source/cli/command-objects/endpoint-v3.rst @@ -0,0 +1,24 @@ +====================== +endpoint (Identity v3) +====================== + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint add project + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint create + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint delete + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint list + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint remove project + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint set + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint show diff --git a/doc/source/cli/command-objects/endpoint.rst b/doc/source/cli/command-objects/endpoint.rst deleted file mode 100644 index 6d025327..00000000 --- a/doc/source/cli/command-objects/endpoint.rst +++ /dev/null @@ -1,275 +0,0 @@ -======== -endpoint -======== - -Identity v2, v3 - -endpoint add project --------------------- - -Associate a project to an endpoint for endpoint filtering - -.. program:: endpoint add project -.. code:: bash - - openstack endpoint add project - [--project-domain <project-domain>] - <endpoint> - <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _endpoint_add_project-endpoint: -.. describe:: <endpoint> - - Endpoint to associate with specified project (name or ID) - -.. _endpoint_add_project-project: -.. describe:: <project> - - Project to associate with specified endpoint (name or ID) - -endpoint create ---------------- - -Create new endpoint - -*Identity version 2 only* - -.. program:: endpoint create (v2) -.. code:: bash - - openstack endpoint create - --publicurl <url> - [--adminurl <url>] - [--internalurl <url>] - [--region <region-id>] - <service> - -.. option:: --publicurl <url> - - New endpoint public URL (required) - -.. option:: --adminurl <url> - - New endpoint admin URL - -.. option:: --internalurl <url> - - New endpoint internal URL - -.. option:: --region <region-id> - - New endpoint region ID - -.. _endpoint_create-endpoint: -.. describe:: <service> - - Service to be associated with new endpoint (name or ID) - -*Identity version 3 only* - -.. program:: endpoint create (v3) -.. code:: bash - - openstack endpoint create - [--region <region-id>] - [--enable | --disable] - <service> - <interface> - <url> - -.. option:: --region <region-id> - - New endpoint region ID - -.. option:: --enable - - Enable endpoint (default) - -.. option:: --disable - - Disable endpoint - -.. describe:: <service> - - Service to be associated with new endpoint(name or ID) - -.. describe:: <interface> - - New endpoint interface type (admin, public or internal) - -.. describe:: <url> - - New endpoint URL - -endpoint delete ---------------- - -Delete endpoint(s) - -.. program:: endpoint delete -.. code:: bash - - openstack endpoint delete - <endpoint-id> [<endpoint-id> ...] - -.. _endpoint_delete-endpoint: -.. describe:: <endpoint-id> - - Endpoint(s) to delete (ID only) - -endpoint list -------------- - -List endpoints - -.. program:: endpoint list -.. code:: bash - - openstack endpoint list - [--service <service>] - [--interface <interface>] - [--region <region-id>] - [--long] - [--endpoint <endpoint> | - --project <project> [--project-domain <project-domain>]] - -.. option:: --service <service> - - Filter by service (type, name or ID) - - *Identity version 3 only* - -.. option:: --interface <interface> - - Filter by interface type (admin, public or internal) - - *Identity version 3 only* - -.. option:: --region <region-id> - - Filter by region ID - - *Identity version 3 only* - -.. option:: --long - - List additional fields in output - - *Identity version 2 only* - -.. option:: --endpoint - - List projects that have access to that endpoint using - endpoint filtering - - *Identity version 3 only* - -.. option:: --project - - List endpoints available for the project using - endpoint filtering - - *Identity version 3 only* - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - *Identity version 3 only* - -endpoint remove project ------------------------ - -Dissociate a project from an endpoint. - -.. program:: endpoint remove project -.. code:: bash - - openstack endpoint remove project - [--project-domain <project-domain>] - <endpoint> - <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _endpoint_remove_project-endpoint: -.. describe:: <endpoint> - - Endpoint to dissociate with specified project (name or ID) - -.. _endpoint_remove_project-project: -.. describe:: <project> - - Project to dissociate with specified endpoint (name or ID) - -endpoint set ------------- - -Set endpoint properties - -*Identity version 3 only* - -.. program:: endpoint set -.. code:: bash - - openstack endpoint set - [--region <region-id>] - [--interface <interface>] - [--url <url>] - [--service <service>] - [--enable | --disable] - <endpoint-id> - -.. option:: --region <region-id> - - New endpoint region ID - -.. option:: --interface <interface> - - New endpoint interface type (admin, public or internal) - -.. option:: --url <url> - - New endpoint URL - -.. option:: --service <service> - - New endpoint service (name or ID) - -.. option:: --enable - - Enable endpoint - -.. option:: --disable - - Disable endpoint - -.. _endpoint_set-endpoint: -.. describe:: <endpoint-id> - - Endpoint to modify (ID only) - -endpoint show -------------- - -Display endpoint details - -.. program:: endpoint show -.. code:: bash - - openstack endpoint show - <endpoint> - -.. _endpoint_show-endpoint: -.. describe:: <endpoint> - - Endpoint to display (endpoint ID, service ID, service name, service type) diff --git a/doc/source/cli/command-objects/endpoint_group.rst b/doc/source/cli/command-objects/endpoint_group.rst index ccfe5f66..b0d988e1 100644 --- a/doc/source/cli/command-objects/endpoint_group.rst +++ b/doc/source/cli/command-objects/endpoint_group.rst @@ -7,22 +7,4 @@ can be used to filter the endpoints that are available to a project. Applicable to Identity v3 .. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group add project - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group remove project - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group show + :command: endpoint group * diff --git a/doc/source/cli/command-objects/federation-domain-project.rst b/doc/source/cli/command-objects/federation-domain-project.rst new file mode 100644 index 00000000..68db5705 --- /dev/null +++ b/doc/source/cli/command-objects/federation-domain-project.rst @@ -0,0 +1,11 @@ +========================= +federation domain/project +========================= + +Identity v3 + +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation domain * + +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation project * diff --git a/doc/source/cli/command-objects/federation-protocol.rst b/doc/source/cli/command-objects/federation-protocol.rst index 3a99fd72..81b3f9fc 100644 --- a/doc/source/cli/command-objects/federation-protocol.rst +++ b/doc/source/cli/command-objects/federation-protocol.rst @@ -7,16 +7,4 @@ extension. It is used by **identity providers** and **mappings**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: federation protocol create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: federation protocol delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: federation protocol list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: federation protocol set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: federation protocol show + :command: federation protocol * diff --git a/doc/source/cli/command-objects/group.rst b/doc/source/cli/command-objects/group.rst index ac938efd..a1071069 100644 --- a/doc/source/cli/command-objects/group.rst +++ b/doc/source/cli/command-objects/group.rst @@ -4,246 +4,5 @@ group Identity v3 -group add user --------------- - -Add user to group - -.. program:: group add user -.. code:: bash - - openstack group add user - [--group-domain <group-domain>] - [--user-domain <user-domain>] - <group> - <user> [<user> ...] - -.. 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:: --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 - -.. describe:: <group> - - Group to contain <user> (name or ID) - -.. describe:: <user> - - User(s) to add to <group> (name or ID) - (repeat option to add multiple users) - -group contains user -------------------- - -Check user membership in group - -.. program:: group contains user -.. code:: bash - - openstack group contains user - [--group-domain <group-domain>] - [--user-domain <user-domain>] - <group> - <user> - -.. 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:: --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 - -.. describe:: <group> - - Group to check (name or ID) - -.. describe:: <user> - - User to check (name or ID) - -group create ------------- - -Create new group - -.. program:: group create -.. code:: bash - - openstack group create - [--domain <domain>] - [--description <description>] - [--or-show] - <group-name> - -.. option:: --domain <domain> - - Domain to contain new group (name or ID) - -.. option:: --description <description> - - New group description - -.. option:: --or-show - - Return existing group - - If the group already exists, return the existing group data and do not fail. - -.. describe:: <group-name> - - New group name - -group delete ------------- - -Delete group - -.. program:: group delete -.. code:: bash - - openstack group delete - [--domain <domain>] - <group> [<group> ...] - -.. option:: --domain <domain> - - Domain containing group(s) (name or ID) - -.. describe:: <group> - - Group(s) to delete (name or ID) - -group list ----------- - -List groups - -.. program:: group list -.. code:: bash - - openstack group list - [--domain <domain>] - [--user <user> [--user-domain <user-domain>]] - [--long] - -.. option:: --domain <domain> - - Filter group list by <domain> (name or ID) - -.. option:: --user <user> - - Filter group list by <user> (name or ID) - -.. 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:: --long - - List additional fields in output - -group remove user ------------------ - -Remove user from group - -.. program:: group remove user -.. code:: bash - - openstack group remove user - [--group-domain <group-domain>] - [--user-domain <user-domain>] - <group> - <user> [<user> ...] - -.. 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:: --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 - -.. describe:: <group> - - Group containing <user> (name or ID) - -.. describe:: <user> - - User(s) to remove from <group> (name or ID) - (repeat option to remove multiple users) - -group set ---------- - -Set group properties - -.. program:: group set -.. code:: bash - - openstack group set - [--domain <domain>] - [--name <name>] - [--description <description>] - <group> - -.. option:: --domain <domain> - - Domain containing <group> (name or ID) - -.. option:: --name <name> - - New group name - -.. option:: --description <description> - - New group description - -.. describe:: <group> - - Group to modify (name or ID) - -group show ----------- - -Display group details - -.. program:: group show -.. code:: bash - - openstack group show - [--domain <domain>] - <group> - -.. option:: --domain <domain> - - Domain containing <group> (name or ID) - -.. describe:: <group> - - Group to display (name or ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: group * diff --git a/doc/source/cli/command-objects/identity-provider.rst b/doc/source/cli/command-objects/identity-provider.rst index 36c9264a..ed85cb7a 100644 --- a/doc/source/cli/command-objects/identity-provider.rst +++ b/doc/source/cli/command-objects/identity-provider.rst @@ -7,16 +7,4 @@ extension. It is used by **federation protocols** and **mappings**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: identity provider create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: identity provider delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: identity provider list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: identity provider set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: identity provider show + :command: identity provider * diff --git a/doc/source/cli/command-objects/image-v1.rst b/doc/source/cli/command-objects/image-v1.rst new file mode 100644 index 00000000..4f7edc43 --- /dev/null +++ b/doc/source/cli/command-objects/image-v1.rst @@ -0,0 +1,6 @@ +======== +image v1 +======== + +.. autoprogram-cliff:: openstack.image.v1 + :command: image * diff --git a/doc/source/cli/command-objects/image-v2.rst b/doc/source/cli/command-objects/image-v2.rst new file mode 100644 index 00000000..473b26d0 --- /dev/null +++ b/doc/source/cli/command-objects/image-v2.rst @@ -0,0 +1,6 @@ +======== +image v2 +======== + +.. autoprogram-cliff:: openstack.image.v2 + :command: image * diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst deleted file mode 100644 index 459a0770..00000000 --- a/doc/source/cli/command-objects/image.rst +++ /dev/null @@ -1,650 +0,0 @@ -===== -image -===== - -Image v1, v2 - -image add project ------------------ - -*Only supported for Image v2* - -Associate project with image - -.. program:: image add project -.. code:: bash - - openstack image add project - [--project-domain <project-domain>] - <image> - <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _image_add_project-image: -.. describe:: <image> - - Image to share (name or ID). - -.. _image_add_project-project: -.. describe:: <project> - - Project to associate with image (ID) - -image create ------------- - -*Image v1, v2* - -Create/upload an image - -.. program:: image create -.. code:: bash - - openstack image create - [--id <id>] - [--store <store>] - [--container-format <container-format>] - [--disk-format <disk-format>] - [--size <size>] - [--min-disk <disk-gb>] - [--min-ram <ram-mb>] - [--location <image-url>] - [--copy-from <image-url>] - [--file <file> | --volume <volume>] - [--force] - [--checksum <checksum>] - [--protected | --unprotected] - [--public | --private | --community | --shared] - [--property <key=value> [...] ] - [--tag <tag> [...] ] - [--project <project>] - [--project-domain <project-domain>] - <image-name> - -.. option:: --id <id> - - Image ID to reserve - -.. option:: --store <store> - - Upload image to this store - - *Image version 1 only.* - -.. option:: --container-format <container-format> - - Image container format. The supported options are: ami, ari, aki, - bare, docker, ova, ovf. The default format is: bare - -.. option:: --disk-format <disk-format> - - Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, - raw, qcow2, vhdx, vdi, iso, and ploop. The default format is: raw - -.. option:: --size <size> - - Image size, in bytes (only used with :option:`--location` and :option:`--copy-from`) - - *Image version 1 only.* - -.. option:: --min-disk <disk-gb> - - Minimum disk size needed to boot image, in gigabytes - -.. option:: --min-ram <ram-mb> - - Minimum RAM size needed to boot image, in megabytes - -.. option:: --location <image-url> - - Download image from an existing URL - - *Image version 1 only.* - -.. option:: --copy-from <image-url> - - Copy image from the data store (similar to :option:`--location`) - - *Image version 1 only.* - -.. option:: --file <file> - - Upload image from local file - -.. option:: --volume <volume> - - Create image from a volume - -.. option:: --force - - Force image creation if volume is in use (only meaningful with :option:`--volume`) - -.. option:: --checksum <checksum> - - Image hash used for verification - - *Image version 1 only.* - -.. option:: --protected - - Prevent image from being deleted - -.. option:: --unprotected - - Allow image to be deleted (default) - -.. option:: --public - - Image is accessible to the public - -.. option:: --private - - Image is inaccessible to the public (default) - -.. option:: --community - - Image is accessible to the community - -.. option:: --shared - - Image can be shared - -.. option:: --property <key=value> - - Set a property on this image (repeat option to set multiple properties) - -.. option:: --tag <tag> - - Set a tag on this image (repeat option to set multiple tags) - - .. versionadded:: 2 - -.. option:: --project <project> - - Set an alternate project on this image (name or ID). - Previously known as `--owner`. - -.. 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:: 2 - -.. _image_create-image-name: -.. describe:: <image-name> - - New image name - -image delete ------------- - -Delete image(s) - -.. program:: image delete -.. code:: bash - - openstack image delete - <image> - -.. _image_delete-image: -.. describe:: <image> - - Image(s) to delete (name or ID) - -image list ----------- - -List available images - -.. program:: image list -.. code:: bash - - openstack image list - [--public | --private | --community | --shared] - [--property <key=value>] - [--name <name>] - [--status <status>] - [--member-status <member-status>] - [--tag <tag>] - [--long] - [--sort <key>[:<direction>]] - [--limit <num-images>] - [--marker <image>] - -.. option:: --public - - List only public images - -.. option:: --private - - List only private images - -.. option:: --community - - List only community images - - *Image version 2 only.* - -.. option:: --shared - - List only shared images - - *Image version 2 only.* - -.. option:: --property <key=value> - - Filter output based on property - -.. option:: --name <name> - - Filter images based on name - - *Image version 2 only.* - -.. option:: --status <status> - - Filter images based on status - - *Image version 2 only* - -.. option:: --member-status <member-status> - - Filter images based on member status - - *Image version 2 only* - -.. option:: --tag <tag> - - Filter images based on tag - - *Image version 2 only* - -.. option:: --long - - List additional fields in output - -.. option:: --sort <key>[:<direction>] - - Sort output by selected keys and directions(asc or desc) (default: name:asc), - multiple keys and directions can be specified separated by comma - -.. option:: --limit <num-images> - - Maximum number of images to display. - - *Image version 2 only* - -.. option:: --marker <image> - - The last image of the previous page. Display list of images - after marker. Display all images if not specified. (name or ID) - - *Image version 2 only* - -image member list ------------------ - -List projects associated with image - -.. program:: image member list -.. code:: bash - - openstack image member list - <image> - -.. _image_member_list-image: -.. describe:: <image> - - Image(s) to view members for (name or ID) - -image remove project --------------------- - -*Only supported for Image v2* - -Disassociate project with image - -.. program:: image remove project -.. code:: bash - - openstack image remove project - [--project-domain <project-domain>] - <image> - <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _image_remove_project: -.. describe:: <image> - - Image to unshare (name or ID). - -.. describe:: <project> - - Project to disassociate with image (name or ID) - -image save ----------- - -Save an image locally - -.. program:: image save -.. code:: bash - - openstack image save - --file <filename> - <image> - -.. option:: --file <filename> - - Downloaded image save filename (default: stdout) - -.. _image_save-image: -.. describe:: <image> - - Image to save (name or ID) - -image set ---------- - -*Image v1, v2* - -Set image properties - -.. program:: image set -.. code:: bash - - openstack image set - [--name <name>] - [--min-disk <disk-gb>] - [--min-ram <ram-mb>] - [--container-format <container-format>] - [--disk-format <disk-format>] - [--size <size>] - [--protected | --unprotected] - [--public | --private | --community | --shared] - [--store <store>] - [--location <image-url>] - [--copy-from <image-url>] - [--file <file>] - [--volume <volume>] - [--force] - [--checksum <checksum>] - [--stdin] - [--property <key=value> [...] ] - [--tag <tag> [...] ] - [--architecture <architecture>] - [--instance-id <instance-id>] - [--kernel-id <kernel-id>] - [--os-distro <os-distro>] - [--os-version <os-version>] - [--ramdisk-id <ramdisk-id>] - [--deactivate | --activate] - [--project <project>] - [--project-domain <project-domain>] - [--accept | --reject | --pending] - <image> - -.. option:: --name <name> - - New image name - -.. option:: --min-disk <disk-gb> - - Minimum disk size needed to boot image, in gigabytes - -.. option:: --min-ram <ram-mb> - - Minimum RAM size needed to boot image, in megabytes - -.. option:: --container-format <container-format> - - Image container format. The supported options are: ami, ari, aki, - bare, docker, ova, ovf. - -.. option:: --disk-format <disk-format> - - Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, - raw, qcow2, vhdx, vdi, iso, and ploop. - -.. option:: --size <size> - - Size of image data (in bytes) - - *Image version 1 only.* - -.. option:: --protected - - Prevent image from being deleted - -.. option:: --unprotected - - Allow image to be deleted (default) - -.. option:: --public - - Image is accessible to the public - -.. option:: --private - - Image is inaccessible to the public (default) - -.. option:: --community - - Image is accessible to the community - -.. option:: --shared - - Image can be shared - -.. option:: --store <store> - - Upload image to this store - - *Image version 1 only.* - -.. option:: --location <image-url> - - Download image from an existing URL - - *Image version 1 only.* - -.. option:: --copy-from <image-url> - - Copy image from the data store (similar to :option:`--location`) - - *Image version 1 only.* - -.. option:: --file <file> - - Upload image from local file - - *Image version 1 only.* - -.. option:: --volume <volume> - - Update image with a volume - - *Image version 1 only.* - -.. option:: --force - - Force image update if volume is in use (only meaningful with :option:`--volume`) - - *Image version 1 only.* - -.. option:: --checksum <checksum> - - Image hash used for verification - - *Image version 1 only.* - -.. option:: --stdin - - Allow to read image data from standard input - - *Image version 1 only.* - -.. option:: --property <key=value> - - Set a property on this image (repeat option to set multiple properties) - - .. versionadded:: 2 - -.. option:: --tag <tag> - - Set a tag on this image (repeat option to set multiple tags) - - .. versionadded:: 2 - -.. option:: --architecture <architecture> - - Operating system architecture - - .. versionadded:: 2 - -.. option:: --instance-id <instance-id> - - ID of server instance used to create this image - - .. versionadded:: 2 - -.. option:: --kernel-id <kernel-id> - - ID of kernel image used to boot this disk image - - .. versionadded:: 2 - -.. option:: --os-distro <os-distro> - - Operating system distribution name - - .. versionadded:: 2 - -.. option:: --os-version <os-version> - - Operating system distribution version - - .. versionadded:: 2 - -.. option:: --ramdisk-id <ramdisk-id> - - ID of ramdisk image used to boot this disk image - - .. versionadded:: 2 - -.. option:: --deactivate - - Deactivate the image. - - .. versionadded:: 2 - -.. option:: --activate - - Activate the image. - - .. versionadded:: 2 - -.. option:: --project <project> - - Set an alternate project on this image (name or ID). - Previously known as `--owner`. - -.. 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:: 2 - -.. option:: --accept - - Accept the image membership. - - If `--project` is passed, this will update the membership status for the - given project, otherwise `--project` will default to the project the user - is authenticated to. - - .. versionadded:: 2 - -.. option:: --reject - - Reject the image membership. - - If `--project` is passed, this will update the membership status for the - given project, otherwise `--project` will default to the project the user - is authenticated to. - - .. versionadded:: 2 - -.. option:: --pending - - Reset the image membership to 'pending'. - - If `--project` is passed, this will update the membership status for the - given project, otherwise `--project` will default to the project the user - is authenticated to. - - .. versionadded:: 2 - -.. _image_set-image: -.. describe:: <image> - - Image to modify (name or ID) - -image show ----------- - -Display image details - -.. program:: image show -.. code:: bash - - openstack image show - [--human-readable] - <image> - -.. option:: --human-readable - - Print image size in a human-friendly format. - -.. _image_show-image: -.. describe:: <image> - - Image to display (name or ID) - -image unset ------------ - -*Only supported for Image v2* - -Unset image tags or properties - -.. program:: image unset -.. code:: bash - - openstack image unset - [--tag <tag>] - [--property <property-key>] - <image> - -.. option:: --tag <tag> - - Unset a tag on this image (repeat option to unset multiple tags) - -.. option:: --property <property-key> - - Unset a property on this image (repeat option to unset multiple properties) - -.. _image_unset-image: -.. describe:: <image> - - Image to modify (name or ID) diff --git a/doc/source/cli/command-objects/implied_role.rst b/doc/source/cli/command-objects/implied_role.rst index e43c9ea3..09532c0b 100644 --- a/doc/source/cli/command-objects/implied_role.rst +++ b/doc/source/cli/command-objects/implied_role.rst @@ -4,54 +4,5 @@ implied role Identity v3 - -implied role create -------------------- - -Creates an association between prior and implied roles - -.. program:: implied role create -.. code:: bash - - openstack implied role create - <role> - --implied-role <role> - -.. option:: <role> - - Prior role <role> (name or ID) implies another role - -.. option:: --implied-role <role> - - <role> (name or ID) implied by another role - - -implied role delete -------------------- - -Deletes an association between prior and implied roles - -.. program:: implied role delete -.. code:: bash - - openstack implied role delete - <role> - --implied-role <role> - -.. option:: <role> - - Prior role <role> (name or ID) implies another role - -.. option:: --implied-role <role> - - <role> (name or ID) implied by another role - -implied role list ------------------ - -List implied roles - -.. program:: implied role list -.. code:: bash - - openstack implied role list +.. autoprogram-cliff:: openstack.identity.v3 + :command: implied role * diff --git a/doc/source/cli/command-objects/limit.rst b/doc/source/cli/command-objects/limit.rst index 46da6c1b..784d0cb4 100644 --- a/doc/source/cli/command-objects/limit.rst +++ b/doc/source/cli/command-objects/limit.rst @@ -6,128 +6,5 @@ Identity v3 Limits are used to specify project-specific limits thresholds of resources. -limit create ------------- - -Create a new limit - -.. program:: limit create -.. code:: bash - - openstack limit create - [--description <description>] - [--region <region>] - --project <project> - --service <service> - --resource-limit <resource-limit> - <resource-name> - -.. option:: --description <description> - - Useful description of the limit or its purpose - -.. option:: --region <region> - - Region that the limit should be applied to - -.. describe:: --project <project> - - The project that the limit applies to (required) - -.. describe:: --service <service> - - The service that is responsible for the resource being limited (required) - -.. describe:: --resource-limit <resource-limit> - - The limit to apply to the project (required) - -.. describe:: <resource-name> - - The name of the resource to limit (e.g. cores or volumes) - -limit delete ------------- - -Delete project-specific limit(s) - -.. program:: limit delete -.. code:: bash - - openstack limit delete - <limit-id> [<limit-id> ...] - -.. describe:: <limit-id> - - Limit(s) to delete (ID) - -limit list ----------- - -List project-specific limits - -.. program:: limit list -.. code:: bash - - openstack limit list - [--service <service>] - [--resource-name <resource-name>] - [--region <region>] - [--project <project>] - -.. option:: --service <service> - - The service to filter the response by (name or ID) - -.. option:: --resource-name <resource-name> - - The name of the resource to filter the response by - -.. option:: --region <region> - - The region name to filter the response by - -.. option:: --project <project> - - List resource limits associated with project - -limit show ----------- - -Display details about a limit - -.. program:: limit show -.. code:: bash - - openstack limit show - <limit-id> - -.. describe:: <limit-id> - - Limit to display (ID) - -limit set ---------- - -Update a limit - -.. program:: limit show -.. code:: bash - - openstack limit set - [--description <description>] - [--resource-limit <resource-limit>] - <limit-id> - - -.. option:: --description <description> - - Useful description of the limit or its purpose - -.. option:: --resource-limit <resource-limit> - - The limit to apply to the project - -.. describe:: <limit-id> - - Limit to update (ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: limit * diff --git a/doc/source/cli/command-objects/mapping.rst b/doc/source/cli/command-objects/mapping.rst index 73dbbc8d..5653b52b 100644 --- a/doc/source/cli/command-objects/mapping.rst +++ b/doc/source/cli/command-objects/mapping.rst @@ -7,16 +7,4 @@ extension. It is used by **federation protocols** and **identity providers**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: mapping create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: mapping delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: mapping list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: mapping set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: mapping show + :command: mapping *
\ No newline at end of file diff --git a/doc/source/cli/command-objects/policy.rst b/doc/source/cli/command-objects/policy.rst index 0fe104c5..66bc2545 100644 --- a/doc/source/cli/command-objects/policy.rst +++ b/doc/source/cli/command-objects/policy.rst @@ -6,16 +6,4 @@ A **policy** is an arbitrarily serialized policy engine rule set to be consumed by a remote service. Applies to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: policy create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: policy delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: policy list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: policy set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: policy show + :command: policy * diff --git a/doc/source/cli/command-objects/project-v2.rst b/doc/source/cli/command-objects/project-v2.rst new file mode 100644 index 00000000..502154d3 --- /dev/null +++ b/doc/source/cli/command-objects/project-v2.rst @@ -0,0 +1,6 @@ +===================== +project (Identity v2) +===================== + +.. autoprogram-cliff:: openstack.identity.v2 + :command: project * diff --git a/doc/source/cli/command-objects/project-v3.rst b/doc/source/cli/command-objects/project-v3.rst new file mode 100644 index 00000000..9bee6ae8 --- /dev/null +++ b/doc/source/cli/command-objects/project-v3.rst @@ -0,0 +1,6 @@ +===================== +project (Identity v3) +===================== + +.. autoprogram-cliff:: openstack.identity.v3 + :command: project * diff --git a/doc/source/cli/command-objects/project.rst b/doc/source/cli/command-objects/project.rst deleted file mode 100644 index ac7e8cd1..00000000 --- a/doc/source/cli/command-objects/project.rst +++ /dev/null @@ -1,277 +0,0 @@ -======= -project -======= - -Identity v2, v3 - -project create --------------- - -Create new project - -.. program:: project create -.. code:: bash - - openstack project create - [--domain <domain>] - [--parent <project>] - [--description <description>] - [--enable | --disable] - [--property <key=value>] - [--or-show] - [--tag <tag>] - <name> - -.. option:: --domain <domain> - - Domain owning the project (name or ID) - - .. versionadded:: 3 - -.. option:: --parent <project> - - Parent of the project (name or ID) - - .. versionadded:: 3 - -.. option:: --description <description> - - Project description - -.. option:: --enable - - Enable project (default) - -.. option:: --disable - - Disable project - -.. option:: --property <key=value> - - Add a property to :ref:`\<name\> <project_create-name>` - (repeat option to set multiple properties) - -.. option:: --or-show - - Return existing project - - If the project already exists return the existing project data and do not fail. - -.. option:: --tag - - Add a tag to the project - (repeat option to set multiple tags) - - .. versionadded:: 3 - -.. _project_create-name: -.. describe:: <name> - - New project name - -project delete --------------- - -Delete project(s) - -.. program:: project delete -.. code:: bash - - openstack project delete - [--domain <domain>] - <project> [<project> ...] - -.. option:: --domain <domain> - - Domain owning :ref:`\<project\> <project_delete-project>` (name or ID) - - .. versionadded:: 3 - -.. _project_delete-project: -.. describe:: <project> - - Project to delete (name or ID) - -project list ------------- - -List projects - -.. program:: project list -.. code:: bash - - openstack project list - [--domain <domain>] - [--parent <parent>] - [--user <user>] - [--my-projects] - [--long] - [--sort <key>[:<direction>,<key>:<direction>,..]] - [--tags <tag>[,<tag>,...]] [--tags-any <tag>[,<tag>,...]] - [--not-tags <tag>[,<tag>,...]] [--not-tags-any <tag>[,<tag>,...]] - -.. option:: --domain <domain> - - Filter projects by :option:`\<domain\> <--domain>` (name or ID) - - .. versionadded:: 3 - -.. option:: --parent <parent> - - Filter projects whose parent is :option:`\<parent\> <--parent>` (name or ID) - - .. versionadded:: 3 - -.. option:: --user <user> - - Filter projects by :option:`\<user\> <--user>` (name or ID) - - .. versionadded:: 3 - -.. option:: --my-projects - - List projects for the authenticated user. Supersedes other filters. - - .. versionadded:: 3 - -.. option:: --long - - List additional fields in output - -.. option:: --sort <key>[:<direction>,<key>:<direction>,..] - - Sort output by selected keys and directions (asc or desc) (default: asc), - multiple keys and directions can be specified --sort - <key>[:<direction>,<key>:<direction>,..] - -.. option:: --tags <tag>[,<tag>,...] - - List projects which have all given tag(s) - - .. versionadded:: 3 - -.. option:: --tags-any <tag>[,<tag>,...] - - List projects which have any given tag(s) - - .. versionadded:: 3 - -.. option:: --not-tags <tag>[,<tag>,...] - - Exclude projects which have all given tag(s) - - .. versionadded:: 3 - -.. option:: --not-tags-any <tag>[,<tag>,...] - - Exclude projects which have any given tag(s) - - .. versionadded:: 3 - -project set ------------ - -Set project properties - -.. program:: project set -.. code:: bash - - openstack project set - [--name <name>] - [--domain <domain>] - [--description <description>] - [--enable | --disable] - [--property <key=value>] - [--tag <tag> | --clear-tags | --remove-tags <tag>] - <project> - -.. option:: --name <name> - - Set project name - -.. option:: --domain <domain> - - Domain owning :ref:`\<project\> <project_set-project>` (name or ID) - - .. versionadded:: 3 - -.. option:: --description <description> - - Set project description - -.. option:: --enable - - Enable project (default) - -.. option:: --disable - - Disable project - -.. option:: --property <key=value> - - Set a property on :ref:`\<project\> <project_set-project>` - (repeat option to set multiple properties) - - *Identity version 2 only* - -.. _project_set-project: -.. describe:: <project> - - Project to modify (name or ID) - -project show ------------- - -Display project details - -.. program:: project show -.. code:: bash - - openstack project show - [--domain <domain>] - <project> - -.. option:: --domain <domain> - - Domain owning :ref:`\<project\> <project_show-project>` (name or ID) - - .. versionadded:: 3 - -.. option:: --parents - - Show the project\'s parents as a list - - .. versionadded:: 3 - -.. option:: --children - - Show project\'s subtree (children) as a list - - .. versionadded:: 3 - -.. _project_show-project: -.. describe:: <project> - - Project to display (name or ID) - -project unset -------------- - -Unset project properties - -*Identity version 2 only* - -.. program:: project unset -.. code:: bash - - openstack project unset - --property <key> [--property <key> ...] - <project> - -.. option:: --property <key> - - Property key to remove from project (repeat option to remove multiple properties) - -.. describe:: <project> - - Project to modify (name or ID) diff --git a/doc/source/cli/command-objects/region.rst b/doc/source/cli/command-objects/region.rst index 58cc341f..86e7ca8a 100644 --- a/doc/source/cli/command-objects/region.rst +++ b/doc/source/cli/command-objects/region.rst @@ -7,16 +7,4 @@ zero or more sub-regions with a region to create a tree-like structured hierarchy. Applies to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: region create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: region delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: region list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: region set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: region show + :command: region * diff --git a/doc/source/cli/command-objects/registered-limit.rst b/doc/source/cli/command-objects/registered-limit.rst index 586fd1ff..98a5efba 100644 --- a/doc/source/cli/command-objects/registered-limit.rst +++ b/doc/source/cli/command-objects/registered-limit.rst @@ -7,134 +7,5 @@ Identity v3 Registered limits are used to define default limits for resources within a deployment. -registered limit create ------------------------ - -Create a new registered limit - -.. program:: registered limit create -.. code:: bash - - openstack registered limit create - [--description <description>] - [--region <region>] - --service <service> - --default-limit <default-limit> - <resource-name> - -.. option:: --description <description> - - Useful description of the registered limit or its purpose - -.. option:: --region <region> - - Region that the limit should be applied to - -.. describe:: --service <service> - - The service that is responsible for the resource being limited (required) - -.. describe:: --default-limit <default-limit> - - The default limit for projects to assume unless explicitly overridden - (required) - -.. describe:: <resource-name> - - The name of the resource to limit (e.g. cores or volumes) - -registered limit delete ------------------------ - -Delete registered limit(s) - -.. program:: registered limit delete -.. code:: bash - - openstack registered limit delete - <registered-limit-id> [<registered-limit-id> ...] - - -.. describe:: <registered-limit-id> - - Registered limit(s) to delete (ID) - -registered limit list ---------------------- - -List registered limits - -.. program:: registered limit list -.. code:: bash - - openstack registered limit list - [--service <service>] - [--resource-name <resource-name>] - [--region <region>] - -.. option:: --service <service> - - The service to filter the response by (name or ID) - -.. option:: --resource-name <resource-name> - - The name of the resource to filter the response by - -.. option:: --region <region> - - The region name to filter the response by - -registered limit show ---------------------- - -Display details about a registered limit - -.. program:: registered limit show -.. code:: bash - - openstack registered limit show - <registered-limit-id> - -.. describe:: <registered-limit-id> - - Registered limit to display (ID) - -registered limit set --------------------- - -Update a registered limit - -.. program:: registered limit set -.. code:: bash - - openstack registered limit set - [--service <service>] - [--resource-name <resource-name>] - [--default-limit <default-limit>] - [--description <description>] - [--region <region>] - <registered-limit-id> - -.. option:: --service <service> - - The service of the registered limit to update (ID or name) - -.. option:: --resource-name <resource-name> - - The name of the resource for the limit - -.. option:: --default-limit <default-limit> - - The default limit for projects to assume for a given resource - -.. option:: --description <description> - - A useful description of the limit or its purpose - -.. option:: --region <region> - - The region the limit should apply to - -.. describe:: <registered-limit-id> - - Registered limit to display (ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: registered limit * diff --git a/doc/source/cli/command-objects/request-token.rst b/doc/source/cli/command-objects/request-token.rst index e10f6640..ea333c4a 100644 --- a/doc/source/cli/command-objects/request-token.rst +++ b/doc/source/cli/command-objects/request-token.rst @@ -7,7 +7,4 @@ is used by the **consumer** to request **access tokens**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: request token authorize - -.. autoprogram-cliff:: openstack.identity.v3 - :command: request token create + :command: request token * diff --git a/doc/source/cli/command-objects/role-v2.rst b/doc/source/cli/command-objects/role-v2.rst new file mode 100644 index 00000000..dc5bac6c --- /dev/null +++ b/doc/source/cli/command-objects/role-v2.rst @@ -0,0 +1,6 @@ +================== +role (Identity v2) +================== + +.. autoprogram-cliff:: openstack.identity.v2 + :command: role * diff --git a/doc/source/cli/command-objects/role-v3.rst b/doc/source/cli/command-objects/role-v3.rst new file mode 100644 index 00000000..e36bef77 --- /dev/null +++ b/doc/source/cli/command-objects/role-v3.rst @@ -0,0 +1,6 @@ +================== +role (Identity v3) +================== + +.. autoprogram-cliff:: openstack.identity.v3 + :command: role * diff --git a/doc/source/cli/command-objects/role.rst b/doc/source/cli/command-objects/role.rst deleted file mode 100644 index e2a2b457..00000000 --- a/doc/source/cli/command-objects/role.rst +++ /dev/null @@ -1,288 +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>] - <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 - -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>] - <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) - -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) diff --git a/doc/source/cli/command-objects/server-migration.rst b/doc/source/cli/command-objects/server-migration.rst new file mode 100644 index 00000000..6e2982cf --- /dev/null +++ b/doc/source/cli/command-objects/server-migration.rst @@ -0,0 +1,12 @@ +================ +server migration +================ + +A server migration provides a way to move an instance from one +host to another. There are four types of migration operation +supported: live migration, cold migration, resize and evacuation. + +Compute v2 + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server migration list diff --git a/doc/source/cli/command-objects/service-provider.rst b/doc/source/cli/command-objects/service-provider.rst index a92c3b20..47a50327 100644 --- a/doc/source/cli/command-objects/service-provider.rst +++ b/doc/source/cli/command-objects/service-provider.rst @@ -1,22 +1,10 @@ -================= -identity provider -================= +================ +service provider +================ A **service provider** is used by the Identity service's OS-FEDERATION extension. It is used by to register another OpenStack Identity service. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: service provider create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service provider delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service provider list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service provider set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service provider show + :command: service provider * diff --git a/doc/source/cli/command-objects/service-v2.rst b/doc/source/cli/command-objects/service-v2.rst new file mode 100644 index 00000000..6b22b7ee --- /dev/null +++ b/doc/source/cli/command-objects/service-v2.rst @@ -0,0 +1,6 @@ +===================== +service (Identity v2) +===================== + +.. autoprogram-cliff:: openstack.identity.v2 + :command: service * diff --git a/doc/source/cli/command-objects/service-v3.rst b/doc/source/cli/command-objects/service-v3.rst new file mode 100644 index 00000000..d4b70206 --- /dev/null +++ b/doc/source/cli/command-objects/service-v3.rst @@ -0,0 +1,18 @@ +===================== +service (Identity v3) +===================== + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service create + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service delete + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service list + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service show + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service set diff --git a/doc/source/cli/command-objects/service.rst b/doc/source/cli/command-objects/service.rst deleted file mode 100644 index a69c6950..00000000 --- a/doc/source/cli/command-objects/service.rst +++ /dev/null @@ -1,143 +0,0 @@ -======= -service -======= - -Identity v2, v3 - -service create --------------- - -Create new service - -.. program:: service create -.. code-block:: bash - - openstack service create - [--name <name>] - [--description <description>] - [--enable | --disable] - <type> - -.. option:: --name <name> - - New service name - -.. option:: --description <description> - - New service description - -.. option:: --enable - - Enable service (default) - - *Identity version 3 only* - -.. option:: --disable - - Disable service - - *Identity version 3 only* - -.. _service_create-type: -.. describe:: <type> - - New service type (compute, image, identity, volume, etc) - -service delete --------------- - -Delete service(s) - -.. program:: service delete -.. code-block:: bash - - openstack service delete - <service> [<service> ...] - -.. _service_delete-service: -.. describe:: <service> - - Service(s) to delete (type, name or ID) - -service list ------------- - -List services - -.. program:: service list -.. code-block:: bash - - openstack service list - [--long] - -.. option:: --long - - List additional fields in output - -Returns service fields ID, Name and Type. :option:`--long` adds Description -and Enabled (*Identity version 3 only*) to the output. - -service set ------------ - -Set service properties - -* Identity version 3 only* - -.. program:: service set -.. code-block:: bash - - openstack service set - [--type <type>] - [--name <name>] - [--description <description>] - [--enable | --disable] - <service> - -.. option:: --type <type> - - New service type (compute, image, identity, volume, etc) - -.. option:: --name <name> - - New service name - -.. option:: --description <description> - - New service description - -.. option:: --enable - - Enable service - -.. option:: --disable - - Disable service - -.. _service_set-service: -.. describe:: <service> - - Service to modify (type, name or ID) - -service show ------------- - -Display service details - -.. program:: service show -.. code-block:: bash - - openstack service show - [--catalog] - <service> - -.. option:: --catalog - - Show service catalog information - - *Identity version 2 only* - -.. _service_show-service: -.. describe:: <service> - - Service to display (type, name or ID) diff --git a/doc/source/cli/command-objects/token-v2.rst b/doc/source/cli/command-objects/token-v2.rst new file mode 100644 index 00000000..c66302bf --- /dev/null +++ b/doc/source/cli/command-objects/token-v2.rst @@ -0,0 +1,7 @@ +=================== +token (Identity v2) +=================== + + +.. autoprogram-cliff:: openstack.identity.v2 + :command: token * diff --git a/doc/source/cli/command-objects/token-v3.rst b/doc/source/cli/command-objects/token-v3.rst new file mode 100644 index 00000000..6b2d87a6 --- /dev/null +++ b/doc/source/cli/command-objects/token-v3.rst @@ -0,0 +1,7 @@ +=================== +token (Identity v3) +=================== + + +.. autoprogram-cliff:: openstack.identity.v3 + :command: token * diff --git a/doc/source/cli/command-objects/token.rst b/doc/source/cli/command-objects/token.rst deleted file mode 100644 index b4b14cd9..00000000 --- a/doc/source/cli/command-objects/token.rst +++ /dev/null @@ -1,30 +0,0 @@ -===== -token -===== - -Identity v2, v3 - -token issue ------------ - -Issue new token - -.. program:: token issue -.. code:: bash - - openstack token issue - -token revoke ------------- - -Revoke existing token - -.. program:: token revoke -.. code:: bash - - openstack token revoke - <token> - -.. describe:: <token> - - Token to be deleted diff --git a/doc/source/cli/command-objects/trust.rst b/doc/source/cli/command-objects/trust.rst index febef1c5..738c640c 100644 --- a/doc/source/cli/command-objects/trust.rst +++ b/doc/source/cli/command-objects/trust.rst @@ -6,13 +6,4 @@ A **trust** provide project-specific role delegation between users, with optional impersonation. Requires the OS-TRUST extension. Applies to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 - :command: trust create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: trust delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: trust list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: trust show + :command: trust * diff --git a/doc/source/cli/command-objects/user-v2.rst b/doc/source/cli/command-objects/user-v2.rst new file mode 100644 index 00000000..966bd376 --- /dev/null +++ b/doc/source/cli/command-objects/user-v2.rst @@ -0,0 +1,7 @@ +================== +user (Identity v2) +================== + + +.. autoprogram-cliff:: openstack.identity.v2 + :command: user * diff --git a/doc/source/cli/command-objects/user-v3.rst b/doc/source/cli/command-objects/user-v3.rst new file mode 100644 index 00000000..c11ff9a6 --- /dev/null +++ b/doc/source/cli/command-objects/user-v3.rst @@ -0,0 +1,7 @@ +================== +user (Identity v3) +================== + + +.. autoprogram-cliff:: openstack.identity.v3 + :command: user * diff --git a/doc/source/cli/command-objects/user.rst b/doc/source/cli/command-objects/user.rst deleted file mode 100644 index 632d0e25..00000000 --- a/doc/source/cli/command-objects/user.rst +++ /dev/null @@ -1,223 +0,0 @@ -==== -user -==== - -Identity v2, v3 - -user create ------------ - -Create new user - -.. program:: user create -.. code:: bash - - openstack user create - [--domain <domain>] - [--project <project> [--project-domain <project-domain>]] - [--password <password>] - [--password-prompt] - [--email <email-address>] - [--description <description>] - [--enable | --disable] - [--or-show] - <user-name> - -.. option:: --domain <domain> - - Default domain (name or ID) - - .. versionadded:: 3 - -.. option:: --project <project> - - Default project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --password <password> - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email <email-address> - - Set user email address - -.. option:: --description <description> - - User description - - .. versionadded:: 3 - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. option:: --or-show - - Return existing user - - If the username already exist return the existing user data and do not fail. - -.. describe:: <user-name> - - New user name - -user delete ------------ - -Delete user(s) - -.. program:: user delete -.. code:: bash - - openstack user delete - [--domain <domain>] - <user> [<user> ...] - -.. option:: --domain <domain> - - Domain owning :ref:`\<user\> <user_delete-user>` (name or ID) - - .. versionadded:: 3 - -.. _user_delete-user: -.. describe:: <user> - - User(s) to delete (name or ID) - -user list ---------- - -List users - -.. program:: user list -.. code:: bash - - openstack user list - [--project <project>] - [--domain <domain>] - [--group <group> | --project <project>] - [--long] - -.. option:: --project <project> - - Filter users by `<project>` (name or ID) - -.. option:: --domain <domain> - - Filter users by `<domain>` (name or ID) - - *Identity version 3 only* - -.. option:: --group <group> - - Filter users by `<group>` membership (name or ID) - - *Identity version 3 only* - -.. option:: --long - - List additional fields in output - -user set --------- - -Set user properties - -.. program:: user set -.. code:: bash - - openstack user set - [--name <name>] - [--project <project> [--project-domain <project-domain>]] - [--password <password>] - [--password-prompt] - [--email <email-address>] - [--description <description>] - [--enable|--disable] - <user> - -.. option:: --name <name> - - Set user name - -.. option:: --domain <domain> - - Domain the user belongs to (name or ID). - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -.. option:: --project <project> - - Set default project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --password <password> - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email <email-address> - - Set user email address - -.. option:: --description <description> - - Set user description - - .. versionadded:: 3 - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. describe:: <user> - - User to modify (name or ID) - -user show ---------- - -Display user details - -.. program:: user show -.. code:: bash - - openstack user show - [--domain <domain>] - <user> - -.. option:: --domain <domain> - - Domain owning :ref:`\<user\> <user_show-user>` (name or ID) - - .. versionadded:: 3 - -.. _user_show-user: -.. describe:: <user> - - User to display (name or ID) diff --git a/doc/source/cli/command-objects/volume-snapshot.rst b/doc/source/cli/command-objects/volume-snapshot.rst index 30cc77cc..21a89370 100644 --- a/doc/source/cli/command-objects/volume-snapshot.rst +++ b/doc/source/cli/command-objects/volume-snapshot.rst @@ -115,7 +115,7 @@ List volume snapshots .. option:: --status <status> Filters results by a status. - ('available', 'error', 'creating', 'deleting' or 'error-deleting') + ('available', 'error', 'creating', 'deleting' or 'error_deleting') .. option:: --name <name> diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst index 7c38aa5b..97a829b5 100644 --- a/doc/source/cli/commands.rst +++ b/doc/source/cli/commands.rst @@ -195,10 +195,6 @@ conflicts when creating new plugins. For a complete list check out * ``cluster profile``: (**Clustering (Senlin)**) * ``cluster profile type``: (**Clustering (Senlin)**) * ``cluster receiver``: (**Clustering (Senlin)**) -* ``congress datasource``: (**Policy (Congress)**) -* ``congress driver``: (**Policy (Congress)**) -* ``congress policy``: (**Policy (Congress)**) -* ``congress policy rule``: (**Policy (Congress)**) * ``cron trigger``: (**Workflow Engine (Mistral)**) * ``database flavor``: (**Database (Trove)**) * ``dataprocessing data source``: (**Data Processing (Sahara)**) diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 17e50a07..9cb3b33a 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -13,3 +13,12 @@ interactive decoder backwards-incompatible + +.. NOTE(efried): Everything must be in a toctree but we don't want these to + show up to the reader. + +.. toctree:: + :glob: + :hidden: + + _hidden/* diff --git a/doc/source/cli/man/openstack.rst b/doc/source/cli/man/openstack.rst index 1ba9db0d..687e39eb 100644 --- a/doc/source/cli/man/openstack.rst +++ b/doc/source/cli/man/openstack.rst @@ -282,14 +282,14 @@ The keys match the :program:`openstack` global options but without the clouds: devstack: auth: - auth_url: http://192.168.122.10:35357/ + auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack region_name: RegionOne ds-admin: auth: - auth_url: http://192.168.122.10:35357/ + auth_url: http://192.168.122.10:5000/ project_name: admin username: admin password: 0penstack diff --git a/doc/source/cli/plugin-commands/congress.rst b/doc/source/cli/plugin-commands/congress.rst deleted file mode 100644 index 7a1e63b7..00000000 --- a/doc/source/cli/plugin-commands/congress.rst +++ /dev/null @@ -1,4 +0,0 @@ -congress --------- - -.. autoprogram-cliff:: openstack.congressclient.v1 diff --git a/doc/source/cli/plugin-commands/index.rst b/doc/source/cli/plugin-commands/index.rst index 2c3bda3e..33a8fe06 100644 --- a/doc/source/cli/plugin-commands/index.rst +++ b/doc/source/cli/plugin-commands/index.rst @@ -9,13 +9,13 @@ Plugin Commands aodh barbican - congress designate gnocchi heat ironic ironic-inspector karbor + manila mistral neutron octavia diff --git a/doc/source/cli/plugin-commands/manila.rst b/doc/source/cli/plugin-commands/manila.rst new file mode 100644 index 00000000..c42d6065 --- /dev/null +++ b/doc/source/cli/plugin-commands/manila.rst @@ -0,0 +1,4 @@ +manila +------ + +.. autoprogram-cliff:: openstack.share.v2 diff --git a/doc/source/conf.py b/doc/source/conf.py index ff37783f..2216ddd7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,8 +12,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import pbr.version - # -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -31,11 +29,12 @@ extensions = ['sphinx.ext.autodoc', ] # openstackdocstheme options -repository_name = 'openstack/python-openstackclient' -use_storyboard = True +openstackdocs_repo_name = 'openstack/python-openstackclient' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # Add project 'foo' to this list to enable the :foo-doc: role -openstack_projects = [ +openstackdocs_projects = [ 'neutron', ] @@ -55,17 +54,6 @@ master_doc = 'index' project = u'OpenStack Command Line Client' copyright = u'2012-2013 OpenStack Foundation' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -version_info = pbr.version.VersionInfo('python-openstackclient') -# -# The short X.Y version. -version = version_info.version_string() -# The full version, including alpha/beta/rc tags. -release = version_info.release_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -96,7 +84,7 @@ exclude_patterns = ['**tests**'] #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['openstackclient.'] @@ -139,11 +127,6 @@ html_theme = 'openstackdocs' # so a file named "default.css" will overwrite the builtin "default.css". #html_static_path = ['_static'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index d2b273d7..b74bb365 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -61,14 +61,14 @@ The keys match the :program:`openstack` global options but without the clouds: devstack: auth: - auth_url: http://192.168.122.10:35357/ + auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack region_name: RegionOne ds-admin: auth: - auth_url: http://192.168.122.10:35357/ + auth_url: http://192.168.122.10:5000/ project_name: admin username: admin password: 0penstack @@ -121,7 +121,7 @@ domain name as shown in the example below: clouds: devstack: auth: - auth_url: http://192.168.122.10:35357/ + auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack @@ -171,7 +171,7 @@ By setting `log_level` or `log_file` in the configuration clouds: devstack: auth: - auth_url: http://192.168.122.10:35357/ + auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack @@ -182,7 +182,7 @@ By setting `log_level` or `log_file` in the configuration level: info ds-admin: auth: - auth_url: http://192.168.122.10:35357/ + auth_url: http://192.168.122.10:5000/ project_name: admin username: admin password: 0penstack diff --git a/doc/source/contributor/developing.rst b/doc/source/contributor/developing.rst index bd9197d7..a3198493 100644 --- a/doc/source/contributor/developing.rst +++ b/doc/source/contributor/developing.rst @@ -176,18 +176,21 @@ or Standardize Import Format ========================= -.. _`Import Order Guide`: https://docs.openstack.org/hacking/latest/user/hacking.html#imports +More information about Import Format, see `Import Order Guide +<https://docs.openstack.org/hacking/latest/user/hacking.html#imports>`__. The import order shows below: -* {{stdlib imports in human alphabetical order}} -* \n -* {{third-party lib imports in human alphabetical order}} -* \n -* {{project imports in human alphabetical order}} -* \n -* \n -* {{begin your code}} +.. code-block:: none + + {{stdlib imports in human alphabetical order}} + \n + {{third-party lib imports in human alphabetical order}} + \n + {{project imports in human alphabetical order}} + \n + \n + {{begin your code}} Example ~~~~~~~ @@ -196,13 +199,12 @@ Example import copy import fixtures - import mock import os from osc_lib.api import auth from osc_lib import utils - import six from openstackclient import shell from openstackclient.tests import utils + from unittest import mock diff --git a/doc/source/contributor/plugins.rst b/doc/source/contributor/plugins.rst index d6bcbee1..374b274e 100644 --- a/doc/source/contributor/plugins.rst +++ b/doc/source/contributor/plugins.rst @@ -27,7 +27,6 @@ The following is a list of projects that are an OpenStackClient plugin. - gnocchiclient - osc-placement - python-barbicanclient -- python-congressclient - python-designateclient - python-heatclient - python-ironicclient diff --git a/doc/source/index.rst b/doc/source/index.rst index 732e1387..7675d6c3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -29,7 +29,7 @@ Release Notes .. toctree:: :maxdepth: 1 - Release Notes <http://docs.openstack.org/releasenotes/python-openstackclient> + Release Notes <https://docs.openstack.org/releasenotes/python-openstackclient/> Contributor Documentation ------------------------- |