diff options
| author | Thomas Goirand <zigo@debian.org> | 2018-02-13 22:51:34 +0000 |
|---|---|---|
| committer | git-ubuntu importer <ubuntu-devel-discuss@lists.ubuntu.com> | 2018-02-14 04:29:03 +0000 |
| commit | 13132e78d7b929277f7144347543683fb55e254a (patch) | |
| tree | de4450d624d82266331735f30f4a407305d8e2ab /doc/source | |
| parent | 98bf0ec1a7967665dd69f128e56c754a7f565a05 (diff) | |
3.14.0-1 (patches unapplied)import/3.14.0-1
Imported using git-ubuntu import.
Notes
Notes:
[ Ondřej Nový ]
* d/control: Set Vcs-* to salsa.debian.org
[ Thomas Goirand ]
* New upstream release.
* Fixed (build-)depends for this release.
* Standards-Version is now 4.1.3.
Diffstat (limited to 'doc/source')
40 files changed, 493 insertions, 1593 deletions
diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess new file mode 100644 index 0000000..d4c092b --- /dev/null +++ b/doc/source/_extra/.htaccess @@ -0,0 +1,22 @@ +# Redirect docs from the old to new location following the Great Docs Migration of 2017 + +redirectmatch 301 ^/python-openstackclient/([^/]+)/command-objects/([^/.]+).html$ /python-openstackclient/$1/cli/command-objects/$2.html + +redirectmatch 301 ^/python-openstackclient/([^/]+)/authentication.html$ /python-openstackclient/$1/cli/authentication.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/backward-incompatible.html$ /python-openstackclient/$1/cli/backward-incompatible.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/command-list.html$ /python-openstackclient/$1/cli/command-list.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/commands.html$ /python-openstackclient/$1/cli/commands.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/decoder.html$ /python-openstackclient/$1/cli/decoder.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/interactive.html$ /python-openstackclient/$1/cli/interactive.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/plugin-commands.html$ /python-openstackclient/$1/cli/plugin-commands.html + +redirectmatch 301 ^/python-openstackclient/([^/]+)/specs/([^/.]+).html$ /python-openstackclient/$1/contributor/specs/$2.html + +redirectmatch 301 ^/python-openstackclient/([^/]+)/command-beta.html$ /python-openstackclient/$1/contributor/command-beta.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/command-errors.html$ /python-openstackclient/$1/contributor/command-errors.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/command-logs.html$ /python-openstackclient/$1/contributor/command-logs.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/command-options.html$ /python-openstackclient/$1/contributor/command-options.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/command-wrappers.html$ /python-openstackclient/$1/contributor/command-wrappers.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/developing.html$ /python-openstackclient/$1/contributor/developing.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/humaninterfaceguide.html$ /python-openstackclient/$1/contributor/humaninterfaceguide.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/plugins.html$ /python-openstackclient/$1/contributor/plugins.html diff --git a/doc/source/cli/authentication.rst b/doc/source/cli/authentication.rst index 5a1d279..b153f54 100644 --- a/doc/source/cli/authentication.rst +++ b/doc/source/cli/authentication.rst @@ -7,7 +7,7 @@ Authentication OpenStackClient leverages `python-keystoneclient`_ authentication plugins to support a number of different authentication methods. -.. _`python-keystoneclient`: http://docs.openstack.org/developer/python-keystoneclient/authentication-plugins.html +.. _`python-keystoneclient`: https://docs.openstack.org/python-keystoneclient/latest/using-sessions.html#sharing-authentication-plugins Authentication Process ---------------------- @@ -114,22 +114,22 @@ to tell the client in which domain the user and project exists. If using a user name and password to authenticate, specify either it's owning domain name or ID. - * ``--os-user-domain-name`` or ``OS_USER_DOMAIN_NAME`` +* ``--os-user-domain-name`` or ``OS_USER_DOMAIN_NAME`` - * ``--os-user-domain-id`` or ``OS_USER_DOMAIN_ID`` +* ``--os-user-domain-id`` or ``OS_USER_DOMAIN_ID`` If using a project name as authorization scope, specify either it's owning domain name or ID. - * ``--os-project-domain-name`` or ``OS_PROJECT_DOMAIN_NAME`` +* ``--os-project-domain-name`` or ``OS_PROJECT_DOMAIN_NAME`` - * ``--os-project-domain-id`` or ``OS_PROJECT_DOMAIN_ID`` +* ``--os-project-domain-id`` or ``OS_PROJECT_DOMAIN_ID`` If using a domain as authorization scope, set either it's name or ID. - * ``--os-domain-name`` or ``OS_DOMAIN_NAME`` +* ``--os-domain-name`` or ``OS_DOMAIN_NAME`` - * ``--os-domain-id`` or ``OS_DOMAIN_ID`` +* ``--os-domain-id`` or ``OS_DOMAIN_ID`` Note that if the user and project share the same domain, then simply setting ``--os-default-domain`` or ``OS_DEFAULT_DOMAIN`` to the domain ID is sufficient. diff --git a/doc/source/cli/command-objects/access-token.rst b/doc/source/cli/command-objects/access-token.rst index b140041..7ef9167 100644 --- a/doc/source/cli/command-objects/access-token.rst +++ b/doc/source/cli/command-objects/access-token.rst @@ -2,41 +2,9 @@ access token ============ -Identity v3 +An **access token** is used by the Identity service's OS-OAUTH1 extension. It +is used by the **consumer** to request new Identity API tokens on behalf of the +authorizing **user**. Applicable to Identity v3. -`Requires: OS-OAUTH1 extension` - -access token create -------------------- - -Create an access token - -.. program:: access token create -.. code:: bash - - openstack access token create - --consumer-key <consumer-key> - --consumer-secret <consumer-secret> - --request-key <request-key> - --request-secret <request-secret> - --verifier <verifier> - -.. option:: --consumer-key <consumer-key> - - Consumer key (required) - -.. option:: --consumer-secret <consumer-secret> - - Consumer secret (required) - -.. option:: --request-key <request-key> - - Request token to exchange for access token (required) - -.. option:: --request-secret <request-secret> - - Secret associated with <request-key> (required) - -.. option:: --verifier <verifier> - - Verifier associated with <request-key> (required) +.. autoprogram-cliff:: openstack.identity.v3 + :command: access token create diff --git a/doc/source/cli/command-objects/catalog.rst b/doc/source/cli/command-objects/catalog.rst index dccf780..6db8227 100644 --- a/doc/source/cli/command-objects/catalog.rst +++ b/doc/source/cli/command-objects/catalog.rst @@ -2,29 +2,11 @@ catalog ======= -Identity v2, v3 +A **catalog** lists OpenStack services that are available on the cloud. +Applicable to Identity v2 and v3 -catalog list ------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: catalog list -List services in the service catalog - -.. program:: catalog list -.. code:: bash - - openstack catalog list - -catalog show ------------- - -Display service catalog details - -.. program:: catalog show -.. code:: bash - - openstack catalog show - <service> - -.. describe:: <service> - - Service to display (type or name) +.. autoprogram-cliff:: openstack.identity.v3 + :command: catalog show diff --git a/doc/source/cli/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst index d4ce5dc..8f6dda0 100644 --- a/doc/source/cli/command-objects/consumer.rst +++ b/doc/source/cli/command-objects/consumer.rst @@ -2,82 +2,21 @@ consumer ======== -Identity v3 +An **consumer** is used by the Identity service's OS-OAUTH1 extension. It +is used to create a **request token** and **access token**. Applicable to +Identity v3. -`Requires: OS-OAUTH1 extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: consumer create -consumer create ---------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: consumer delete -Create new consumer +.. autoprogram-cliff:: openstack.identity.v3 + :command: consumer list -.. program:: consumer create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: consumer set - openstack consumer create - [--description <description>] - -.. option:: --description <description> - - New consumer description - -consumer delete ---------------- - -Delete consumer(s) - -.. program:: consumer delete -.. code:: bash - - openstack consumer delete - <consumer> [<consumer> ...] - -.. describe:: <consumer> - - Consumer(s) to delete - -consumer list -------------- - -List consumers - -.. program:: consumer list -.. code:: bash - - openstack consumer list - -consumer set ------------- - -Set consumer properties - -.. program:: consumer set -.. code:: bash - - openstack consumer set - [--description <description>] - <consumer> - -.. option:: --description <description> - - New consumer description - -.. describe:: <consumer> - - Consumer to modify - -consumer show -------------- - -Display consumer details - -.. program:: consumer show -.. code:: bash - - openstack consumer show - <consumer> - -.. _consumer_show-consumer: -.. describe:: <consumer> - - Consumer to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: consumer show diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst index e68955a..83deeb8 100644 --- a/doc/source/cli/command-objects/container.rst +++ b/doc/source/cli/command-objects/container.rst @@ -2,149 +2,25 @@ container ========= -Object Storage v1 +A **container** defines a namespace for **objects**. Applies to Object Storage v1 -container create ----------------- +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container create -Create new container +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container delete -.. program:: container create -.. code:: bash +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container list - openstack container create - <container-name> [<container-name> ...] +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container save -.. describe:: <container-name> +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container set - New container name(s) +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container show -container delete ----------------- - -Delete container - -.. program:: container delete -.. code:: bash - - openstack container delete - [-r] | [--recursive] - <container> [<container> ...] - -.. option:: --recursive, -r - - Recursively delete objects in container before container delete - -.. describe:: <container> - - Container(s) to delete - -container list --------------- - -List containers - -.. program:: container list -.. code:: bash - - openstack container list - [--prefix <prefix>] - [--marker <marker>] - [--end-marker <end-marker>] - [--limit <num-containers>] - [--long] - [--all] - -.. option:: --prefix <prefix> - - Filter list using <prefix> - -.. option:: --marker <marker> - - Anchor for paging - -.. option:: --end-marker <end-marker> - - End anchor for paging - -.. option:: --limit <num-containers> - - Limit the number of containers returned - -.. option:: --long - - List additional fields in output - -.. option:: --all - - List all containers (default is 10000) - -container save --------------- - -Save container contents locally - -.. program:: container save -.. code:: bash - - openstack container save - <container> - -.. describe:: <container> - - Container to save - -container set -------------- - -Set container properties - -.. program:: container set -.. code:: bash - - openstack container set - [--property <key=value> [...] ] - <container> - -.. option:: --property <key=value> - - Set a property on this container (repeat option to set multiple properties) - -.. describe:: <container> - - Container to modify - -container show --------------- - -Display container details - -.. program:: container show -.. code:: bash - - openstack container show - <container> - -.. describe:: <container> - - Container to display - -container unset ---------------- - -Unset container properties - -.. program:: container unset -.. code:: bash - - openstack container unset - [--property <key>] - <container> - -.. option:: --property <key> - - Property to remove from container (repeat option to remove multiple properties) - -.. describe:: <container> - - Container to modify +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container unset diff --git a/doc/source/cli/command-objects/credential.rst b/doc/source/cli/command-objects/credential.rst index 47c847c..7fe5731 100644 --- a/doc/source/cli/command-objects/credential.rst +++ b/doc/source/cli/command-objects/credential.rst @@ -19,7 +19,7 @@ Create new credential .. option:: --type <type> - New credential type: cert, ec2 + New credential type: cert, ec2, totp and so on .. option:: --project <project> @@ -73,7 +73,7 @@ List credentials .. option:: --type <type> - Filter credentials by type: cert, ec2 + Filter credentials by type: cert, ec2, totp and so on credential set -------------- @@ -96,7 +96,7 @@ Set credential properties .. option:: --type <type> - New credential type: cert, ec2 + New credential type: cert, ec2, totp and so on. .. option:: --data <data> diff --git a/doc/source/cli/command-objects/domain.rst b/doc/source/cli/command-objects/domain.rst index 70a3e73..81a1934 100644 --- a/doc/source/cli/command-objects/domain.rst +++ b/doc/source/cli/command-objects/domain.rst @@ -2,114 +2,21 @@ domain ====== -Identity v3 +A **domain** is a collection of **users**, **groups**, and **projects**. Each +**group** and **project** is owned by exactly one **domain**. Applies to +Identity v3. -domain create -------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain create -Create new domain +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain delete -.. program:: domain create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain list - openstack domain create - [--description <description>] - [--enable | --disable] - [--or-show] - <domain-name> +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain set -.. option:: --description <description> - - New domain description - -.. option:: --enable - - Enable domain (default) - -.. option:: --disable - - Disable domain - -.. option:: --or-show - - Return existing domain - - If the domain already exists, return the existing domain data and do not fail. - -.. describe:: <domain-name> - - New domain name - -domain delete -------------- - -Delete domain(s) - -.. program:: domain delete -.. code:: bash - - openstack domain delete - <domain> [<domain> ...] - -.. describe:: <domain> - - Domain(s) to delete (name or ID) - -domain list ------------ - -List domains - -.. program:: domain list -.. code:: bash - - openstack domain list - -domain set ----------- - -Set domain properties - -.. program:: domain set -.. code:: bash - - openstack domain set - [--name <name>] - [--description <description>] - [--enable | --disable] - <domain> - -.. option:: --name <name> - - New domain name - -.. option:: --description <description> - - New domain description - -.. option:: --enable - - Enable domain - -.. option:: --disable - - Disable domain - -.. describe:: <domain> - - Domain to modify (name or ID) - -domain show ------------ - -Display domain details - -.. program:: domain show -.. code:: bash - - openstack domain show - <domain> - -.. describe:: <domain> - - Domain to display (name or ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain show diff --git a/doc/source/cli/command-objects/endpoint.rst b/doc/source/cli/command-objects/endpoint.rst index 02a75be..030947c 100644 --- a/doc/source/cli/command-objects/endpoint.rst +++ b/doc/source/cli/command-objects/endpoint.rst @@ -4,6 +4,34 @@ endpoint Identity v2, v3 +endpoint add project +-------------------- + +Associate a project to and 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 --------------- @@ -107,6 +135,8 @@ List endpoints [--interface <interface>] [--region <region-id>] [--long] + [--endpoint <endpoint> | + --project <project> [--project-domain <project-domain>]] .. option:: --service <service> @@ -132,6 +162,55 @@ List endpoints *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 ------------ diff --git a/doc/source/cli/command-objects/federation-protocol.rst b/doc/source/cli/command-objects/federation-protocol.rst index e1f9817..3a99fd7 100644 --- a/doc/source/cli/command-objects/federation-protocol.rst +++ b/doc/source/cli/command-objects/federation-protocol.rst @@ -2,111 +2,21 @@ federation protocol =================== -Identity v3 +A **federation protocol** is used by the Identity service's OS-FEDERATION +extension. It is used by **identity providers** and **mappings**. Applicable to +Identity v3. -`Requires: OS-FEDERATION extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol create -federation protocol create --------------------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol delete -Create new federation protocol +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol list -.. program:: federation protocol create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol set - openstack federation protocol create - --identity-provider <identity-provider> - --mapping <mapping> - <name> - -.. option:: --identity-provider <identity-provider> - - Identity provider that will support the new federation protocol (name or ID) (required) - -.. option:: --mapping <mapping> - - Mapping that is to be used (name or ID) (required) - -.. describe:: <name> - - New federation protocol name (must be unique per identity provider) - -federation protocol delete --------------------------- - -Delete federation protocol(s) - -.. program:: federation protocol delete -.. code:: bash - - openstack federation protocol delete - --identity-provider <identity-provider> - <federation-protocol> [<federation-protocol> ...] - -.. option:: --identity-provider <identity-provider> - - Identity provider that supports <federation-protocol> (name or ID) (required) - -.. describe:: <federation-protocol> - - Federation protocol(s) to delete (name or ID) - -federation protocol list ------------------------- - -List federation protocols - -.. program:: federation protocol list -.. code:: bash - - openstack federation protocol list - --identity-provider <identity-provider> - -.. option:: --identity-provider <identity-provider> - - Identity provider to list (name or ID) (required) - -federation protocol set ------------------------ - -Set federation protocol properties - -.. program:: federation protocol set -.. code:: bash - - openstack federation protocol set - --identity-provider <identity-provider> - [--mapping <mapping>] - <federation-protocol> - -.. option:: --identity-provider <identity-provider> - - Identity provider that supports <federation-protocol> (name or ID) (required) - -.. option:: --mapping <mapping> - - Mapping that is to be used (name or ID) - -.. describe:: <federation-protocol> - - Federation protocol to modify (name or ID) - -federation protocol show ------------------------- - -Display federation protocol details - -.. program:: federation protocol show -.. code:: bash - - openstack federation protocol show - --identity-provider <identity-provider> - <federation-protocol> - -.. option:: --identity-provider <identity-provider> - - Identity provider that supports <federation-protocol> (name or ID) (required) - -.. describe:: <federation-protocol> - - Federation protocol to display (name or ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol show diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst index 6feb449..1cbd2df 100644 --- a/doc/source/cli/command-objects/flavor.rst +++ b/doc/source/cli/command-objects/flavor.rst @@ -44,7 +44,7 @@ Create new flavor .. option:: --swap <size-mb> - Swap space size in MB (default 0M) + Additional swap space size in MB (default 0M) .. option:: --vcpus <num-cpu> diff --git a/doc/source/cli/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst index f2f101d..d9ed230 100644 --- a/doc/source/cli/command-objects/floating-ip.rst +++ b/doc/source/cli/command-objects/floating-ip.rst @@ -18,6 +18,7 @@ Create floating IP [--floating-ip-address <ip-address>] [--fixed-ip-address <ip-address>] [--description <description>] + [--qos-policy <qos-policy>] [--project <project> [--project-domain <project-domain>]] <network> @@ -46,6 +47,12 @@ Create floating IP Set floating IP description *Network version 2 only* +.. option:: --qos-policy <qos-policy> + + QoS policy to attach to the floating IP (name or ID) + + *Network version 2 only* + .. option:: --project <project> Owner's project (name or ID) @@ -154,6 +161,7 @@ Set floating IP properties openstack floating ip set --port <port> [--fixed-ip-address <ip-address>] + [--qos-policy <qos-policy> | --no-qos-policy] <floating-ip> .. option:: --port <port> @@ -164,6 +172,14 @@ Set floating IP properties Fixed IP of the port (required only if port has multiple IPs) +.. option:: --qos-policy <qos-policy> + + Attach QoS policy to the floating IP (name or ID) + +.. option:: --no-qos-policy + + Remove the QoS policy attached to the floating IP + .. _floating_ip_set-floating-ip: .. describe:: <floating-ip> @@ -193,12 +209,17 @@ Unset floating IP Properties openstack floating ip unset --port + --qos-policy <floating-ip> .. option:: --port Disassociate any port associated with the floating IP +.. option:: --qos-policy + + Remove the QoS policy attached to the floating IP + .. _floating_ip_unset-floating-ip: .. describe:: <floating-ip> diff --git a/doc/source/cli/command-objects/identity-provider.rst b/doc/source/cli/command-objects/identity-provider.rst index d96b814..36c9264 100644 --- a/doc/source/cli/command-objects/identity-provider.rst +++ b/doc/source/cli/command-objects/identity-provider.rst @@ -2,132 +2,21 @@ identity provider ================= -Identity v3 +An **identity provider** is used by the Identity service's OS-FEDERATION +extension. It is used by **federation protocols** and **mappings**. Applicable +to Identity v3. -`Requires: OS-FEDERATION extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider create -identity provider create ------------------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider delete -Create new identity provider +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider list -.. program:: identity provider create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider set - openstack identity provider create - [--remote-id <remote-id> [...] | --remote-id-file <file-name>] - [--description <description>] - [--domain <domain>] - [--enable | --disable] - <name> - -.. option:: --remote-id <remote-id> - - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -.. option:: --remote-id-file <file-name> - - Name of a file that contains many remote IDs to associate with the identity - provider, one per line - -.. option:: --description - - New identity provider description - -.. option:: --domain - - Name or ID of the domain to associate with the identity provider. If not - specified, one will be created automatically - -.. option:: --enable - - Enable the identity provider (default) - -.. option:: --disable - - Disable the identity provider - -.. describe:: <name> - - New identity provider name (must be unique) - -identity provider delete ------------------------- - -Delete identity provider(s) - -.. program:: identity provider delete -.. code:: bash - - openstack identity provider delete - <identity-provider> [<identity-provider> ...] - -.. describe:: <identity-provider> - - Identity provider(s) to delete - -identity provider list ----------------------- - -List identity providers - -.. program:: identity provider list -.. code:: bash - - openstack identity provider list - -identity provider set ---------------------- - -Set identity provider properties - -.. program:: identity provider set -.. code:: bash - - openstack identity provider set - [--remote-id <remote-id> [...] | --remote-id-file <file-name>] - [--description <description>] - [--enable | --disable] - <identity-provider> - -.. option:: --remote-id <remote-id> - - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -.. option:: --remote-id-file <file-name> - - Name of a file that contains many remote IDs to associate with the identity - provider, one per line - -.. option:: --description - - Set identity provider description - -.. option:: --enable - - Enable the identity provider - -.. option:: --disable - - Disable the identity provider - -.. describe:: <identity-provider> - - Identity provider to modify - -identity provider show ----------------------- - -Display identity provider details - -.. program:: identity provider show -.. code:: bash - - openstack identity provider show - <identity-provider> - -.. describe:: <identity-provider> - - Identity provider to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider show diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst index 92efd0a..e2257bb 100644 --- a/doc/source/cli/command-objects/image.rst +++ b/doc/source/cli/command-objects/image.rst @@ -16,7 +16,8 @@ Associate project with image openstack image add project [--project-domain <project-domain>] - <image> <project> + <image> + <project> .. option:: --project-domain <project-domain> @@ -60,7 +61,8 @@ Create/upload an image [--public | --private | --community | --shared] [--property <key=value> [...] ] [--tag <tag> [...] ] - [--project <project> [--project-domain <project-domain>]] + [--project <project>] + [--project-domain <project-domain>] <image-name> .. option:: --id <id> @@ -153,11 +155,11 @@ Create/upload an image .. option:: --property <key=value> - Set a property on this image (repeat for multiple values) + Set a property on this image (repeat option to set multiple properties) .. option:: --tag <tag> - Set a tag on this image (repeat for multiple values) + Set a tag on this image (repeat option to set multiple tags) .. versionadded:: 2 @@ -205,13 +207,12 @@ List available images openstack image list [--public | --private | --shared] [--property <key=value>] + [--name <name>] + [--status <status>] [--long] [--sort <key>[:<direction>]] [--limit <num-images>] [--marker <image>] - [--name <name>] - [--status <status>] - .. option:: --public @@ -231,6 +232,18 @@ List available images 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:: --long List additional fields in output @@ -251,15 +264,6 @@ List available images The last image of the previous page. Display list of images after marker. Display all images if not specified. (name or ID) -.. option:: --name <name> - - Filter images based on name - -.. option:: --status <status> - - Filter images based on status - - *Image version 2 only* image remove project @@ -272,7 +276,7 @@ Disassociate project with image .. program:: image remove project .. code:: bash - openstack image remove remove + openstack image remove project [--project-domain <project-domain>] <image> <project> @@ -347,8 +351,9 @@ Set image properties [--os-distro <os-distro>] [--os-version <os-version>] [--ramdisk-id <ramdisk-id>] - [--activate|--deactivate] - [--project <project> [--project-domain <project-domain>]] + [--deactivate | --activate] + [--project <project>] + [--project-domain <project-domain>] [--accept | --reject | --pending] <image> @@ -460,7 +465,7 @@ Set image properties .. option:: --tag <tag> - Set a tag on this image (repeat for multiple values) + Set a tag on this image (repeat option to set multiple tags) .. versionadded:: 2 @@ -500,15 +505,15 @@ Set image properties .. versionadded:: 2 -.. option:: --activate +.. option:: --deactivate - Activate the image. + Deactivate the image. .. versionadded:: 2 -.. option:: --deactivate +.. option:: --activate - Deactivate the image. + Activate the image. .. versionadded:: 2 @@ -568,8 +573,13 @@ Display image details .. code:: bash openstack image show + [--human-readable] <image> +.. option:: --human-readable + + Print image size in a human-friendly format. + .. _image_show-image: .. describe:: <image> @@ -585,16 +595,16 @@ Unset image tags or properties .. program:: image unset .. code:: bash - openstack image set + openstack image unset [--tag <tag>] - [--property <property>] + [--property <property-key>] <image> .. option:: --tag <tag> Unset a tag on this image (repeat option to unset multiple tags) -.. option:: --property <property> +.. option:: --property <property-key> Unset a property on this image (repeat option to unset multiple properties) diff --git a/doc/source/cli/command-objects/implied_role.rst b/doc/source/cli/command-objects/implied_role.rst new file mode 100644 index 0000000..e43c9ea --- /dev/null +++ b/doc/source/cli/command-objects/implied_role.rst @@ -0,0 +1,57 @@ +============ +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 diff --git a/doc/source/cli/command-objects/mapping.rst b/doc/source/cli/command-objects/mapping.rst index 1f657ed..73dbbc8 100644 --- a/doc/source/cli/command-objects/mapping.rst +++ b/doc/source/cli/command-objects/mapping.rst @@ -2,90 +2,21 @@ mapping ======= -Identity v3 +A **mapping** is used by the Identity service's OS-FEDERATION +extension. It is used by **federation protocols** and **identity providers**. +Applicable to Identity v3. -`Requires: OS-FEDERATION extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping create -mapping create --------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping delete -Create new mapping +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping list -.. program:: mapping create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping set - openstack mapping create - --rules <filename> - <name> - -.. option:: --rules <filename> - - Filename that contains a set of mapping rules (required) - -.. _mapping_create-mapping: -.. describe:: <name> - - New mapping name (must be unique) - -mapping delete --------------- - -Delete mapping(s) - -.. program:: mapping delete -.. code:: bash - - openstack mapping delete - <mapping> [<mapping> ...] - -.. _mapping_delete-mapping: -.. describe:: <mapping> - - Mapping(s) to delete - -mapping list ------------- - -List mappings - -.. program:: mapping list -.. code:: bash - - openstack mapping list - -mapping set ------------ - -Set mapping properties - -.. program:: mapping set -.. code:: bash - - openstack mapping set - [--rules <filename>] - <mapping> - -.. option:: --rules <filename> - - Filename that contains a new set of mapping rules - -.. _mapping_set-mapping: -.. describe:: <mapping> - - Mapping to modify - -mapping show ------------- - -Display mapping details - -.. program:: mapping show -.. code:: bash - - openstack mapping show - <mapping> - -.. _mapping_show-mapping: -.. describe:: <mapping> - - Mapping to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping show diff --git a/doc/source/cli/command-objects/network-qos-rule-type.rst b/doc/source/cli/command-objects/network-qos-rule-type.rst index ee53e30..de6f247 100644 --- a/doc/source/cli/command-objects/network-qos-rule-type.rst +++ b/doc/source/cli/command-objects/network-qos-rule-type.rst @@ -16,3 +16,18 @@ List Network QoS rule types .. code:: bash openstack network qos rule type list + +network qos rule type show +-------------------------- + +Display Network QoS rule type details + +.. program:: network qos rule type show +.. code:: bash + + openstack network qos rule type show + <rule-type-name> + +.. describe:: <rule-type-name> + + Name of QoS rule type (minimum-bandwidth, dscp-marking, bandwidth-limit) diff --git a/doc/source/cli/command-objects/network-rbac.rst b/doc/source/cli/command-objects/network-rbac.rst index c49f29b..45fd354 100644 --- a/doc/source/cli/command-objects/network-rbac.rst +++ b/doc/source/cli/command-objects/network-rbac.rst @@ -19,7 +19,8 @@ Create network RBAC policy openstack network rbac create --type <type> --action <action> - --target-project <target-project> [--target-project-domain <target-project-domain>] + [--target-project <target-project> | --target-all-projects] + [--target-project-domain <target-project-domain>] [--project <project> [--project-domain <project-domain>]] <rbac-policy> @@ -33,7 +34,11 @@ Create network RBAC policy .. option:: --target-project <target-project> - The project to which the RBAC policy will be enforced (name or ID) (required) + The project to which the RBAC policy will be enforced (name or ID) + +.. option:: --target-all-projects + + Allow creating RBAC policy for all projects. .. option:: --target-project-domain <target-project-domain> diff --git a/doc/source/cli/command-objects/object-store-account.rst b/doc/source/cli/command-objects/object-store-account.rst index e8f09d4..6beb63a 100644 --- a/doc/source/cli/command-objects/object-store-account.rst +++ b/doc/source/cli/command-objects/object-store-account.rst @@ -2,44 +2,14 @@ object store account ==================== -Object Storage v1 +An **object store account** represents the top-level of the hierarchy that +is comprised of **containers** and **objects**. Applies to Object Storage v1. -object store account set ------------------------- +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account set -Set account properties +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account show -.. program:: object store account set -.. code:: bash - - openstack object store account set - [--property <key=value> [...] ] - -.. option:: --property <key=value> - - Set a property on this account (repeat option to set multiple properties) - -object store account show -------------------------- - -Display account details - -.. program:: object store account show -.. code:: bash - - openstack object store account show - -object store account unset --------------------------- - -Unset account properties - -.. program:: object store account unset -.. code:: bash - - openstack object store account unset - [--property <key>] - -.. option:: --property <key> - - Property to remove from account (repeat option to remove multiple properties) +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account unset diff --git a/doc/source/cli/command-objects/object.rst b/doc/source/cli/command-objects/object.rst index 4cba38e..8b328bd 100644 --- a/doc/source/cli/command-objects/object.rst +++ b/doc/source/cli/command-objects/object.rst @@ -2,195 +2,26 @@ object ====== -Object Storage v1 +An **object** stores data content, such as documents, images, and so on. They +can also store custom metadata with an object. Applies to Object Storage v1. -object create -------------- +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object create -Upload object to container +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object delete -.. program:: object create -.. code:: bash +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object list - openstack object create - [--name <name>] - <container> - <filename> [<filename> ...] +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object save -.. option:: --name <name> +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object set - Upload a file and rename it. Can only be used when uploading a single object +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object show -.. describe:: <container> - - Container for new object - -.. describe:: <filename> - - Local filename(s) to upload - -object delete -------------- - -Delete object from container - -.. program:: object delete -.. code:: bash - - openstack object delete - <container> - <object> [<object> ...] - -.. describe:: <container> - - Delete object(s) from <container> - -.. describe:: <object> - - Object(s) to delete - -object list ------------ - -List objects - -.. program object list -.. code:: bash - - openstack object list - [--prefix <prefix>] - [--delimiter <delimiter>] - [--marker <marker>] - [--end-marker <end-marker>] - [--limit <num-objects>] - [--long] - [--all] - <container> - -.. option:: --prefix <prefix> - - Filter list using <prefix> - -.. option:: --delimiter <delimiter> - - Roll up items with <delimiter> - -.. option:: --marker <marker> - - Anchor for paging - -.. option:: --end-marker <end-marker> - - End anchor for paging - -.. option:: --limit <num-objects> - - Limit number of objects returned - -.. option:: --long - - List additional fields in output - -.. option:: --all - - List all objects in <container> (default is 10000) - -.. describe:: <container> - - Container to list - -object save ------------ - -Save object locally - -.. program:: object save -.. code:: bash - - openstack object save - [--file <filename>] - <container> - <object> - -.. option:: --file <filename> - - Destination filename (defaults to object name); - using - as the filename will print the file to stdout - -.. describe:: <container> - - Download <object> from <container> - -.. describe:: <object> - - Object to save - -object set ----------- - -Set object properties - -.. program:: object set -.. code:: bash - - openstack object set - [--property <key=value> [...] ] - <container> - <object> - -.. option:: --property <key=value> - - Set a property on this object (repeat option to set multiple properties) - -.. describe:: <container> - - Modify <object> from <container> - -.. describe:: <object> - - Object to modify - -object show ------------ - -Display object details - -.. program:: object show -.. code:: bash - - openstack object show - <container> - <object> - -.. describe:: <container> - - Display <object> from <container> - -.. describe:: <object> - - Object to display - -object unset ------------- - -Unset object properties - -.. program:: object unset -.. code:: bash - - openstack object unset - [--property <key>] - <container> - <object> - -.. option:: --property <key> - - Property to remove from object (repeat option to remove multiple properties) - -.. describe:: <container> - - Modify <object> from <container> - -.. describe:: <object> - - Object to modify +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object unset diff --git a/doc/source/cli/command-objects/policy.rst b/doc/source/cli/command-objects/policy.rst index deddf2c..0fe104c 100644 --- a/doc/source/cli/command-objects/policy.rst +++ b/doc/source/cli/command-objects/policy.rst @@ -2,94 +2,20 @@ policy ====== -Identity v3 +A **policy** is an arbitrarily serialized policy engine rule set to be consumed +by a remote service. Applies to Identity v3. -policy create -------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: policy create -Create new policy +.. autoprogram-cliff:: openstack.identity.v3 + :command: policy delete -.. program:: policy create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: policy list - openstack policy create - [--type <type>] - <filename> +.. autoprogram-cliff:: openstack.identity.v3 + :command: policy set -.. option:: --type <type> - - New MIME type of the policy rules file (defaults to application/json) - -.. describe:: <filename> - - New serialized policy rules file - -policy delete -------------- - -Delete policy(s) - -.. program:: policy delete -.. code:: bash - - openstack policy delete - <policy> [<policy> ...] - -.. describe:: <policy> - - Policy(s) to delete - -policy list ------------ - -List policies - -.. program:: policy list -.. code:: bash - - openstack policy list - [--long] - -.. option:: --long - - List additional fields in output - -policy set ----------- - -Set policy properties - -.. program:: policy set -.. code:: bash - - openstack policy set - [--type <type>] - [--rules <filename>] - <policy> - -.. option:: --type <type> - - New MIME type of the policy rules file - -.. describe:: --rules <filename> - - New serialized policy rules file - -.. describe:: <policy> - - Policy to modify - -policy show ------------ - -Display policy details - -.. program:: policy show -.. code:: bash - - openstack policy show - <policy> - -.. describe:: <policy> - - Policy to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: policy show diff --git a/doc/source/cli/command-objects/port.rst b/doc/source/cli/command-objects/port.rst index c2da09b..f8e8823 100644 --- a/doc/source/cli/command-objects/port.rst +++ b/doc/source/cli/command-objects/port.rst @@ -19,7 +19,7 @@ Create new port openstack port create --network <network> [--description <description>] - [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] + [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip] [--device <device-id>] [--device-owner <device-owner>] [--vnic-type <vnic-type>] @@ -50,6 +50,10 @@ Create new port subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses) +.. option:: --no-fixed-ip + + No IP or subnet for this port + .. option:: --device <device-id> Port device ID @@ -166,7 +170,7 @@ List ports openstack port list [--device-owner <device-owner>] - [--router <router> | --server <server>] + [--router <router> | --server <server> | --device-id <device-id>] [--network <network>] [--mac-address <mac-address>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] @@ -188,6 +192,10 @@ List ports List only ports attached to this server (name or ID) +.. option:: --device-id <device-id> + + List only ports with the specified device ID + .. option:: --network <network> List only ports attached to this network (name or ID) diff --git a/doc/source/cli/command-objects/region.rst b/doc/source/cli/command-objects/region.rst index d2c63c1..58cc341 100644 --- a/doc/source/cli/command-objects/region.rst +++ b/doc/source/cli/command-objects/region.rst @@ -2,103 +2,21 @@ region ====== -Identity v3 +A **region** is a general division of an OpenStack deployment. You can associate +zero or more sub-regions with a region to create a tree-like structured +hierarchy. Applies to Identity v3. -region create -------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: region create -Create new region +.. autoprogram-cliff:: openstack.identity.v3 + :command: region delete -.. program:: region create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: region list - openstack region create - [--parent-region <region-id>] - [--description <description>] - <region-id> +.. autoprogram-cliff:: openstack.identity.v3 + :command: region set -.. option:: --parent-region <region-id> - - Parent region ID - -.. option:: --description <description> - - New region description - -.. _region_create-region-id: -.. describe:: <region-id> - - New region ID - -region delete -------------- - -Delete region(s) - -.. program:: region delete -.. code:: bash - - openstack region delete - <region-id> [<region-id> ...] - -.. _region_delete-region-id: -.. describe:: <region-id> - - Region ID(s) to delete - -region list ------------ - -List regions - -.. program:: region list -.. code:: bash - - openstack region list - [--parent-region <region-id>] - -.. option:: --parent-region <region-id> - - Filter by parent region ID - -region set ----------- - -Set region properties - -.. program:: region set -.. code:: bash - - openstack region set - [--parent-region <region-id>] - [--description <description>] - <region-id> - -.. option:: --parent-region <region-id> - - New parent region ID - -.. option:: --description <description> - - New region description - -.. _region_set-region-id: -.. describe:: <region-id> - - Region to modify - -region show ------------ - -Display region details - -.. program:: region show -.. code:: bash - - openstack region show - <region-id> - -.. _region_show-region-id: -.. describe:: <region-id> - - Region to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: region show diff --git a/doc/source/cli/command-objects/request-token.rst b/doc/source/cli/command-objects/request-token.rst index 3c80780..e10f664 100644 --- a/doc/source/cli/command-objects/request-token.rst +++ b/doc/source/cli/command-objects/request-token.rst @@ -2,57 +2,12 @@ request token ============= -Identity v3 +A **request token** is used by the Identity service's OS-OAUTH1 extension. It +is used by the **consumer** to request **access tokens**. Applicable to +Identity v3. -`Requires: OS-OAUTH1 extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: request token authorize -request token authorize ------------------------ - -Authorize a request token - -.. program:: request token authorize -.. code:: bash - - openstack request token authorize - --request-key <consumer-key> - --role <role> - -.. option:: --request-key <request-key> - - Request token to authorize (ID only) (required) - -.. option:: --role <role> - - Roles to authorize (name or ID) - (repeat option to set multiple values) (required) - -request token create --------------------- - -Create a request token - -.. program:: request token create -.. code:: bash - - openstack request token create - --consumer-key <consumer-key> - --consumer-secret <consumer-secret> - --project <project> - [--domain <domain>] - -.. option:: --consumer-key <consumer-key> - - Consumer key (required) - -.. option:: --description <description> - - Consumer secret (required) - -.. option:: --project <project> - - Project that consumer wants to access (name or ID) (required) - -.. option:: --domain <domain> - - Domain owning <project> (name or ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: request token create diff --git a/doc/source/cli/command-objects/server-backup.rst b/doc/source/cli/command-objects/server-backup.rst index 9ddb2cd..f2a2e2c 100644 --- a/doc/source/cli/command-objects/server-backup.rst +++ b/doc/source/cli/command-objects/server-backup.rst @@ -3,42 +3,9 @@ server backup ============= A server backup is a disk image created in the Image store from a running server -instance. The backup command manages the number of archival copies to retain. +instance. The backup command manages the number of archival copies to retain. Compute v2 -server backup create --------------------- - -Create a server backup image - -.. program:: server create -.. code:: bash - - openstack server backup create - [--name <image-name>] - [--type <backup-type>] - [--rotate <count>] - [--wait] - <server> - -.. option:: --name <image-name> - - Name of the backup image (default: server name) - -.. option:: --type <backup-type> - - Used to populate the ``backup_type`` property of the backup - image (default: empty) - -.. option:: --rotate <count> - - Number of backup images to keep (default: 1) - -.. option:: --wait - - Wait for operation to complete - -.. describe:: <server> - - Server to back up (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: server backup create diff --git a/doc/source/cli/command-objects/server-event.rst b/doc/source/cli/command-objects/server-event.rst index ef4685f..372cb40 100644 --- a/doc/source/cli/command-objects/server-event.rst +++ b/doc/source/cli/command-objects/server-event.rst @@ -2,44 +2,11 @@ server event ============ -Server event is the event record that had been done on a server, include: event -type(create, delete, reboot and so on), event result(success, error), start -time, finish time and so on. These are important information for server -maintains. +Server event are event record for server operations. They consist of: type +(create, delete, reboot and so on), result (success, error), start time, finish +time and so on. These are important for server maintenance. Compute v2 -server event list ------------------ - -List recent events of a server - -.. program:: server event list -.. code:: bash - - openstack server event list - <server> - -.. describe:: <server> - - Server to list events (name or ID) - -server event show ------------------ - -Show server event details - -.. program:: server event show -.. code:: bash - - openstack server event show - <server> - <request-id> - -.. describe:: <server> - - Server to show event details (name or ID) - -.. describe:: <request-id> - - Request ID of the event to show (ID only) +.. autoprogram-cliff:: openstack.compute.v2 + :command: server event * diff --git a/doc/source/cli/command-objects/server-group.rst b/doc/source/cli/command-objects/server-group.rst index 9769635..741eb4a 100644 --- a/doc/source/cli/command-objects/server-group.rst +++ b/doc/source/cli/command-objects/server-group.rst @@ -2,79 +2,9 @@ server group ============ -Server group provides a mechanism to group servers according to certain policy. +Server groups provide a mechanism to group servers according to certain policy. Compute v2 -server group create -------------------- - -Create a new server group - -.. program:: server group create -.. code-block:: bash - - openstack server group create - --policy <policy> - <name> - -.. option:: --policy <policy> - - Add a policy to :ref:`\<name\> <server_group_create-name>` - ('affinity' or 'anti-affinity', default to 'affinity') - -.. _server_group_create-name: -.. describe:: <name> - - New server group name - -server group delete -------------------- - -Delete existing server group(s) - -.. program:: server group delete -.. code-block:: bash - - openstack server group delete - <server-group> [<server-group> ...] - -.. describe:: <server-group> - - Server group(s) to delete (name or ID) - (repeat to delete multiple server groups) - -server group list ------------------ - -List all server groups - -.. program:: server group list -.. code-block:: bash - - openstack server group list - [--all-projects] - [--long] - -.. option:: --all-projects - - Display information from all projects (admin only) - -.. option:: --long - - List additional fields in output - -server group show ------------------ - -Display server group details - -.. program:: server group show -.. code-block:: bash - - openstack server group show - <server-group> - -.. describe:: <server-group> - - Server group to display (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: server group * diff --git a/doc/source/cli/command-objects/server-image.rst b/doc/source/cli/command-objects/server-image.rst index 7e625d9..c013ca4 100644 --- a/doc/source/cli/command-objects/server-image.rst +++ b/doc/source/cli/command-objects/server-image.rst @@ -7,27 +7,5 @@ image is created in the Image store. Compute v2 -server image create -------------------- - -Create a new server disk image from an existing server - -.. program:: server image create -.. code:: bash - - openstack server image create - [--name <image-name>] - [--wait] - <server> - -.. option:: --name <image-name> - - Name of new disk image (default: server name) - -.. option:: --wait - - Wait for operation to complete - -.. describe:: <server> - - Server to create image (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: server image create diff --git a/doc/source/cli/command-objects/service-provider.rst b/doc/source/cli/command-objects/service-provider.rst index 63ef44e..a92c3b2 100644 --- a/doc/source/cli/command-objects/service-provider.rst +++ b/doc/source/cli/command-objects/service-provider.rst @@ -1,125 +1,22 @@ -================ -service provider -================ +================= +identity provider +================= -Identity v3 +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. -`Requires: OS-FEDERATION extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: service provider create -service provider create ------------------------ +.. autoprogram-cliff:: openstack.identity.v3 + :command: service provider delete -Create new service provider +.. autoprogram-cliff:: openstack.identity.v3 + :command: service provider list -.. program:: service provider create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: service provider set - openstack service provider create - [--description <description>] - [--enable | --disable] - --auth-url <auth-url> - --service-provider-url <sp-url> - <name> - -.. option:: --auth-url - - Authentication URL of remote federated service provider (required) - -.. option:: --service-provider-url - - A service URL where SAML assertions are being sent (required) - -.. option:: --description - - New service provider description - -.. option:: --enable - - Enable the service provider (default) - -.. option:: --disable - - Disable the service provider - -.. describe:: <name> - - New service provider name (must be unique) - -service provider delete ------------------------ - -Delete service provider(s) - -.. program:: service provider delete -.. code:: bash - - openstack service provider delete - <service-provider> [<service-provider> ...] - -.. describe:: <service-provider> - - Service provider(s) to delete - -service provider list ---------------------- - -List service providers - -.. program:: service provider list -.. code:: bash - - openstack service provider list - -service provider set --------------------- - -Set service provider properties - -.. program:: service provider set -.. code:: bash - - openstack service provider set - [--enable | --disable] - [--description <description>] - [--auth-url <auth-url>] - [--service-provider-url <sp-url>] - <service-provider> - -.. option:: --service-provider-url - - New service provider URL, where SAML assertions are sent - -.. option:: --auth-url - - New Authentication URL of remote federated service provider - -.. option:: --description - - New service provider description - -.. option:: --enable - - Enable the service provider - -.. option:: --disable - - Disable the service provider - -.. describe:: <service-provider> - - Service provider to modify - -service provider show ---------------------- - -Display service provider details - -.. program:: service provider show -.. code:: bash - - openstack service provider show - <service-provider> - -.. describe:: <service-provider> - - Service provider to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: service provider show diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst index c228dc2..0a56ccf 100644 --- a/doc/source/cli/command-objects/subnet.rst +++ b/doc/source/cli/command-objects/subnet.rst @@ -18,7 +18,7 @@ Create new subnet openstack subnet create [--project <project> [--project-domain <project-domain>]] - [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>]] + [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>] | --use-prefix-delegation] [--subnet-range <subnet-range>] [--allocation-pool start=<ip-address>,end=<ip-address>] [--dhcp | --no-dhcp] @@ -48,6 +48,11 @@ Create new subnet Subnet pool from which this subnet will obtain a CIDR (name or ID) +.. option:: --use-prefix-delegation + + Use 'prefix-delegation' if IP is IPv6 format and IP would be delegated + externally + .. option:: --use-default-subnet-pool Use default subnet pool for :option:`--ip-version` diff --git a/doc/source/cli/command-objects/trust.rst b/doc/source/cli/command-objects/trust.rst index 28459bc..febef1c 100644 --- a/doc/source/cli/command-objects/trust.rst +++ b/doc/source/cli/command-objects/trust.rst @@ -2,101 +2,17 @@ trust ===== -Identity v3 +A **trust** provide project-specific role delegation between users, with +optional impersonation. Requires the OS-TRUST extension. Applies to Identity v3. -trust create ------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: trust create -Create new trust +.. autoprogram-cliff:: openstack.identity.v3 + :command: trust delete -.. program:: trust create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: trust list - openstack trust create - --project <project> - --role <role> - [--impersonate] - [--expiration <expiration>] - [--project-domain <domain>] - [--trustor-domain <domain>] - [--trustee-domain <domain>] - <trustor> - <trustee> - -.. option:: --project <project> - - Project being delegated (name or ID) (required) - -.. option:: --role <role> - - Roles to authorize (name or ID) (repeat option to set multiple values, required) - -.. option:: --impersonate - - Tokens generated from the trust will represent <trustor> (defaults to False) - -.. option:: --expiration <expiration> - - Sets an expiration date for the trust (format of YYYY-mm-ddTHH:MM:SS) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. option:: --trustor-domain <trustor-domain> - - Domain that contains <trustor> (name or ID) - -.. option:: --trustee-domain <trustee-domain> - - Domain that contains <trustee> (name or ID) - -.. describe:: <trustor-user> - - User that is delegating authorization (name or ID) - -.. describe:: <trustee-user> - - User that is assuming authorization (name or ID) - - -trust delete ------------- - -Delete trust(s) - -.. program:: trust delete -.. code:: bash - - openstack trust delete - <trust> [<trust> ...] - -.. describe:: <trust> - - Trust(s) to delete - -trust list ----------- - -List trusts - -.. program:: trust list -.. code:: bash - - openstack trust list - -trust show ----------- - -Display trust details - -.. program:: trust show -.. code:: bash - - openstack trust show - <trust> - -.. describe:: <trust> - - Trust to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: trust show diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst index 5a7977e..0c1992a 100644 --- a/doc/source/cli/commands.rst +++ b/doc/source/cli/commands.rst @@ -173,6 +173,11 @@ conflicts when creating new plugins. For a complete list check out * ``acl user``: (**Key Manager (Barbican)**) * ``action definition``: (**Workflow Engine (Mistral)**) * ``action execution``: (**Workflow Engine (Mistral)**) +* ``appcontainer``: (**Application Container (Zun)**) +* ``appcontainer host``: (**Application Container (Zun)**) +* ``appcontainer image``: (**Application Container (Zun)**) +* ``appcontainer network``: (**Application Container (Zun)**) +* ``appcontainer service``: (**Application Container (Zun)**) * ``baremetal``: (**Baremetal (Ironic)**) * ``claim``: (**Messaging (Zaqar)**) * ``cluster``: (**Clustering (Senlin)**) @@ -204,6 +209,7 @@ conflicts when creating new plugins. For a complete list check out * ``data protection trigger``: (**Data Protection (Karbor)**) * ``data protection checkpoint``: (**Data Protection (Karbor)**) * ``data protection scheduledoperation``: (**Data Protection (Karbor)**) +* ``data protection operationlog``: (**Data Protection (Karbor)**) * ``loadbalancer``: (**Load Balancer (Octavia)**) * ``loadbalancer healthmonitor``: (**Load Balancer (Octavia)**) * ``loadbalancer l7policy``: (**Load Balancer (Octavia)**) @@ -222,6 +228,7 @@ conflicts when creating new plugins. For a complete list check out * ``ptr record``: (**DNS (Designate)**) * ``queue``: (**Messaging (Zaqar)**) * ``recordset``: (**DNS (Designate)**) +* ``rsd``: (**Disaggregated Hardware Resource Management (RSD)**) * ``search`` (**Search (Searchlight)**) * ``search facet`` (**Search (Searchlight)**) * ``search resource type`` (**Search (Searchlight)**) diff --git a/doc/source/cli/man/openstack.rst b/doc/source/cli/man/openstack.rst index ab99097..632ba4b 100644 --- a/doc/source/cli/man/openstack.rst +++ b/doc/source/cli/man/openstack.rst @@ -502,7 +502,7 @@ http://www.apache.org/licenses/LICENSE-2.0 SEE ALSO ======== -The `OpenStackClient page <http://docs.openstack.org/developer/python-openstackclient/>`_ +The `OpenStackClient page <https://docs.openstack.org/python-openstackclient/latest/>`_ in the `OpenStack Docs <https://docs.openstack.org/>`_ contains further documentation. diff --git a/doc/source/cli/plugin-commands.rst b/doc/source/cli/plugin-commands.rst index 90c14b8..ae2e655 100644 --- a/doc/source/cli/plugin-commands.rst +++ b/doc/source/cli/plugin-commands.rst @@ -32,7 +32,7 @@ congress designate --------- -.. list-plugins:: openstack.dns.v1 +.. list-plugins:: openstack.dns.v2 :detailed: gnocchi @@ -58,11 +58,11 @@ ironic-inspector .. list-plugins:: openstack.baremetal_introspection.v1 :detailed: -.. karbor -.. ------ -.. bug 1705258: Exclude karborclient 0.4.0 until a fixed version is released. -.. .. list-plugins:: openstack.data_protection.v1 -.. :detailed: +karbor +------ + +.. list-plugins:: openstack.data_protection.v1 + :detailed: mistral ------- @@ -87,6 +87,12 @@ octavia .. list-plugins:: openstack.load_balancer.v2 :detailed: +rsd +--- + +.. list-plugins:: openstack.rsd.v1 + :detailed: + sahara ------ @@ -126,3 +132,9 @@ zaqar .. list-plugins:: openstack.messaging.v2 :detailed: + +zun +--- + +.. list-plugins:: openstack.container.v1 + :detailed: diff --git a/doc/source/conf.py b/doc/source/conf.py index bd4fa73..d7efbd7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -187,6 +187,9 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M' # Output file base name for HTML help builder. htmlhelp_basename = 'OpenStackCommandLineClientdoc' +# Add any paths that contain "extra" files, such as .htaccess or robots.txt +html_extra_path = ['_extra'] + # -- Options for LaTeX output ------------------------------------------------- @@ -278,4 +281,4 @@ autoprogram_cliff_application = 'openstack' autoprogram_cliff_ignored = [ '--help', '--format', '--column', '--max-width', '--fit-width', - '--print-empty', '--prefix', '--noindent'] + '--print-empty', '--prefix', '--noindent', '--quote'] diff --git a/doc/source/contributor/command-logs.rst b/doc/source/contributor/command-logs.rst index 6212651..c203d02 100644 --- a/doc/source/contributor/command-logs.rst +++ b/doc/source/contributor/command-logs.rst @@ -10,7 +10,7 @@ OpenStack projects. The following basic rules should be followed. 2. All logs except debug log need to be translated. The log message strings that need to be translated should follow the rule of i18n guidelines: - http://docs.openstack.org/developer/oslo.i18n/guidelines.html + https://docs.openstack.org/oslo.i18n/latest/user/guidelines.html 3. There are mainly two kinds of logs in OpenStackClient: command specific log and general log. Use different logger to record them. The examples diff --git a/doc/source/contributor/command-options.rst b/doc/source/contributor/command-options.rst index 0662344..70890ec 100644 --- a/doc/source/contributor/command-options.rst +++ b/doc/source/contributor/command-options.rst @@ -14,7 +14,7 @@ for defining and using options in all situations. The alternative of only using it when necessary leads to errors when copy-n-paste is used for a new command without understanding why or why not that instance is correct. -The :ref:`hig` describes the guildelines for option names and usage. +The :ref:`hig` describes the guidelines for option names and usage. In short: * All option names shall be GNU-style long names (two leading dashes). diff --git a/doc/source/contributor/developing.rst b/doc/source/contributor/developing.rst index 2981ba4..721a016 100644 --- a/doc/source/contributor/developing.rst +++ b/doc/source/contributor/developing.rst @@ -177,7 +177,7 @@ or Standardize Import Format ========================= -.. _`Import Order Guide`: http://docs.openstack.org/developer/hacking/#imports +.. _`Import Order Guide`: https://docs.openstack.org/hacking/latest/user/hacking.html#imports The import order shows below: diff --git a/doc/source/contributor/plugins.rst b/doc/source/contributor/plugins.rst index fb21a07..51aec9a 100644 --- a/doc/source/contributor/plugins.rst +++ b/doc/source/contributor/plugins.rst @@ -36,6 +36,7 @@ The following is a list of projects that are an OpenStackClient plugin. - python-muranoclient - python-neutronclient\*\*\* - python-octaviaclient +- python-rsdclient - python-saharaclient - python-searchlightclient - python-senlinclient @@ -43,6 +44,7 @@ The following is a list of projects that are an OpenStackClient plugin. - python-troveclient - python-watcherclient - python-zaqarclient +- python-zunclient \*\* Note that some clients are not listed in global-requirements. @@ -216,16 +218,13 @@ more steps needed to fully integrate the client with openstackclient. Add the command checker to your CI ---------------------------------- -#. Modify the section of ``zuul/layout.yaml`` related to your repository to - add ``osc-plugin-jobs`` to the list of job templates for your project. - This job checks that to see if any new commands are: duplicated, missing - entry points, or have overlap; across all openstackclient plugins. +#. Add ``openstackclient-plugin-jobs`` to the list of job templates for your project. + These jobs ensures that all plugin libraries are co-installable with + ``python-openstackclient`` and checks for conflicts across all OpenStackClient + plugins, such as duplicated commands, missing entry points, or other overlaps. -#. Update ``jenkins/scripts/check-osc-plugins.sh`` to include your new - library to be installed from source. This is essential in running the - previously mentioned check job. Simply add - ``install_from_source python-fooclient`` to the block of code where all - other clients are installed. +#. Add your project to the ``required-projects`` list in the ``.zuul.yaml`` file + in the ``openstack/openstackclient`` repo. Changes to python-openstackclient --------------------------------- @@ -243,4 +242,4 @@ Changes to python-openstackclient #. Update ``test-requirements.txt`` to include fooclient. This is necessary to auto-document the commands in the previous step. -.. _sphinxext: http://docs.openstack.org/developer/stevedore/sphinxext.html +.. _sphinxext: https://docs.openstack.org/stevedore/latest/user/sphinxext.html diff --git a/doc/source/contributor/specs/network-topology.rst b/doc/source/contributor/specs/network-topology.rst index 6789ee9..6789ee9 100755..100644 --- a/doc/source/contributor/specs/network-topology.rst +++ b/doc/source/contributor/specs/network-topology.rst |