glance.image_cache package

Subpackages

• glance.image_cache.drivers package
  • Submodules
  • glance.image_cache.drivers.base module
  • glance.image_cache.drivers.sqlite module
  • glance.image_cache.drivers.xattr module
    • Assumptions
    • Cache Directory Notes
  • Module contents

Submodules

glance.image_cache.base module

class glance.image_cache.base.CacheApp

Bases: object

glance.image_cache.cleaner module

Cleans up any invalid cache entries

class glance.image_cache.cleaner.Cleaner

Bases: glance.image_cache.base.CacheApp

run()

glance.image_cache.client module

class glance.image_cache.client.CacheClient(host, port=None, timeout=None, use_ssl=False, auth_token=None, creds=None, doc_root=None, key_file=None, cert_file=None, ca_file=None, insecure=False, configure_via_auth=True)

Bases: glance.common.client.BaseClient

DEFAULT_DOC_ROOT = '/v1'

DEFAULT_PORT = 9292

delete_all_cached_images()

Delete all cached images

delete_all_queued_images()

Delete all queued images

delete_cached_image(image_id)

Delete a specified image from the cache

delete_queued_image(image_id)

Delete a specified image from the cache queue

get_cached_images(**kwargs)

Returns a list of images stored in the image cache.

get_queued_images(**kwargs)

Returns a list of images queued for caching

queue_image_for_caching(image_id)

Queue an image for prefetching into cache

glance.image_cache.client.get_client(host, port=None, timeout=None, use_ssl=False, username=None, password=None, tenant=None, auth_url=None, auth_strategy=None, auth_token=None, region=None, is_silent_upload=False, insecure=False)

Returns a new client Glance client object based on common kwargs. If an option isn’t specified falls back to common environment variable defaults.

glance.image_cache.prefetcher module

Prefetches images into the Image Cache

class glance.image_cache.prefetcher.Prefetcher

Bases: glance.image_cache.base.CacheApp

fetch_image_into_cache(image_id)

run()

glance.image_cache.pruner module

Prunes the Image Cache

class glance.image_cache.pruner.Pruner

Bases: glance.image_cache.base.CacheApp

run()

Module contents

LRU Cache for Image Data

class glance.image_cache.ImageCache

Bases: object

Provides an LRU cache for image data.

cache_image_file(image_id, image_file)

Cache an image file.

Parameters:

• image_id – Image ID
• image_file – Image file to cache

:retval True if image file was cached, False otherwise

cache_image_iter(image_id, image_iter, image_checksum=None)

Cache an image with supplied iterator.

Parameters:

• image_id – Image ID
• image_file – Iterator retrieving image chunks
• image_checksum – Checksum of image

:retval True if image file was cached, False otherwise

cache_tee_iter(image_id, image_iter, image_checksum)

clean(stall_time=None)

Cleans up any invalid or incomplete cached images. The cache driver decides what that means...

configure_driver()

Configure the driver for the cache and, if it fails to configure, fall back to using the SQLite driver which has no odd dependencies

delete_all_cached_images()

Removes all cached image files and any attributes about the images and returns the number of cached image files that were deleted.

delete_all_queued_images()

Removes all queued image files and any attributes about the images and returns the number of queued image files that were deleted.

delete_cached_image(image_id)

Removes a specific cached image file and any attributes about the image

Parameters:image_id – Image ID

delete_queued_image(image_id)

Removes a specific queued image file and any attributes about the image

Parameters:image_id – Image ID

get_cache_size()

Returns the total size in bytes of the image cache.

get_cached_images()

Returns a list of records about cached images.

get_caching_iter(image_id, image_checksum, image_iter)

Returns an iterator that caches the contents of an image while the image contents are read through the supplied iterator.

Parameters:

• image_id – Image ID
• image_checksum – checksum expected to be generated while iterating over image data
• image_iter – Iterator that will read image contents

get_hit_count(image_id)

Return the number of hits that an image has

Parameters:image_id – Opaque image identifier

get_image_size(image_id)

Return the size of the image file for an image with supplied identifier.

Parameters:image_id – Image ID

get_queued_images()

Returns a list of image IDs that are in the queue. The list should be sorted by the time the image ID was inserted into the queue.

init_driver()

Create the driver for the cache

is_cached(image_id)

Returns True if the image with the supplied ID has its image file cached.

Parameters:image_id – Image ID

is_queued(image_id)

Returns True if the image identifier is in our cache queue.

Parameters:image_id – Image ID

open_for_read(image_id)

Open and yield file for reading the image file for an image with supplied identifier.

:note Upon successful reading of the image file, the image’s

hit count will be incremented.

Parameters:image_id – Image ID

prune()

Removes all cached image files above the cache’s maximum size. Returns a tuple containing the total number of cached files removed and the total size of all pruned image files.

queue_image(image_id)

This adds a image to be cache to the queue.

If the image already exists in the queue or has already been cached, we return False, True otherwise

Parameters:image_id – Image ID