diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/image.rst | 81 | ||||
| -rw-r--r-- | doc/source/command-objects/role.rst | 18 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 19 |
3 files changed, 107 insertions, 11 deletions
diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 25741424..d2698b0b 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -7,7 +7,7 @@ Image v1, v2 image create ------------ -*Only supported for Image v1* +*Image v1, v2* Create/upload an image @@ -32,6 +32,7 @@ Create/upload an image [--protected | --unprotected] [--public | --private] [--property <key=value> [...] ] + [--tag <tag> [...] ] <image-name> .. option:: --id <id> @@ -42,6 +43,8 @@ Create/upload an image Upload image to this store + *Image version 1 only.* + .. option:: --container-format <container-format> Image container format (default: bare) @@ -54,10 +57,14 @@ Create/upload an image Image owner project name or ID + *Image version 1 only.* + .. option:: --size <size> Image size, in bytes (only used with --location and --copy-from) + *Image version 1 only.* + .. option:: --min-disk <disk-gb> Minimum disk size needed to boot image, in gigabytes @@ -70,10 +77,14 @@ Create/upload an image Download image from an existing URL + *Image version 1 only.* + .. option:: --copy-from <image-url> Copy image from the data store (similar to --location) + *Image version 1 only.* + .. option:: --file <file> Upload image from local file @@ -90,6 +101,8 @@ Create/upload an image Image hash used for verification + *Image version 1 only.* + .. option:: --protected Prevent image from being deleted @@ -110,6 +123,12 @@ Create/upload an image Set a property on this image (repeat for multiple values) +.. option:: --tag <tag> + + Set a tag on this image (repeat for multiple values) + + .. versionadded:: 2 + .. describe:: <image-name> New image name @@ -193,7 +212,7 @@ Save an image locally image set --------- -*Only supported for Image v1* +*Image v1, v2* Set image properties @@ -252,6 +271,8 @@ Set image properties Size of image data (in bytes) + *Image version 1 only.* + .. option:: --protected Prevent image from being deleted @@ -272,38 +293,94 @@ Set image properties 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 --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 --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 for multiple values) + *Image version 1 only.* + +.. option:: --architecture <architecture> + + Operating system Architecture + + .. versionadded:: 2 + +.. option:: --ramdisk-id <ramdisk-id> + + ID of image stored in Glance that should be used as + the ramdisk when booting an AMI-style image + + .. versionadded:: 2 + +.. option:: --os-distro <os-distro> + + Common name of operating system distribution + + .. versionadded:: 2 + +.. option:: --os-version <os-version> + + Operating system version as specified by the distributor + + .. versionadded:: 2 + +.. option:: --kernel-id <kernel-id> + + ID of image in Glance that should be used as the + kernel when booting an AMI-style image + + .. versionadded:: 2 + +.. option:: --instance-uuid <instance_uuid> + + ID of instance used to create this image + + .. versionadded:: 2 + .. describe:: <image> Image to modify (name or ID) diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 9ba149ec..48751ed7 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -20,21 +20,21 @@ Add role to a user or group in a project or domain .. option:: --domain <domain> - Include `<domain>` (name or ID) + Include <domain> (name or ID) .. versionadded:: 3 .. option:: --project <project> - Include `<project>` (name or ID) + Include <project> (name or ID) .. option:: --user <user> - Include `<user>` (name or ID) + Include <user> (name or ID) .. option:: --group <group> - Include `<group>` (name or ID) + Include <group> (name or ID) .. versionadded:: 3 @@ -67,7 +67,7 @@ Add role to a user or group in a project or domain .. describe:: <role> - Role to add to `<project>`:`<user>` (name or ID) + Role to add to <project>:<user> (name or ID) role create ----------- @@ -186,21 +186,21 @@ Remove role from domain/project : user/group .. option:: --domain <domain> - Include `<domain>` (name or ID) + Include <domain> (name or ID) .. versionadded:: 3 .. option:: --project <project> - Include `<project>` (name or ID) + Include <project> (name or ID) .. option:: --user <user> - Include `<user>` (name or ID) + Include <user> (name or ID) .. option:: --group <group> - Include `<group>` (name or ID) + Include <group> (name or ID) .. versionadded:: 3 diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index eb61bab5..9ff48437 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -185,6 +185,7 @@ List servers [--image <image>] [--host <hostname>] [--all-projects] + [--project <project> [--project-domain <project-domain>]] [--long] .. option:: --reservation-id <reservation-id> @@ -227,6 +228,24 @@ List servers Include all projects (admin only) +.. option:: --project <project> + + Search by project (admin only) (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:: --user <user> + + Search by user (admin only) (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:: --long List additional fields in output |