224 lines
7.2 KiB
Python
224 lines
7.2 KiB
Python
# Copyright 2013 Red Hat, Inc.
|
|
# 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.
|
|
|
|
"""
|
|
This is the Registry's Driver API.
|
|
|
|
This API relies on the registry RPC client (version >= 2). The functions bellow
|
|
work as a proxy for the database back-end configured in the registry service,
|
|
which means that everything returned by that back-end will be also returned by
|
|
this API.
|
|
|
|
|
|
This API exists for supporting deployments not willing to put database
|
|
credentials in glance-api. Those deployments can rely on this registry driver
|
|
that will talk to a remote registry service, which will then access the
|
|
database back-end.
|
|
"""
|
|
|
|
import functools
|
|
|
|
import glance.openstack.common.log as logging
|
|
from glance.registry.client.v2 import api
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def _get_client(func):
|
|
"""Injects a client instance to the each function
|
|
|
|
This decorator creates an instance of the Registry
|
|
client and passes it as an argument to each function
|
|
in this API.
|
|
"""
|
|
@functools.wraps(func)
|
|
def wrapper(context, *args, **kwargs):
|
|
client = api.get_registry_client(context)
|
|
return func(client, *args, **kwargs)
|
|
return wrapper
|
|
|
|
|
|
@_get_client
|
|
def image_create(client, values):
|
|
"""Create an image from the values dictionary."""
|
|
return client.image_create(values=values)
|
|
|
|
|
|
@_get_client
|
|
def image_update(client, image_id, values, purge_props=False, from_state=None):
|
|
"""
|
|
Set the given properties on an image and update it.
|
|
|
|
:raises NotFound if image does not exist.
|
|
"""
|
|
return client.image_update(values=values,
|
|
image_id=image_id,
|
|
purge_props=purge_props, from_state=from_state)
|
|
|
|
|
|
@_get_client
|
|
def image_destroy(client, image_id):
|
|
"""Destroy the image or raise if it does not exist."""
|
|
return client.image_destroy(image_id=image_id)
|
|
|
|
|
|
@_get_client
|
|
def image_get(client, image_id, force_show_deleted=False):
|
|
return client.image_get(image_id=image_id,
|
|
force_show_deleted=force_show_deleted)
|
|
|
|
|
|
def is_image_visible(context, image, status=None):
|
|
"""Return True if the image is visible in this context."""
|
|
# Is admin == image visible
|
|
if context.is_admin:
|
|
return True
|
|
|
|
# No owner == image visible
|
|
if image['owner'] is None:
|
|
return True
|
|
|
|
# Image is_public == image visible
|
|
if image['is_public']:
|
|
return True
|
|
|
|
# Perform tests based on whether we have an owner
|
|
if context.owner is not None:
|
|
if context.owner == image['owner']:
|
|
return True
|
|
|
|
# Figure out if this image is shared with that tenant
|
|
members = image_member_find(context,
|
|
image_id=image['id'],
|
|
member=context.owner,
|
|
status=status)
|
|
if members:
|
|
return True
|
|
|
|
# Private image
|
|
return False
|
|
|
|
|
|
@_get_client
|
|
def image_get_all(client, filters=None, marker=None, limit=None,
|
|
sort_key='created_at', sort_dir='desc',
|
|
member_status='accepted', is_public=None,
|
|
admin_as_user=False):
|
|
"""
|
|
Get all images that match zero or more filters.
|
|
|
|
:param filters: dict of filter keys and values. If a 'properties'
|
|
key is present, it is treated as a dict of key/value
|
|
filters on the image properties attribute
|
|
:param marker: image id after which to start page
|
|
:param limit: maximum number of images to return
|
|
:param sort_key: image attribute by which results should be sorted
|
|
:param sort_dir: direction in which results should be sorted (asc, desc)
|
|
:param member_status: only return shared images that have this membership
|
|
status
|
|
:param is_public: If true, return only public images. If false, return
|
|
only private and shared images.
|
|
:param admin_as_user: For backwards compatibility. If true, then return to
|
|
an admin the equivalent set of images which it would see
|
|
if it were a regular user
|
|
"""
|
|
return client.image_get_all(filters=filters, marker=marker, limit=limit,
|
|
sort_key=sort_key, sort_dir=sort_dir,
|
|
member_status=member_status,
|
|
is_public=is_public,
|
|
admin_as_user=admin_as_user)
|
|
|
|
|
|
@_get_client
|
|
def image_property_create(client, values, session=None):
|
|
"""Create an ImageProperty object"""
|
|
return client.image_property_create(values=values)
|
|
|
|
|
|
@_get_client
|
|
def image_property_delete(client, prop_ref, image_ref, session=None):
|
|
"""
|
|
Used internally by _image_property_create and image_property_update
|
|
"""
|
|
return client.image_property_delete(prop_ref=prop_ref, image_ref=image_ref)
|
|
|
|
|
|
@_get_client
|
|
def image_member_create(client, values, session=None):
|
|
"""Create an ImageMember object"""
|
|
return client.image_member_create(values=values)
|
|
|
|
|
|
@_get_client
|
|
def image_member_update(client, memb_id, values):
|
|
"""Update an ImageMember object"""
|
|
return client.image_member_update(memb_id=memb_id, values=values)
|
|
|
|
|
|
@_get_client
|
|
def image_member_delete(client, memb_id, session=None):
|
|
"""Delete an ImageMember object"""
|
|
client.image_member_delete(memb_id=memb_id)
|
|
|
|
|
|
@_get_client
|
|
def image_member_find(client, image_id=None, member=None, status=None):
|
|
"""Find all members that meet the given criteria
|
|
|
|
:param image_id: identifier of image entity
|
|
:param member: tenant to which membership has been granted
|
|
"""
|
|
return client.image_member_find(image_id=image_id,
|
|
member=member,
|
|
status=status)
|
|
|
|
|
|
@_get_client
|
|
def image_member_count(client, image_id):
|
|
"""Return the number of image members for this image
|
|
|
|
:param image_id: identifier of image entity
|
|
"""
|
|
return client.image_member_count(image_id=image_id)
|
|
|
|
|
|
@_get_client
|
|
def image_tag_set_all(client, image_id, tags):
|
|
client.image_tag_set_all(image_id=image_id, tags=tags)
|
|
|
|
|
|
@_get_client
|
|
def image_tag_create(client, image_id, value, session=None):
|
|
"""Create an image tag."""
|
|
return client.image_tag_create(image_id=image_id, value=value)
|
|
|
|
|
|
@_get_client
|
|
def image_tag_delete(client, image_id, value, session=None):
|
|
"""Delete an image tag."""
|
|
client.image_tag_delete(image_id=image_id, value=value)
|
|
|
|
|
|
@_get_client
|
|
def image_tag_get_all(client, image_id, session=None):
|
|
"""Get a list of tags for a specific image."""
|
|
return client.image_tag_get_all(image_id=image_id)
|
|
|
|
|
|
@_get_client
|
|
def user_get_storage_usage(client, owner_id, image_id=None, session=None):
|
|
return client.user_get_storage_usage(owner_id=owner_id, image_id=image_id)
|