Hugh Saunders
9fda0dc815
For image-updae and image-create commands, glanceclient attempts to determine whether image data should be uploaded based on the presence of data on stdin. Unforunately it is difficult to determine if data is available, especially when standard in is from a pipe. This is especially problematic for update operations, where data must only be uploaded if the image is in queued state. For example data may be uploaded when the user only wants to rename an image, but the rename will be rejected because data cannot be uploaded to an unqueued image. This patch removes the check that attempts to determine if data is available to read as it didn't work for pipes. It also re-introduces a check for image state in the update operation, so that glanceclient only attempts to read data if the image being updated is in queued state. The image state check is part of the original patchset that was removed so the patchset could have a single focus [1] This patch also removes a test for handling empty stdin, and adds a test for reading stdin from a pipe. [1] https://review.openstack.org/#/c/27536/3/glanceclient/v1/shell.py Fixes: bug 1184566 Related to: bug 1173044 Change-Id: I8d37f6412a0bf9ca21cbd75cde6a4d5a174e5545
373 lines
15 KiB
Python
373 lines
15 KiB
Python
# Copyright 2012 OpenStack LLC.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import argparse
|
|
import copy
|
|
import os
|
|
import sys
|
|
|
|
if os.name == 'nt':
|
|
import msvcrt
|
|
else:
|
|
msvcrt = None
|
|
|
|
from glanceclient import exc
|
|
from glanceclient.common import utils
|
|
import glanceclient.v1.images
|
|
|
|
#NOTE(bcwaldon): import deprecated cli functions
|
|
from glanceclient.v1.legacy_shell import *
|
|
|
|
CONTAINER_FORMATS = 'Acceptable formats: ami, ari, aki, bare, and ovf.'
|
|
DISK_FORMATS = ('Acceptable formats: ami, ari, aki, vhd, vmdk, raw, '
|
|
'qcow2, vdi, and iso.')
|
|
|
|
|
|
@utils.arg('--name', metavar='<NAME>',
|
|
help='Filter images to those that have this name.')
|
|
@utils.arg('--status', metavar='<STATUS>',
|
|
help='Filter images to those that have this status.')
|
|
@utils.arg('--container-format', metavar='<CONTAINER_FORMAT>',
|
|
help='Filter images to those that have this container format. '
|
|
+ CONTAINER_FORMATS)
|
|
@utils.arg('--disk-format', metavar='<DISK_FORMAT>',
|
|
help='Filter images to those that have this disk format. '
|
|
+ DISK_FORMATS)
|
|
@utils.arg('--size-min', metavar='<SIZE>',
|
|
help='Filter images to those with a size greater than this.')
|
|
@utils.arg('--size-max', metavar='<SIZE>',
|
|
help='Filter images to those with a size less than this.')
|
|
@utils.arg('--property-filter', metavar='<KEY=VALUE>',
|
|
help="Filter images by a user-defined image property.",
|
|
action='append', dest='properties', default=[])
|
|
@utils.arg('--page-size', metavar='<SIZE>', default=None, type=int,
|
|
help='Number of images to request in each paginated request.')
|
|
@utils.arg('--human-readable', action='store_true', default=False,
|
|
help='Print image size in a human-friendly format.')
|
|
@utils.arg('--sort-key', default='name',
|
|
choices=glanceclient.v1.images.SORT_KEY_VALUES,
|
|
help='Sort image list by specified field.')
|
|
@utils.arg('--sort-dir', default='asc',
|
|
choices=glanceclient.v1.images.SORT_DIR_VALUES,
|
|
help='Sort image list in specified direction.')
|
|
@utils.arg('--is-public', type=utils.string_to_bool, metavar='{True|False}',
|
|
help=('Allows the user to select a listing of public or non '
|
|
'public images.'))
|
|
def do_image_list(gc, args):
|
|
"""List images you can access."""
|
|
filter_keys = ['name', 'status', 'container_format', 'disk_format',
|
|
'size_min', 'size_max', 'is_public']
|
|
filter_items = [(key, getattr(args, key)) for key in filter_keys]
|
|
filters = dict([item for item in filter_items if item[1] is not None])
|
|
|
|
if args.properties:
|
|
property_filter_items = [p.split('=', 1) for p in args.properties]
|
|
filters['properties'] = dict(property_filter_items)
|
|
|
|
kwargs = {'filters': filters}
|
|
if args.page_size is not None:
|
|
kwargs['page_size'] = args.page_size
|
|
|
|
kwargs['sort_key'] = args.sort_key
|
|
kwargs['sort_dir'] = args.sort_dir
|
|
|
|
images = gc.images.list(**kwargs)
|
|
|
|
if args.human_readable:
|
|
def convert_size(image):
|
|
image.size = utils.make_size_human_readable(image.size)
|
|
return image
|
|
|
|
images = (convert_size(image) for image in images)
|
|
|
|
columns = ['ID', 'Name', 'Disk Format', 'Container Format',
|
|
'Size', 'Status']
|
|
utils.print_list(images, columns)
|
|
|
|
|
|
def _image_show(image, human_readable=False):
|
|
# Flatten image properties dict for display
|
|
info = copy.deepcopy(image._info)
|
|
if human_readable:
|
|
info['size'] = utils.make_size_human_readable(info['size'])
|
|
for (k, v) in info.pop('properties').iteritems():
|
|
info['Property \'%s\'' % k] = v
|
|
|
|
utils.print_dict(info)
|
|
|
|
|
|
def _set_data_field(fields, args):
|
|
if 'location' not in fields and 'copy_from' not in fields:
|
|
if args.file:
|
|
fields['data'] = open(args.file, 'rb')
|
|
else:
|
|
# distinguish cases where:
|
|
# (1) stdin is not valid (as in cron jobs):
|
|
# glance ... <&-
|
|
# (2) image data is provided through standard input:
|
|
# glance ... < /tmp/file or cat /tmp/file | glance ...
|
|
# (3) no image data provided:
|
|
# glance ...
|
|
try:
|
|
os.fstat(0)
|
|
except OSError:
|
|
# (1) stdin is not valid (closed...)
|
|
fields['data'] = None
|
|
return
|
|
if not sys.stdin.isatty():
|
|
# (2) image data is provided through standard input
|
|
if msvcrt:
|
|
msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
|
|
fields['data'] = sys.stdin
|
|
else:
|
|
# (3) no image data provided
|
|
fields['data'] = None
|
|
|
|
|
|
@utils.arg('image', metavar='<IMAGE>', help='Name or ID of image to describe.')
|
|
@utils.arg('--human-readable', action='store_true', default=False,
|
|
help='Print image size in a human-friendly format.')
|
|
def do_image_show(gc, args):
|
|
"""Describe a specific image."""
|
|
image_id = utils.find_resource(gc.images, args.image).id
|
|
image = gc.images.get(image_id)
|
|
_image_show(image, args.human_readable)
|
|
|
|
|
|
@utils.arg('--file', metavar='<FILE>',
|
|
help='Local file to save downloaded image data to. '
|
|
'If this is not specified the image data will be '
|
|
'written to stdout.')
|
|
@utils.arg('image', metavar='<IMAGE>', help='Name or ID of image to download.')
|
|
def do_image_download(gc, args):
|
|
"""Download a specific image."""
|
|
image = utils.find_resource(gc.images, args.image)
|
|
body = image.data()
|
|
utils.save_image(body, args.file)
|
|
|
|
|
|
@utils.arg('--id', metavar='<IMAGE_ID>',
|
|
help='ID of image to reserve.')
|
|
@utils.arg('--name', metavar='<NAME>',
|
|
help='Name of image.')
|
|
@utils.arg('--store', metavar='<STORE>',
|
|
help='Store to upload image to.')
|
|
@utils.arg('--disk-format', metavar='<DISK_FORMAT>',
|
|
help='Disk format of image. ' + DISK_FORMATS)
|
|
@utils.arg('--container-format', metavar='<CONTAINER_FORMAT>',
|
|
help='Container format of image. ' + CONTAINER_FORMATS)
|
|
@utils.arg('--owner', metavar='<TENANT_ID>',
|
|
help='Tenant who should own image.')
|
|
@utils.arg('--size', metavar='<SIZE>',
|
|
help=('Size of image data (in bytes). Only used with'
|
|
' \'--location\' and \'--copy_from\'.'))
|
|
@utils.arg('--min-disk', metavar='<DISK_GB>',
|
|
help='Minimum size of disk needed to boot image (in gigabytes).')
|
|
@utils.arg('--min-ram', metavar='<DISK_RAM>',
|
|
help='Minimum amount of ram needed to boot image (in megabytes).')
|
|
@utils.arg('--location', metavar='<IMAGE_URL>',
|
|
help=('URL where the data for this image already resides. For '
|
|
'example, if the image data is stored in swift, you could '
|
|
'specify \'swift://account:key@example.com/container/obj\'.'))
|
|
@utils.arg('--file', metavar='<FILE>',
|
|
help=('Local file that contains disk image to be uploaded during'
|
|
' creation. Alternatively, images can be passed to the client'
|
|
' via stdin.'))
|
|
@utils.arg('--checksum', metavar='<CHECKSUM>',
|
|
help=('Hash of image data used Glance can use for verification.'
|
|
' Provide a md5 checksum here.'))
|
|
@utils.arg('--copy-from', metavar='<IMAGE_URL>',
|
|
help=('Similar to \'--location\' in usage, but this indicates that'
|
|
' the Glance server should immediately copy the data and'
|
|
' store it in its configured image store.'))
|
|
#NOTE(bcwaldon): This will be removed once devstack is updated
|
|
# to use --is-public
|
|
@utils.arg('--public', action='store_true', default=False,
|
|
help=argparse.SUPPRESS)
|
|
@utils.arg('--is-public', type=utils.string_to_bool, metavar='[True|False]',
|
|
help='Make image accessible to the public.')
|
|
@utils.arg('--is-protected', type=utils.string_to_bool, metavar='[True|False]',
|
|
help='Prevent image from being deleted.')
|
|
@utils.arg('--property', metavar="<key=value>", action='append', default=[],
|
|
help=("Arbitrary property to associate with image. "
|
|
"May be used multiple times."))
|
|
@utils.arg('--human-readable', action='store_true', default=False,
|
|
help='Print image size in a human-friendly format.')
|
|
def do_image_create(gc, args):
|
|
"""Create a new image."""
|
|
# Filter out None values
|
|
fields = dict(filter(lambda x: x[1] is not None, vars(args).items()))
|
|
|
|
fields['is_public'] = fields.get('is_public') or fields.pop('public')
|
|
|
|
if 'is_protected' in fields:
|
|
fields['protected'] = fields.pop('is_protected')
|
|
|
|
raw_properties = fields.pop('property')
|
|
fields['properties'] = {}
|
|
for datum in raw_properties:
|
|
key, value = datum.split('=', 1)
|
|
fields['properties'][key] = value
|
|
|
|
# Filter out values we can't use
|
|
CREATE_PARAMS = glanceclient.v1.images.CREATE_PARAMS
|
|
fields = dict(filter(lambda x: x[0] in CREATE_PARAMS, fields.items()))
|
|
|
|
_set_data_field(fields, args)
|
|
|
|
image = gc.images.create(**fields)
|
|
_image_show(image, args.human_readable)
|
|
|
|
|
|
@utils.arg('image', metavar='<IMAGE>', help='Name or ID of image to modify.')
|
|
@utils.arg('--name', metavar='<NAME>',
|
|
help='Name of image.')
|
|
@utils.arg('--disk-format', metavar='<DISK_FORMAT>',
|
|
help='Disk format of image. ' + DISK_FORMATS)
|
|
@utils.arg('--container-format', metavar='<CONTAINER_FORMAT>',
|
|
help='Container format of image. ' + CONTAINER_FORMATS)
|
|
@utils.arg('--owner', metavar='<TENANT_ID>',
|
|
help='Tenant who should own image.')
|
|
@utils.arg('--size', metavar='<SIZE>',
|
|
help='Size of image data (in bytes).')
|
|
@utils.arg('--min-disk', metavar='<DISK_GB>',
|
|
help='Minimum size of disk needed to boot image (in gigabytes).')
|
|
@utils.arg('--min-ram', metavar='<DISK_RAM>',
|
|
help='Minimum amount of ram needed to boot image (in megabytes).')
|
|
@utils.arg('--location', metavar='<IMAGE_URL>',
|
|
help=('URL where the data for this image already resides. For '
|
|
'example, if the image data is stored in swift, you could '
|
|
'specify \'swift://account:key@example.com/container/obj\'.'))
|
|
@utils.arg('--file', metavar='<FILE>',
|
|
help=('Local file that contains disk image to be uploaded during'
|
|
' update. Alternatively, images can be passed to the client'
|
|
' via stdin.'))
|
|
@utils.arg('--checksum', metavar='<CHECKSUM>',
|
|
help='Hash of image data used Glance can use for verification.')
|
|
@utils.arg('--copy-from', metavar='<IMAGE_URL>',
|
|
help=('Similar to \'--location\' in usage, but this indicates that'
|
|
' the Glance server should immediately copy the data and'
|
|
' store it in its configured image store.'))
|
|
@utils.arg('--is-public', type=utils.string_to_bool, metavar='[True|False]',
|
|
help='Make image accessible to the public.')
|
|
@utils.arg('--is-protected', type=utils.string_to_bool, metavar='[True|False]',
|
|
help='Prevent image from being deleted.')
|
|
@utils.arg('--property', metavar="<key=value>", action='append', default=[],
|
|
help=("Arbitrary property to associate with image. "
|
|
"May be used multiple times."))
|
|
@utils.arg('--purge-props', action='store_true', default=False,
|
|
help=("If this flag is present, delete all image properties "
|
|
"not explicitly set in the update request. Otherwise, "
|
|
"those properties not referenced are preserved."))
|
|
@utils.arg('--human-readable', action='store_true', default=False,
|
|
help='Print image size in a human-friendly format.')
|
|
def do_image_update(gc, args):
|
|
"""Update a specific image."""
|
|
# Filter out None values
|
|
fields = dict(filter(lambda x: x[1] is not None, vars(args).items()))
|
|
|
|
image_arg = fields.pop('image')
|
|
image = utils.find_resource(gc.images, image_arg)
|
|
|
|
if 'is_protected' in fields:
|
|
fields['protected'] = fields.pop('is_protected')
|
|
|
|
raw_properties = fields.pop('property')
|
|
fields['properties'] = {}
|
|
for datum in raw_properties:
|
|
key, value = datum.split('=', 1)
|
|
fields['properties'][key] = value
|
|
|
|
# Filter out values we can't use
|
|
UPDATE_PARAMS = glanceclient.v1.images.UPDATE_PARAMS
|
|
fields = dict(filter(lambda x: x[0] in UPDATE_PARAMS, fields.items()))
|
|
|
|
if image.status == 'queued':
|
|
_set_data_field(fields, args)
|
|
|
|
image = gc.images.update(image, purge_props=args.purge_props, **fields)
|
|
_image_show(image, args.human_readable)
|
|
|
|
|
|
@utils.arg('images', metavar='<IMAGE>', nargs='+',
|
|
help='Name or ID of image(s) to delete.')
|
|
def do_image_delete(gc, args):
|
|
"""Delete specified image(s)."""
|
|
for args_image in args.images:
|
|
image = utils.find_resource(gc.images, args_image)
|
|
try:
|
|
if args.verbose:
|
|
print 'Requesting image delete for %s ...' % \
|
|
utils.ensure_str(args_image),
|
|
|
|
gc.images.delete(image)
|
|
|
|
if args.verbose:
|
|
print '[Done]'
|
|
|
|
except exc.HTTPException as e:
|
|
if args.verbose:
|
|
print '[Fail]'
|
|
print '%s: Unable to delete image %s' % (e, args_image)
|
|
|
|
|
|
@utils.arg('--image-id', metavar='<IMAGE_ID>',
|
|
help='Filter results by an image ID.')
|
|
@utils.arg('--tenant-id', metavar='<TENANT_ID>',
|
|
help='Filter results by a tenant ID.')
|
|
def do_member_list(gc, args):
|
|
"""Describe sharing permissions by image or tenant."""
|
|
if args.image_id and args.tenant_id:
|
|
print 'Unable to filter members by both --image-id and --tenant-id.'
|
|
sys.exit(1)
|
|
elif args.image_id:
|
|
kwargs = {'image': args.image_id}
|
|
elif args.tenant_id:
|
|
kwargs = {'member': args.tenant_id}
|
|
else:
|
|
print 'Unable to list all members. Specify --image-id or --tenant-id'
|
|
sys.exit(1)
|
|
|
|
members = gc.image_members.list(**kwargs)
|
|
columns = ['Image ID', 'Member ID', 'Can Share']
|
|
utils.print_list(members, columns)
|
|
|
|
|
|
@utils.arg('image', metavar='<IMAGE>',
|
|
help='Image to add member to.')
|
|
@utils.arg('tenant_id', metavar='<TENANT_ID>',
|
|
help='Tenant to add as member')
|
|
@utils.arg('--can-share', action='store_true', default=False,
|
|
help='Allow the specified tenant to share this image.')
|
|
def do_member_create(gc, args):
|
|
"""Share a specific image with a tenant."""
|
|
image = utils.find_resource(gc.images, args.image)
|
|
gc.image_members.create(image, args.tenant_id, args.can_share)
|
|
|
|
|
|
@utils.arg('image', metavar='<IMAGE>',
|
|
help='Image from which to remove member')
|
|
@utils.arg('tenant_id', metavar='<TENANT_ID>',
|
|
help='Tenant to remove as member')
|
|
def do_member_delete(gc, args):
|
|
"""Remove a shared image from a tenant."""
|
|
image_id = utils.find_resource(gc.images, args.image).id
|
|
if not args.dry_run:
|
|
gc.image_members.delete(image_id, args.tenant_id)
|
|
else:
|
|
print "Dry run. We would have done the following:"
|
|
print ('Remove "%s" from the member list of image '
|
|
'"%s"' % (args.tenant_id, args.image))
|