glance.cmd package

Submodules

glance.cmd.api module

Glance API Server

glance.cmd.api.fail(e)

glance.cmd.api.main()

glance.cmd.cache_cleaner module

Glance Image Cache Invalid Cache Entry and Stalled Image cleaner

This is meant to be run as a periodic task from cron.

If something goes wrong while we’re caching an image (for example the fetch times out, or an exception is raised), we create an ‘invalid’ entry. These entires are left around for debugging purposes. However, after some period of time, we want to clean these up.

Also, if an incomplete image hangs around past the image_cache_stall_time period, we automatically sweep it up.

glance.cmd.cache_cleaner.main()

glance.cmd.cache_manage module

A simple cache management utility for Glance.

glance.cmd.cache_manage.catch_error(action)

Decorator to provide sensible default error handling for actions.

glance.cmd.cache_manage.create_options(parser)

Set up the CLI and config-file options that may be parsed and program commands.

Parameters:parser – The option parser

glance.cmd.cache_manage.delete_all_cached_images(*args, **kwargs)

%(prog)s delete-all-cached-images [options]

Remove all images from the cache.

glance.cmd.cache_manage.delete_all_queued_images(*args, **kwargs)

%(prog)s delete-all-queued-images [options]

Remove all images from the cache queue.

glance.cmd.cache_manage.delete_cached_image(*args, **kwargs)

%(prog)s delete-cached-image <IMAGE_ID> [options]

Deletes an image from the cache

glance.cmd.cache_manage.delete_queued_image(*args, **kwargs)

%(prog)s delete-queued-image <IMAGE_ID> [options]

Deletes an image from the cache

glance.cmd.cache_manage.env(*vars, **kwargs)

Search for the first defined of possibly many env vars.

Returns the first environment variable defined in vars, or returns the default defined in kwargs.

glance.cmd.cache_manage.get_client(options)

Return a new client object to a Glance server.

specified by the –host and –port options supplied to the CLI

glance.cmd.cache_manage.list_cached(*args, **kwargs)

%(prog)s list-cached [options]

List all images currently cached.

glance.cmd.cache_manage.list_queued(*args, **kwargs)

%(prog)s list-queued [options]

List all images currently queued for caching.

glance.cmd.cache_manage.lookup_command(parser, command_name)

glance.cmd.cache_manage.main()

glance.cmd.cache_manage.parse_options(parser, cli_args)

Returns the parsed CLI options, command to run and its arguments, merged with any same-named options found in a configuration file

Parameters:parser – The option parser

glance.cmd.cache_manage.print_help(options, args)

Print help specific to a command

glance.cmd.cache_manage.queue_image(*args, **kwargs)

%(prog)s queue-image <IMAGE_ID> [options]

Queues an image for caching

glance.cmd.cache_manage.user_confirm(prompt, default=False)

Yes/No question dialog with user.

Parameters:

• prompt – question/statement to present to user (string)
• default – boolean value to return if empty string is received as response to prompt

glance.cmd.cache_prefetcher module

Glance Image Cache Pre-fetcher

This is meant to be run from the command line after queueing images to be pretched.

glance.cmd.cache_prefetcher.main()

glance.cmd.cache_pruner module

Glance Image Cache Pruner

This is meant to be run as a periodic task, perhaps every half-hour.

glance.cmd.cache_pruner.main()

glance.cmd.control module

Helper script for starting/stopping/reloading Glance server programs. Thanks for some of the code, Swifties ;)

glance.cmd.control.add_command_parsers(subparsers)

glance.cmd.control.do_check_status(pid_file, server)

glance.cmd.control.do_reload(pid_file, server)

glance.cmd.control.do_start(verb, pid_file, server, args)

glance.cmd.control.do_stop(server, args, graceful=False)

glance.cmd.control.gated_by(predicate)

glance.cmd.control.get_pid_file(server, pid_file)

glance.cmd.control.main()

glance.cmd.control.pid_files(server, pid_file)

glance.cmd.glare module

Glare (Glance Artifact Repository) API service

glance.cmd.glare.fail(e)

glance.cmd.glare.main()

glance.cmd.manage module

Glance Management Utility

class glance.cmd.manage.DbCommands

Bases: object

Class for managing the db

contract()

Run the contraction phase of a rolling upgrade procedure.

expand()

Run the expansion phase of a rolling upgrade procedure.

export_metadefs(path=None)

Export metadefinitions data from database to files

load_metadefs(path=None, merge=False, prefer_new=False, overwrite=False)

Load metadefinition json files to database

migrate()

purge(age_in_days=30, max_rows=100)

Purge deleted rows older than a given age from glance tables.

sync(version='ocata01')

Place an existing database under migration control and upgrade it.

unload_metadefs()

Unload metadefinitions from database

upgrade(version='ocata01')

Upgrade the database’s migration level

version()

Print database’s current migration level

version_control(version='liberty')

Place a database under migration control

class glance.cmd.manage.DbLegacyCommands(command_object)

Bases: object

Class for managing the db using legacy commands

contract()

expand()

export_metadefs(path=None)

load_metadefs(path=None, merge=False, prefer_new=False, overwrite=False)

migrate()

sync(version='ocata01')

unload_metadefs()

upgrade(version='ocata01')

version()

version_control(version='liberty')

glance.cmd.manage.add_command_parsers(subparsers)

glance.cmd.manage.add_legacy_command_parsers(command_object, subparsers)

glance.cmd.manage.args(*args, **kwargs)

glance.cmd.manage.main()

glance.cmd.manage.methods_of(obj)

Get all callable methods of an object that don’t start with underscore

returns a list of tuples of the form (method_name, method)

glance.cmd.registry module

Reference implementation server for Glance Registry

glance.cmd.registry.main()

glance.cmd.replicator module

class glance.cmd.replicator.ImageService(conn, auth_token)

Bases: object

add_image(image_meta, image_data)

Upload an image.

image_meta: image metadata as a dictionary image_data: image data as a object with a read() method

Returns: a tuple of (http response headers, http response body)

add_image_meta(image_meta)

Update image metadata.

image_meta: image metadata as a dictionary

Returns: a tuple of (http response headers, http response body)

get_image(image_uuid)

Fetch image data from glance.

image_uuid: the id of an image

Returns: a http_client Response object where the body is the image.

get_image_meta(image_uuid)

Return the metadata for a single image.

image_uuid: the id of an image

Returns: image metadata as a dictionary

get_images()

Return a detailed list of images.

Yields a series of images as dicts containing metadata.

glance.cmd.replicator.get_image_service()

Get a copy of the image service.

This is done like this to make it easier to mock out ImageService.

glance.cmd.replicator.lookup_command(command_name)

Lookup a command.

command_name: the command name

Returns: a method which implements that command

glance.cmd.replicator.main()

The main function.

glance.cmd.replicator.print_help(options, args)

Print help specific to a command.

options: the parsed command line options args: the command line

glance.cmd.replicator.replication_compare(options, args)

%(prog)s compare <fromserver:port> <toserver:port>

Compare the contents of fromserver with those of toserver.

fromserver:port: the location of the master glance instance. toserver:port: the location of the slave glance instance.

glance.cmd.replicator.replication_dump(options, args)

%(prog)s dump <server:port> <path>

Dump the contents of a glance instance to local disk.

server:port: the location of the glance instance. path: a directory on disk to contain the data.

glance.cmd.replicator.replication_livecopy(options, args)

%(prog)s livecopy <fromserver:port> <toserver:port>

Load the contents of one glance instance into another.

fromserver:port: the location of the master glance instance. toserver:port: the location of the slave glance instance.

glance.cmd.replicator.replication_load(options, args)

%(prog)s load <server:port> <path>

Load the contents of a local directory into glance.

server:port: the location of the glance instance. path: a directory on disk containing the data.

glance.cmd.replicator.replication_size(options, args)

%(prog)s size <server:port>

Determine the size of a glance instance if dumped to disk.

server:port: the location of the glance instance.

glance.cmd.scrubber module

Glance Scrub Service

glance.cmd.scrubber.main()

Module contents

glance.cmd.fix_greendns_ipv6()