glance.api package

Subpackages

• glance.api.glare package
  • Subpackages
    • glance.api.glare.v0_1 package
      • Submodules
      • glance.api.glare.v0_1.glare module
      • glance.api.glare.v0_1.router module
      • Module contents
  • Submodules
  • glance.api.glare.versions module
  • Module contents
• glance.api.middleware package
  • Submodules
  • glance.api.middleware.cache module
  • glance.api.middleware.cache_manage module
  • glance.api.middleware.context module
  • glance.api.middleware.gzip module
  • glance.api.middleware.version_negotiation module
  • Module contents
• glance.api.v1 package
  • Submodules
  • glance.api.v1.controller module
  • glance.api.v1.filters module
  • glance.api.v1.images module
  • glance.api.v1.members module
  • glance.api.v1.router module
  • glance.api.v1.upload_utils module
  • Module contents
• glance.api.v2 package
  • Subpackages
    • glance.api.v2.model package
      • Submodules
      • glance.api.v2.model.metadef_namespace module
      • glance.api.v2.model.metadef_object module
      • glance.api.v2.model.metadef_property_item_type module
      • glance.api.v2.model.metadef_property_type module
      • glance.api.v2.model.metadef_resource_type module
      • glance.api.v2.model.metadef_tag module
      • Module contents
  • Submodules
  • glance.api.v2.image_actions module
  • glance.api.v2.image_data module
  • glance.api.v2.image_members module
  • glance.api.v2.image_tags module
  • glance.api.v2.images module
  • glance.api.v2.metadef_namespaces module
  • glance.api.v2.metadef_objects module
  • glance.api.v2.metadef_properties module
  • glance.api.v2.metadef_resource_types module
  • glance.api.v2.metadef_tags module
  • glance.api.v2.router module
  • glance.api.v2.schemas module
  • glance.api.v2.tasks module
  • Module contents
• glance.api.v3 package
  • Submodules
  • glance.api.v3.router module
  • Module contents

Submodules

glance.api.authorization module

class glance.api.authorization.ImageFactoryProxy(image_factory, context)

Bases: glance.domain.proxy.ImageFactory

new_image(**kwargs)

class glance.api.authorization.ImageMemberFactoryProxy(image_member_factory, context)

Bases: glance.domain.proxy.ImageMembershipFactory

new_image_member(image, member_id)

class glance.api.authorization.ImageMemberProxy(image_member, context)

Bases: glance.domain.proxy.ImageMember

class glance.api.authorization.ImageMemberRepoProxy(member_repo, image, context)

Bases: glance.domain.proxy.MemberRepo

add(image_member)

get(member_id)

list(*args, **kwargs)

remove(image_member)

save(image_member, from_state=None)

class glance.api.authorization.ImageProxy(image, context)

Bases: glance.domain.proxy.Image

class glance.api.authorization.ImageRepoProxy(image_repo, context)

Bases: glance.domain.proxy.Repo

get(image_id)

list(*args, **kwargs)

class glance.api.authorization.ImmutableImageProxy(base, context)

Bases: object

checksum

container_format

created_at

deactivate(*args, **kwargs)

delete()

disk_format

extra_properties

get_data(*args, **kwargs)

image_id

locations

min_disk

min_ram

name

owner

protected

reactivate(*args, **kwargs)

set_data(*args, **kwargs)

size

status

tags

updated_at

virtual_size

visibility

class glance.api.authorization.ImmutableLocations

Bases: list

append(*args, **kwargs)

extend(*args, **kwargs)

forbidden(*args, **kwargs)

insert(*args, **kwargs)

pop(*args, **kwargs)

remove(*args, **kwargs)

reverse(*args, **kwargs)

sort(*args, **kwargs)

class glance.api.authorization.ImmutableMemberProxy(base)

Bases: object

created_at

id

image_id

member_id

status

updated_at

class glance.api.authorization.ImmutableMetadefNamespaceProxy(base)

Bases: object

created_at

delete()

description

display_name

namespace

namespace_id

owner

protected

save()

updated_at

visibility

class glance.api.authorization.ImmutableMetadefObjectProxy(base)

Bases: object

created_at

delete()

description

name

object_id

properties

required

save()

updated_at

class glance.api.authorization.ImmutableMetadefPropertyProxy(base)

Bases: object

delete()

name

property_id

save()

schema

class glance.api.authorization.ImmutableMetadefResourceTypeProxy(base)

Bases: object

created_at

delete()

name

namespace

prefix

properties_target

updated_at

class glance.api.authorization.ImmutableMetadefTagProxy(base)

Bases: object

created_at

delete()

name

save()

tag_id

updated_at

class glance.api.authorization.ImmutableProperties

Bases: dict

forbidden(*args, **kwargs)

forbidden_key(key, *args, **kwargs)

pop(*args, **kwargs)

popitem(*args, **kwargs)

setdefault(*args, **kwargs)

update(*args, **kwargs)

class glance.api.authorization.ImmutableTags

Bases: set

add(*args, **kwargs)

clear(*args, **kwargs)

difference_update(*args, **kwargs)

forbidden(*args, **kwargs)

intersection_update(*args, **kwargs)

pop(*args, **kwargs)

remove(*args, **kwargs)

symmetric_difference_update(*args, **kwargs)

update(*args, **kwargs)

class glance.api.authorization.ImmutableTaskProxy(base)

Bases: object

begin_processing()

created_at

expires_at

fail(message)

input

message

owner

result

run(executor)

status

succeed(result)

task_id

type

updated_at

class glance.api.authorization.ImmutableTaskStubProxy(base)

Bases: object

created_at

expires_at

owner

status

task_id

type

updated_at

class glance.api.authorization.MetadefNamespaceFactoryProxy(meta_namespace_factory, context)

Bases: glance.domain.proxy.MetadefNamespaceFactory

new_namespace(**kwargs)

class glance.api.authorization.MetadefNamespaceProxy(namespace)

Bases: glance.domain.proxy.MetadefNamespace

class glance.api.authorization.MetadefNamespaceRepoProxy(namespace_repo, context)

Bases: glance.domain.proxy.MetadefNamespaceRepo

get(namespace)

list(*args, **kwargs)

class glance.api.authorization.MetadefObjectFactoryProxy(meta_object_factory, context)

Bases: glance.domain.proxy.MetadefObjectFactory

new_object(**kwargs)

class glance.api.authorization.MetadefObjectProxy(meta_object)

Bases: glance.domain.proxy.MetadefObject

class glance.api.authorization.MetadefObjectRepoProxy(object_repo, context)

Bases: glance.domain.proxy.MetadefObjectRepo

get(namespace, object_name)

list(*args, **kwargs)

class glance.api.authorization.MetadefPropertyFactoryProxy(namespace_property_factory, context)

Bases: glance.domain.proxy.MetadefPropertyFactory

new_namespace_property(**kwargs)

class glance.api.authorization.MetadefPropertyProxy(namespace_property)

Bases: glance.domain.proxy.MetadefProperty

class glance.api.authorization.MetadefPropertyRepoProxy(namespace_property_repo, context)

Bases: glance.domain.proxy.MetadefPropertyRepo

get(namespace, object_name)

list(*args, **kwargs)

class glance.api.authorization.MetadefResourceTypeFactoryProxy(resource_type_factory, context)

Bases: glance.domain.proxy.MetadefResourceTypeFactory

new_resource_type(**kwargs)

class glance.api.authorization.MetadefResourceTypeProxy(meta_resource_type)

Bases: glance.domain.proxy.MetadefResourceType

class glance.api.authorization.MetadefResourceTypeRepoProxy(meta_resource_type_repo, context)

Bases: glance.domain.proxy.MetadefResourceTypeRepo

get(*args, **kwargs)

list(*args, **kwargs)

class glance.api.authorization.MetadefTagFactoryProxy(meta_tag_factory, context)

Bases: glance.domain.proxy.MetadefTagFactory

new_tag(**kwargs)

class glance.api.authorization.MetadefTagProxy(base)

Bases: glance.domain.proxy.MetadefTag

class glance.api.authorization.MetadefTagRepoProxy(tag_repo, context)

Bases: glance.domain.proxy.MetadefTagRepo

get(namespace, tag_name)

list(*args, **kwargs)

class glance.api.authorization.TaskFactoryProxy(task_factory, context)

Bases: glance.domain.proxy.TaskFactory

new_task(**kwargs)

class glance.api.authorization.TaskProxy(task)

Bases: glance.domain.proxy.Task

class glance.api.authorization.TaskRepoProxy(task_repo, context)

Bases: glance.domain.proxy.TaskRepo

get(task_id)

class glance.api.authorization.TaskStubRepoProxy(task_stub_repo, context)

Bases: glance.domain.proxy.TaskStubRepo

list(*args, **kwargs)

glance.api.authorization.is_image_mutable(context, image)

Return True if the image is mutable in this context.

glance.api.authorization.is_member_mutable(context, member)

Return True if the image is mutable in this context.

glance.api.authorization.is_meta_resource_type_mutable(context, meta_resource_type)

Return True if the meta_resource_type is mutable in this context.

glance.api.authorization.is_namespace_mutable(context, namespace)

Return True if the namespace is mutable in this context.

glance.api.authorization.is_namespace_property_mutable(context, namespace_property)

Return True if the object is mutable in this context.

glance.api.authorization.is_object_mutable(context, object)

Return True if the object is mutable in this context.

glance.api.authorization.is_tag_mutable(context, tag)

Return True if the tag is mutable in this context.

glance.api.authorization.is_task_mutable(context, task)

Return True if the task is mutable in this context.

glance.api.authorization.is_task_stub_mutable(context, task_stub)

Return True if the task stub is mutable in this context.

glance.api.authorization.proxy_image(context, image)

glance.api.authorization.proxy_member(context, member)

glance.api.authorization.proxy_meta_resource_type(context, meta_resource_type)

glance.api.authorization.proxy_namespace(context, namespace)

glance.api.authorization.proxy_namespace_property(context, namespace_property)

glance.api.authorization.proxy_object(context, object)

glance.api.authorization.proxy_tag(context, tag)

glance.api.authorization.proxy_task(context, task)

glance.api.authorization.proxy_task_stub(context, task_stub)

glance.api.cached_images module

Controller for Image Cache Management API

class glance.api.cached_images.CachedImageDeserializer

Bases: glance.common.wsgi.JSONRequestDeserializer

class glance.api.cached_images.CachedImageSerializer

Bases: glance.common.wsgi.JSONResponseSerializer

class glance.api.cached_images.Controller

Bases: glance.api.v1.controller.BaseController

A controller for managing cached images.

delete_cached_image(req, image_id)

DELETE /cached_images/<IMAGE_ID>

Removes an image from the cache.

delete_cached_images(req)

DELETE /cached_images - Clear all active cached images

Removes all images from the cache.

delete_queued_image(req, image_id)

DELETE /queued_images/<IMAGE_ID>

Removes an image from the cache.

delete_queued_images(req)

DELETE /queued_images - Clear all active queued images

Removes all images from the cache.

get_cached_images(req)

GET /cached_images

Returns a mapping of records about cached images.

get_queued_images(req)

GET /queued_images

Returns a mapping of records about queued images.

queue_image(req, image_id)

PUT /queued_images/<IMAGE_ID>

Queues an image for caching. We do not check to see if the image is in the registry here. That is done by the prefetcher...

glance.api.cached_images.create_resource()

Cached Images resource factory method

glance.api.common module

glance.api.common.check_quota(context, image_size, db_api, image_id=None)

Method called to see if the user is allowed to store an image.

Checks if it is allowed based on the given size in glance based on their quota and current usage.

Parameters:

• context –
• image_size – The size of the image we hope to store
• db_api – The db_api in use for this configuration
• image_id – The image that will be replaced with this new data size

Returns:

glance.api.common.get_remaining_quota(context, db_api, image_id=None)

Method called to see if the user is allowed to store an image.

Checks if it is allowed based on the given size in glance based on their quota and current usage.

Parameters:

• context –
• db_api – The db_api in use for this configuration
• image_id – The image that will be replaced with this new data size

Returns:

The number of bytes the user has remaining under their quota. None means infinity

glance.api.common.get_thread_pool(lock_name, size=1024)

Initializes eventlet thread pool.

If thread pool is present in cache, then returns it from cache else create new pool, stores it in cache and return newly created pool.

@param lock_name: Name of the lock. @param size: Size of eventlet pool.

@return: eventlet pool

glance.api.common.image_send_notification(bytes_written, expected_size, image_meta, request, notifier)

Send an image.send message to the notifier.

glance.api.common.memoize(lock_name)

glance.api.common.size_checked_iter(response, image_meta, expected_size, image_iter, notifier)

glance.api.policy module

Policy Engine For Glance

class glance.api.policy.Enforcer

Bases: oslo_policy.policy.Enforcer

Responsible for loading and enforcing rules

add_rules(rules)

Add new rules to the Rules object

check(context, action, target)

Verifies that the action is valid on the target in this context.

Parameters:

• context – Glance request context
• action – String representing the action to be checked
• target – Dictionary representing the object of the action.

Returns:

A non-False value if access is allowed.

check_is_admin(context)

Check if the given context is associated with an admin role, as defined via the ‘context_is_admin’ RBAC rule.

Parameters:context – Glance request context Returns:A non-False value if context role is admin.

enforce(context, action, target)

Verifies that the action is valid on the target in this context.

Parameters:

• context – Glance request context
• action – String representing the action to be checked
• target – Dictionary representing the object of the action.

Raises:

glance.common.exception.Forbidden

Returns:

A non-False value if access is allowed.

class glance.api.policy.ImageFactoryProxy(image_factory, context, policy)

Bases: glance.domain.proxy.ImageFactory

new_image(**kwargs)

class glance.api.policy.ImageLocationsProxy(locations, context, policy)

Bases: object

append(*args, **kwargs)

count(*args, **kwargs)

extend(*args, **kwargs)

index(*args, **kwargs)

insert(*args, **kwargs)

pop(*args, **kwargs)

remove(*args, **kwargs)

reverse(*args, **kwargs)

class glance.api.policy.ImageMemberFactoryProxy(member_factory, context, policy)

Bases: glance.domain.proxy.ImageMembershipFactory

class glance.api.policy.ImageMemberProxy(image_member, context, policy)

Bases: glance.domain.proxy.ImageMember

class glance.api.policy.ImageMemberRepoProxy(member_repo, image, context, policy)

Bases: glance.domain.proxy.Repo

add(member)

get(member_id)

list(*args, **kwargs)

remove(member)

save(member, from_state=None)

class glance.api.policy.ImageProxy(image, context, policy)

Bases: glance.domain.proxy.Image

deactivate()

delete()

get_data(*args, **kwargs)

locations

reactivate()

set_data(*args, **kwargs)

visibility

class glance.api.policy.ImageRepoProxy(image_repo, context, policy)

Bases: glance.domain.proxy.Repo

add(image)

get(image_id)

list(*args, **kwargs)

save(image, from_state=None)

class glance.api.policy.ImageTarget(target)

Bases: object

SENTINEL = <object object at 0x7f9ecb2faec0>

key_transforms(key)

class glance.api.policy.MetadefNamespaceFactoryProxy(meta_namespace_factory, context, policy)

Bases: glance.domain.proxy.MetadefNamespaceFactory

class glance.api.policy.MetadefNamespaceProxy(namespace, context, policy)

Bases: glance.domain.proxy.MetadefNamespace

class glance.api.policy.MetadefNamespaceRepoProxy(namespace_repo, context, namespace_policy)

Bases: glance.domain.proxy.MetadefNamespaceRepo

add(namespace)

get(namespace)

list(*args, **kwargs)

save(namespace)

class glance.api.policy.MetadefObjectFactoryProxy(meta_object_factory, context, policy)

Bases: glance.domain.proxy.MetadefObjectFactory

class glance.api.policy.MetadefObjectProxy(meta_object, context, policy)

Bases: glance.domain.proxy.MetadefObject

class glance.api.policy.MetadefObjectRepoProxy(object_repo, context, object_policy)

Bases: glance.domain.proxy.MetadefObjectRepo

add(meta_object)

get(namespace, object_name)

list(*args, **kwargs)

save(meta_object)

class glance.api.policy.MetadefPropertyFactoryProxy(namespace_property_factory, context, policy)

Bases: glance.domain.proxy.MetadefPropertyFactory

class glance.api.policy.MetadefPropertyProxy(namespace_property, context, policy)

Bases: glance.domain.proxy.MetadefProperty

class glance.api.policy.MetadefPropertyRepoProxy(property_repo, context, object_policy)

Bases: glance.domain.proxy.MetadefPropertyRepo

add(namespace_property)

get(namespace, property_name)

list(*args, **kwargs)

save(namespace_property)

class glance.api.policy.MetadefResourceTypeFactoryProxy(resource_type_factory, context, policy)

Bases: glance.domain.proxy.MetadefResourceTypeFactory

class glance.api.policy.MetadefResourceTypeProxy(meta_resource_type, context, policy)

Bases: glance.domain.proxy.MetadefResourceType

class glance.api.policy.MetadefResourceTypeRepoProxy(resource_type_repo, context, resource_type_policy)

Bases: glance.domain.proxy.MetadefResourceTypeRepo

add(resource_type)

get(*args, **kwargs)

list(*args, **kwargs)

class glance.api.policy.MetadefTagFactoryProxy(meta_tag_factory, context, policy)

Bases: glance.domain.proxy.MetadefTagFactory

class glance.api.policy.MetadefTagProxy(meta_tag, context, policy)

Bases: glance.domain.proxy.MetadefTag

class glance.api.policy.MetadefTagRepoProxy(tag_repo, context, tag_policy)

Bases: glance.domain.proxy.MetadefTagRepo

add(meta_tag)

add_tags(meta_tags)

get(namespace, tag_name)

list(*args, **kwargs)

save(meta_tag)

class glance.api.policy.TaskFactoryProxy(task_factory, context, policy)

Bases: glance.domain.proxy.TaskFactory

class glance.api.policy.TaskProxy(task, context, policy)

Bases: glance.domain.proxy.Task

class glance.api.policy.TaskRepoProxy(task_repo, context, task_policy)

Bases: glance.domain.proxy.TaskRepo

add(task)

get(task_id)

save(task)

class glance.api.policy.TaskStubProxy(task_stub, context, policy)

Bases: glance.domain.proxy.TaskStub

class glance.api.policy.TaskStubRepoProxy(task_stub_repo, context, task_policy)

Bases: glance.domain.proxy.TaskStubRepo

list(*args, **kwargs)

glance.api.property_protections module

class glance.api.property_protections.ExtraPropertiesProxy(context, extra_props, property_rules)

Bases: glance.domain.ExtraProperties

class glance.api.property_protections.ProtectedImageFactoryProxy(image_factory, context, property_rules)

Bases: glance.domain.proxy.ImageFactory

new_image(**kwargs)

class glance.api.property_protections.ProtectedImageProxy(image, context, property_rules)

Bases: glance.domain.proxy.Image

class glance.api.property_protections.ProtectedImageRepoProxy(image_repo, context, property_rules)

Bases: glance.domain.proxy.Repo

get(image_id)

list(*args, **kwargs)

glance.api.versions module

class glance.api.versions.Controller

Bases: object

A wsgi controller that reports which API versions are supported.

index(req, explicit=False)

Respond to a request for all OpenStack API versions.

glance.api.versions.create_resource(conf)

Module contents

glance.api.root_app_factory(loader, global_conf, **local_conf)