glance.registry.api.v1 package

Submodules

glance.registry.api.v1.images module

Reference implementation registry server WSGI controller

class glance.registry.api.v1.images.Controller

Bases: object

create(req, *args, **kwargs)

Registers a new image with the registry.

Parameters:

• req – wsgi Request object
• body – Dictionary of information about the image

:retval Returns the newly-created image information as a mapping,

which will include the newly-created image’s internal id in the ‘id’ field

delete(req, *args, **kwargs)

Deletes an existing image with the registry.

Parameters:

• req – wsgi Request object
• id – The opaque internal identifier for the image

:retval Returns 200 if delete was successful, a fault if not. On success, the body contains the deleted image information as a mapping.

detail(req)

Return a filtered list of public, non-deleted images in detail

Parameters:req – the Request object coming from the wsgi layer

:retval a mapping of the following form:

dict(images=[image_list])

Where image_list is a sequence of mappings containing all image model fields.

index(req)

Return a basic filtered list of public, non-deleted images

Parameters:req – the Request object coming from the wsgi layer

:retval a mapping of the following form:

dict(images=[image_list])

Where image_list is a sequence of mappings:

{
'id': <ID>,
'name': <NAME>,
'size': <SIZE>,
'disk_format': <DISK_FORMAT>,
'container_format': <CONTAINER_FORMAT>,
'checksum': <CHECKSUM>
}

show(req, id)

Return data about the given image id.

update(req, *args, **kwargs)

Updates an existing image with the registry.

Parameters:

• req – wsgi Request object
• body – Dictionary of information about the image
• id – The opaque internal identifier for the image

:retval Returns the updated image information as a mapping,

glance.registry.api.v1.images.create_resource()

Images resource factory method.

glance.registry.api.v1.images.make_image_dict(image)

Create a dict representation of an image which we can use to serialize the image.

glance.registry.api.v1.members module

class glance.registry.api.v1.members.Controller

Bases: object

default(req, *args, **kwargs)

This will cover the missing ‘show’ and ‘create’ actions

delete(req, *args, **kwargs)

Removes a membership from the image.

index(req, image_id)

Get the members of an image.

index_shared_images(req, id)

Retrieves images shared with the given member.

is_image_sharable(context, image)

Return True if the image can be shared to others in this context.

update(req, *args, **kwargs)

Adds a membership to the image, or updates an existing one. If a body is present, it is a dict with the following format:

{"member": {
    "can_share": [True|False]
}}

If “can_share” is provided, the member’s ability to share is set accordingly. If it is not provided, existing memberships remain unchanged and new memberships default to False.

update_all(req, *args, **kwargs)

Replaces the members of the image with those specified in the body. The body is a dict with the following format:

{"memberships": [
    {"member_id": <MEMBER_ID>,
     ["can_share": [True|False]]}, ...
]}

glance.registry.api.v1.members.create_resource()

Image members resource factory method.

glance.registry.api.v1.members.make_member_list(members, **attr_map)

Create a dict representation of a list of members which we can use to serialize the members list. Keyword arguments map the names of optional attributes to include to the database attribute.

Module contents

class glance.registry.api.v1.API(mapper)

Bases: glance.common.wsgi.Router

WSGI entry point for all Registry requests.

glance.registry.api.v1.init(mapper)