From 04ef8a41acbd45ef03253240934fa07ec170d7f4 Mon Sep 17 00:00:00 2001 From: Reedip Date: Tue, 8 Aug 2017 09:23:44 +0530 Subject: Allow PD as Subnetpool during Subnet creations This commit now allows user to specify 'prefix_delegation' as a Subnetpool during Subnet creation by using the new --use-prefix-delegation option so that the IPv6 prefixes can be delegated to routers set up by the cloud admins. Change-Id: I67e5d81c4155db2e3c5c41ee1df77f2d77a17689 Closes-Bug: #1513894 --- doc/source/cli/command-objects/subnet.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'doc/source/cli/command-objects') diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst index c228dc20..0a56ccf1 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-domain ]] - [--subnet-pool | --use-default-subnet-pool [--prefix-length ]] + [--subnet-pool | --use-default-subnet-pool [--prefix-length ] | --use-prefix-delegation] [--subnet-range ] [--allocation-pool start=,end=] [--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` -- cgit v1.2.1 From 4d7b4efeb508f63afbb4b12b9a4506f9fb940d7e Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Thu, 17 Aug 2017 16:46:31 -0400 Subject: auto-generate object docs Change-Id: I832eade2ddab754664e5f57b9764e524e655e616 --- doc/source/cli/command-objects/container.rst | 154 ++-------------- .../cli/command-objects/object-store-account.rst | 46 +---- doc/source/cli/command-objects/object.rst | 201 ++------------------- 3 files changed, 39 insertions(+), 362 deletions(-) (limited to 'doc/source/cli/command-objects') diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst index e68955ad..83deeb81 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 - [ ...] +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container save -.. describe:: +.. 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] - [ ...] - -.. option:: --recursive, -r - - Recursively delete objects in container before container delete - -.. describe:: - - Container(s) to delete - -container list --------------- - -List containers - -.. program:: container list -.. code:: bash - - openstack container list - [--prefix ] - [--marker ] - [--end-marker ] - [--limit ] - [--long] - [--all] - -.. option:: --prefix - - Filter list using - -.. option:: --marker - - Anchor for paging - -.. option:: --end-marker - - End anchor for paging - -.. option:: --limit - - 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 - - -.. describe:: - - Container to save - -container set -------------- - -Set container properties - -.. program:: container set -.. code:: bash - - openstack container set - [--property [...] ] - - -.. option:: --property - - Set a property on this container (repeat option to set multiple properties) - -.. describe:: - - Container to modify - -container show --------------- - -Display container details - -.. program:: container show -.. code:: bash - - openstack container show - - -.. describe:: - - Container to display - -container unset ---------------- - -Unset container properties - -.. program:: container unset -.. code:: bash - - openstack container unset - [--property ] - - -.. option:: --property - - Property to remove from container (repeat option to remove multiple properties) - -.. describe:: - - Container to modify +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container unset diff --git a/doc/source/cli/command-objects/object-store-account.rst b/doc/source/cli/command-objects/object-store-account.rst index e8f09d45..6beb63af 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 [...] ] - -.. option:: --property - - 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 ] - -.. option:: --property - - 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 4cba38ee..8b328bd5 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 ] - - [ ...] +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object save -.. option:: --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 for new object - -.. describe:: - - Local filename(s) to upload - -object delete -------------- - -Delete object from container - -.. program:: object delete -.. code:: bash - - openstack object delete - - [ ...] - -.. describe:: - - Delete object(s) from - -.. describe:: - - Object(s) to delete - -object list ------------ - -List objects - -.. program object list -.. code:: bash - - openstack object list - [--prefix ] - [--delimiter ] - [--marker ] - [--end-marker ] - [--limit ] - [--long] - [--all] - - -.. option:: --prefix - - Filter list using - -.. option:: --delimiter - - Roll up items with - -.. option:: --marker - - Anchor for paging - -.. option:: --end-marker - - End anchor for paging - -.. option:: --limit - - Limit number of objects returned - -.. option:: --long - - List additional fields in output - -.. option:: --all - - List all objects in (default is 10000) - -.. describe:: - - Container to list - -object save ------------ - -Save object locally - -.. program:: object save -.. code:: bash - - openstack object save - [--file ] - - - -.. option:: --file - - Destination filename (defaults to object name); - using - as the filename will print the file to stdout - -.. describe:: - - Download from - -.. describe:: - - Object to save - -object set ----------- - -Set object properties - -.. program:: object set -.. code:: bash - - openstack object set - [--property [...] ] - - - -.. option:: --property - - Set a property on this object (repeat option to set multiple properties) - -.. describe:: - - Modify from - -.. describe:: - - Object to modify - -object show ------------ - -Display object details - -.. program:: object show -.. code:: bash - - openstack object show - - - -.. describe:: - - Display from - -.. describe:: - - Object to display - -object unset ------------- - -Unset object properties - -.. program:: object unset -.. code:: bash - - openstack object unset - [--property ] - - - -.. option:: --property - - Property to remove from object (repeat option to remove multiple properties) - -.. describe:: - - Modify from - -.. describe:: - - Object to modify +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object unset -- cgit v1.2.1 From 8cd3e258c5029a8efedab40019d6cfd3eac379f5 Mon Sep 17 00:00:00 2001 From: Harry Rybacki Date: Wed, 19 Jul 2017 13:07:34 +0000 Subject: Implied Roles Allow the user to create an inference rule between two roles. The first, called the prior role is the role explicitly assigned to an individual. The second, called the implied role, is one that the user gets implicitly. For example: Role B implies Role A. User X is assigned Role B. Therefore User X also assigned Role A. The management and maintenance of the rules is performed in the Keystone server. Change-Id: If547c2f16e812bc7fffd742ec37e6a26011f3185 --- doc/source/cli/command-objects/implied_role.rst | 57 +++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 doc/source/cli/command-objects/implied_role.rst (limited to 'doc/source/cli/command-objects') 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 00000000..e43c9ea3 --- /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 + + --implied-role + +.. option:: + + Prior role (name or ID) implies another role + +.. option:: --implied-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 + + --implied-role + +.. option:: + + Prior role (name or ID) implies another role + +.. option:: --implied-role + + (name or ID) implied by another role + +implied role list +----------------- + +List implied roles + +.. program:: implied role list +.. code:: bash + + openstack implied role list -- cgit v1.2.1 From ff91e26983578bf1b77e1d68fb1ae26067eed7ea Mon Sep 17 00:00:00 2001 From: lihaijing Date: Wed, 23 Aug 2017 11:23:27 +0800 Subject: Update image cli doc and fix some typos Change-Id: I0a8d095e51a96804c97612e28fac2d00aa94c638 Closes-Bug: #1711284 --- doc/source/cli/command-objects/image.rst | 64 ++++++++++++++++++-------------- 1 file changed, 37 insertions(+), 27 deletions(-) (limited to 'doc/source/cli/command-objects') diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst index 92efd0a5..e2257bbb 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 ] - + + .. option:: --project-domain @@ -60,7 +61,8 @@ Create/upload an image [--public | --private | --community | --shared] [--property [...] ] [--tag [...] ] - [--project [--project-domain ]] + [--project ] + [--project-domain ] .. option:: --id @@ -153,11 +155,11 @@ Create/upload an image .. option:: --property - Set a property on this image (repeat for multiple values) + Set a property on this image (repeat option to set multiple properties) .. option:: --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 ] + [--name ] + [--status ] [--long] [--sort [:]] [--limit ] [--marker ] - [--name ] - [--status ] - .. option:: --public @@ -231,6 +232,18 @@ List available images Filter output based on property +.. option:: --name + + Filter images based on name + + *Image version 2 only.* + +.. option:: --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 - - Filter images based on name - -.. option:: --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 ] @@ -347,8 +351,9 @@ Set image properties [--os-distro ] [--os-version ] [--ramdisk-id ] - [--activate|--deactivate] - [--project [--project-domain ]] + [--deactivate | --activate] + [--project ] + [--project-domain ] [--accept | --reject | --pending] @@ -460,7 +465,7 @@ Set image properties .. option:: --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] +.. option:: --human-readable + + Print image size in a human-friendly format. + .. _image_show-image: .. describe:: @@ -585,16 +595,16 @@ Unset image tags or properties .. program:: image unset .. code:: bash - openstack image set + openstack image unset [--tag ] - [--property ] + [--property ] .. option:: --tag Unset a tag on this image (repeat option to unset multiple tags) -.. option:: --property +.. option:: --property Unset a property on this image (repeat option to unset multiple properties) -- cgit v1.2.1