e1bb4378db
This adds a bulk query method to GlanceManager that takes multiple image names or ids and attempts to query glance for all of them in fewer requests than one-per-image. Change-Id: I1c6ce27b65920356df6b7001c581a2922765ce0c
114 lines
4.5 KiB
Python
114 lines
4.5 KiB
Python
# Copyright 2010 Jacob Kaplan-Moss
|
|
#
|
|
# 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.
|
|
|
|
from oslo_utils import uuidutils
|
|
|
|
from novaclient import base
|
|
from novaclient import exceptions
|
|
from novaclient.i18n import _
|
|
|
|
|
|
class Image(base.Resource):
|
|
HUMAN_ID = True
|
|
|
|
def __repr__(self):
|
|
return "<Image: %s>" % self.name
|
|
|
|
|
|
class GlanceManager(base.Manager):
|
|
"""Use glance directly from service catalog.
|
|
|
|
This is used to do name to id lookups for images and listing images for
|
|
the --image-with option to the 'boot' command. Do not use it
|
|
for anything else besides that. You have been warned.
|
|
|
|
"""
|
|
|
|
resource_class = Image
|
|
|
|
def find_image(self, name_or_id):
|
|
"""Find an image by name or id (user provided input)."""
|
|
|
|
with self.alternate_service_type(
|
|
'image', allowed_types=('image',)):
|
|
# glance catalog entries are the unversioned endpoint, so
|
|
# we need to jam a version bit in here.
|
|
if uuidutils.is_uuid_like(name_or_id):
|
|
# if it's a uuid, then just go collect the info and be
|
|
# done with it.
|
|
return self._get('/v2/images/%s' % name_or_id, None)
|
|
else:
|
|
matches = self._list('/v2/images?name=%s' % name_or_id,
|
|
"images")
|
|
num_matches = len(matches)
|
|
if num_matches == 0:
|
|
msg = "No %s matching %s." % (
|
|
self.resource_class.__name__, name_or_id)
|
|
raise exceptions.NotFound(404, msg)
|
|
elif num_matches > 1:
|
|
msg = (_("Multiple %(class)s matches found for "
|
|
"'%(name)s', use an ID to be more specific.") %
|
|
{'class': self.resource_class.__name__.lower(),
|
|
'name': name_or_id})
|
|
raise exceptions.NoUniqueMatch(msg)
|
|
else:
|
|
matches[0].append_request_ids(matches.request_ids)
|
|
return matches[0]
|
|
|
|
def find_images(self, names_or_ids):
|
|
"""Find multiple images by name or id (user provided input).
|
|
|
|
:param names_or_ids: A list of strings to use to find images.
|
|
:returns: novaclient.v2.images.Image objects for each images found
|
|
:raises exceptions.NotFound: If one or more images is not found
|
|
:raises exceptions.ClientException: If the image service returns any
|
|
unexpected images.
|
|
|
|
NOTE: This method always makes two calls to the image service, even if
|
|
only one image is provided by ID and is returned in the first query.
|
|
"""
|
|
with self.alternate_service_type(
|
|
'image', allowed_types=('image',)):
|
|
matches = self._list('/v2/images?id=in:%s' % ','.join(
|
|
names_or_ids), 'images')
|
|
matches.extend(self._list('/v2/images?names=in:%s' % ','.join(
|
|
names_or_ids), 'images'))
|
|
missed = (set(names_or_ids) -
|
|
set(m.name for m in matches) -
|
|
set(m.id for m in matches))
|
|
if missed:
|
|
msg = _("Unable to find image(s): %(images)s") % {
|
|
"images": ",".join(missed)}
|
|
raise exceptions.NotFound(404, msg)
|
|
for match in matches:
|
|
match.append_request_ids(matches.request_ids)
|
|
|
|
additional = []
|
|
for i in matches:
|
|
if i.name not in names_or_ids and i.id not in names_or_ids:
|
|
additional.append(i)
|
|
if additional:
|
|
msg = _('Additional images found in response')
|
|
raise exceptions.ClientException(500, msg)
|
|
return matches
|
|
|
|
def list(self):
|
|
"""
|
|
Get a detailed list of all images.
|
|
|
|
:rtype: list of :class:`Image`
|
|
"""
|
|
with self.alternate_service_type('image', allowed_types=('image',)):
|
|
return self._list('/v2/images', 'images')
|