Command doc: image

Change-Id: Ib1563b58351315dc2a44ad77882f8c834a1214c0
This commit is contained in:
Steve Martinelli 2015-01-08 02:54:26 -05:00
parent f38d6e7aee
commit 0d7a50d384
4 changed files with 260 additions and 15 deletions

View File

@ -0,0 +1,245 @@
======
image
======
Image v1, v2
image create
------------
*Only supported for Image v1*
Create/upload an image
.. program:: image create
.. code:: bash
os image create
[--id <id>]
[--store <store>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--owner <project>]
[--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]
[--property <key=value> [...] ]
<image-name>
.. option:: --id <id>
Image ID to reserve
.. option:: --store <store>
Upload image to this store
.. option:: --container-format <container-format>
Image container format (default: bare)
.. option:: --disk-format <disk-format>
Image disk format (default: raw)
.. option:: --owner <project>
Image owner project name or ID
.. option:: --size <size>
Image size, in bytes (only used with --location and --copy-from)
.. option:: --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
.. option:: --min-ram <disk-ram>
Minimum RAM size needed to boot image, in megabytes
.. option:: --location <image-url>
Download image from an existing URL
.. option:: --copy-from <image-url>
Copy image from the data store (similar to --location)
.. 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 --volume)
.. option:: --checksum <checksum>
Image hash used for verification
.. 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:: --property <key=value>
Set a property on this image (repeat for multiple values)
.. describe:: <image-name>
New image name
image delete
------------
Delete image(s)
.. program:: image delete
.. code:: bash
os image delete
<image>
.. describe:: <image>
Image(s) to delete (name or ID)
image list
----------
List available images
.. program:: image list
.. code:: bash
os image list
[--page-size <size>]
[--long]
.. option:: --page-size <size>
Number of images to request in each paginated request
.. option:: --long
List additional fields in output
image save
----------
Save an image locally
.. program:: image save
.. code:: bash
os image save
--file <filename>
<image>
.. option:: --file <filename>
Downloaded image save filename (default: stdout)
.. describe:: <image>
Image to save (name or ID)
image set
---------
*Only supported for Image v1*
Set image properties
.. program:: image set
.. code:: bash
os image set
[--name <name>]
[--owner <project>]
[--min-disk <disk-gb>]
[--min-ram <disk-ram>]
[--protected | --unprotected]
[--public | --private]
[--property <key=value> [...] ]
<image>
.. option:: --name <name>
New image name
.. option:: --owner <project>
New image owner project (name or ID)
.. option:: --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
.. option:: --min-ram <disk-ram>
Minimum RAM size needed to boot image, in megabytes
.. 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:: --property <key=value>
Set a property on this image (repeat for multiple values)
.. describe:: <image>
Image to modify (name or ID)
image show
----------
Display image details
.. program:: image show
.. code:: bash
os image show
<image>
.. describe:: <image>
Image to display (name or ID)

View File

@ -89,7 +89,7 @@ referring to both Compute and Volume quotas.
* ``host``: Compute - the physical computer running a hypervisor
* ``hypervisor``: Compute - the virtual machine manager
* ``identity provider``: (**Identity**) a source of users and authentication
* ``image``: Image - a disk image
* ``image``: (**Image**) a disk image
* ``ip fixed``: Compute, Network - an internal IP address assigned to a server
* ``ip floating``: Compute, Network - a public IP address that can be mapped to a server
* ``keypair``: (**Compute**) an SSH public key

View File

@ -49,7 +49,7 @@ class CreateImage(show.ShowOne):
parser = super(CreateImage, self).get_parser(prog_name)
parser.add_argument(
"name",
metavar="<name>",
metavar="<image-name>",
help="New image name",
)
parser.add_argument(
@ -159,7 +159,7 @@ class CreateImage(show.ShowOne):
dest="properties",
metavar="<key=value>",
action=parseractions.KeyValueAction,
help="Set an image property "
help="Set a property on this image "
"(repeat option to set multiple properties)",
)
return parser
@ -337,12 +337,12 @@ class SaveImage(command.Command):
parser.add_argument(
"--file",
metavar="<filename>",
help="Downloaded image save filename [default: stdout]",
help="Downloaded image save filename (default: stdout)",
)
parser.add_argument(
"image",
metavar="<image>",
help="Name or ID of image to save",
help="Image to save (name or ID)",
)
return parser
@ -360,7 +360,7 @@ class SaveImage(command.Command):
class SetImage(show.ShowOne):
"""Change image properties"""
"""Set image properties"""
log = logging.getLogger(__name__ + ".SetImage")
@ -369,7 +369,7 @@ class SetImage(show.ShowOne):
parser.add_argument(
"image",
metavar="<image>",
help="Image name or ID to change",
help="Image to modify (name or ID)",
)
parser.add_argument(
"--name",
@ -379,7 +379,7 @@ class SetImage(show.ShowOne):
parser.add_argument(
"--owner",
metavar="<project>",
help="New image owner project name or ID",
help="New image owner project (name or ID)",
)
parser.add_argument(
"--min-disk",
@ -420,7 +420,7 @@ class SetImage(show.ShowOne):
dest="properties",
metavar="<key=value>",
action=parseractions.KeyValueAction,
help="Set an image property "
help="Set a property on this image "
"(repeat option to set multiple properties)",
)
return parser
@ -474,7 +474,7 @@ class SetImage(show.ShowOne):
class ShowImage(show.ShowOne):
"""Show image details"""
"""Display image details"""
log = logging.getLogger(__name__ + ".ShowImage")
@ -483,7 +483,7 @@ class ShowImage(show.ShowOne):
parser.add_argument(
"image",
metavar="<image>",
help="Name or ID of image to display",
help="Image to display (name or ID)",
)
return parser

View File

@ -102,12 +102,12 @@ class SaveImage(command.Command):
parser.add_argument(
"--file",
metavar="<filename>",
help="Downloaded image save filename [default: stdout]",
help="Downloaded image save filename (default: stdout)",
)
parser.add_argument(
"image",
metavar="<image>",
help="Name or ID of image to save",
help="Image to save (name or ID)",
)
return parser
@ -125,7 +125,7 @@ class SaveImage(command.Command):
class ShowImage(show.ShowOne):
"""Show image details"""
"""Display image details"""
log = logging.getLogger(__name__ + ".ShowImage")
@ -134,7 +134,7 @@ class ShowImage(show.ShowOne):
parser.add_argument(
"image",
metavar="<image>",
help="Name or ID of image to display",
help="Image to display (name or ID)",
)
return parser