From 0d7a50d3848484d6562dbd6af87de7836365821a Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Thu, 8 Jan 2015 02:54:26 -0500 Subject: [PATCH] Command doc: image Change-Id: Ib1563b58351315dc2a44ad77882f8c834a1214c0 --- doc/source/command-objects/image.rst | 245 +++++++++++++++++++++++++++ doc/source/commands.rst | 2 +- openstackclient/image/v1/image.py | 20 +-- openstackclient/image/v2/image.py | 8 +- 4 files changed, 260 insertions(+), 15 deletions(-) create mode 100644 doc/source/command-objects/image.rst diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst new file mode 100644 index 0000000000..d9b77266f2 --- /dev/null +++ b/doc/source/command-objects/image.rst @@ -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 ] + [--store ] + [--container-format ] + [--disk-format ] + [--owner ] + [--size ] + [--min-disk ] + [--min-ram ] + [--location ] + [--copy-from ] + [--file ] + [--volume ] + [--force] + [--checksum ] + [--protected | --unprotected] + [--public | --private] + [--property [...] ] + + +.. option:: --id + + Image ID to reserve + +.. option:: --store + + Upload image to this store + +.. option:: --container-format + + Image container format (default: bare) + +.. option:: --disk-format + + Image disk format (default: raw) + +.. option:: --owner + + Image owner project name or ID + +.. option:: --size + + Image size, in bytes (only used with --location and --copy-from) + +.. option:: --min-disk + + Minimum disk size needed to boot image, in gigabytes + +.. option:: --min-ram + + Minimum RAM size needed to boot image, in megabytes + +.. option:: --location + + Download image from an existing URL + +.. option:: --copy-from + + Copy image from the data store (similar to --location) + +.. option:: --file + + Upload image from local file + +.. option:: --volume + + Create image from a volume + +.. option:: --force + + Force image creation if volume is in use (only meaningful with --volume) + +.. option:: --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 + + Set a property on this image (repeat for multiple values) + +.. describe:: + + New image name + +image delete +------------ + +Delete image(s) + +.. program:: image delete +.. code:: bash + + os image delete + + +.. describe:: + + Image(s) to delete (name or ID) + +image list +---------- + +List available images + +.. program:: image list +.. code:: bash + + os image list + [--page-size ] + [--long] + +.. option:: --page-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 + + +.. option:: --file + + Downloaded image save filename (default: stdout) + +.. describe:: + + 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 ] + [--owner ] + [--min-disk ] + [--min-ram ] + [--protected | --unprotected] + [--public | --private] + [--property [...] ] + + +.. option:: --name + + New image name + +.. option:: --owner + + New image owner project (name or ID) + +.. option:: --min-disk + + Minimum disk size needed to boot image, in gigabytes + +.. option:: --min-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 + + Set a property on this image (repeat for multiple values) + +.. describe:: + + Image to modify (name or ID) + +image show +---------- + +Display image details + +.. program:: image show +.. code:: bash + + os image show + + +.. describe:: + + Image to display (name or ID) diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 4f8b55792a..01175bd72e 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -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 diff --git a/openstackclient/image/v1/image.py b/openstackclient/image/v1/image.py index ca1eead4d8..d7ece25462 100644 --- a/openstackclient/image/v1/image.py +++ b/openstackclient/image/v1/image.py @@ -49,7 +49,7 @@ class CreateImage(show.ShowOne): parser = super(CreateImage, self).get_parser(prog_name) parser.add_argument( "name", - metavar="", + metavar="", help="New image name", ) parser.add_argument( @@ -159,7 +159,7 @@ class CreateImage(show.ShowOne): dest="properties", metavar="", 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="", - help="Downloaded image save filename [default: stdout]", + help="Downloaded image save filename (default: stdout)", ) parser.add_argument( "image", metavar="", - 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="", - 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="", - 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="", 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="", - help="Name or ID of image to display", + help="Image to display (name or ID)", ) return parser diff --git a/openstackclient/image/v2/image.py b/openstackclient/image/v2/image.py index 63351c6d5e..d5ee692ce8 100644 --- a/openstackclient/image/v2/image.py +++ b/openstackclient/image/v2/image.py @@ -102,12 +102,12 @@ class SaveImage(command.Command): parser.add_argument( "--file", metavar="", - help="Downloaded image save filename [default: stdout]", + help="Downloaded image save filename (default: stdout)", ) parser.add_argument( "image", metavar="", - 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="", - help="Name or ID of image to display", + help="Image to display (name or ID)", ) return parser