karbor.common package

Submodules

karbor.common.config module

Command-line flag library.

Emulates gflags by wrapping cfg.ConfigOpts.

The idea is to move fully to cfg eventually, and this wrapper is a stepping stone.

karbor.common.config.list_opts()

karbor.common.constants module

karbor.common.karbor_keystone_plugin module

class karbor.common.karbor_keystone_plugin.KarborKeystonePlugin

Bases: object

Contruct a keystone client plugin with karbor user

to offer the following functions:

1. get the endpoint of service, such as nova, cinder

2. create trust to karbor

property auth_uri

property client

create_trust_session(trust_id)

create_trust_to_karbor(context)

create_user_auth_plugin(context)

delete_trust_to_karbor(trust_id)

get_service_endpoint(service_name, service_type, region_id, interface='public')

property karbor_user_id

property service_auth_plugin

karbor.common.notification module

The notification module.

class karbor.common.notification.EndNotification(context, **kwargs)

Bases: object

class karbor.common.notification.KaborAPINotification(context, **kwargs)

Bases: object

The traits of karbor.* notifications.

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

event_type_format = 'karbor.%s.%s'

notify_callback = None

notify_end(**kwargs)

notify_exc_info(message, exception)

notify_start(**kwargs)

optional_end_traits()

Returns list of optional traits for end notification

optional_error_traits()

Returns list of optional traits for error notification

optional_start_traits()

Returns list of optional traits for start notification

classmethod register_notify_callback(callback)

Callback when a notification is sent out.

property request_id

required_base_traits()

required_end_traits()

Returns list of required traits for end notification

required_error_traits()

Returns list of required traits for error notification

abstract required_start_traits()

Returns list of required traits for start notification

serialize(context)

validate(required_traits)

class karbor.common.notification.KarborCheckpointCreate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

required_end_traits()

Returns list of required traits for end notification

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborCheckpointDelete(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

required_end_traits()

Returns list of required traits for end notification

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborCheckpointUpdate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborPlanCreate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

optional_start_traits()

Returns list of optional traits for start notification

required_end_traits()

Returns list of required traits for end notification

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborPlanDelete(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborPlanUpdate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborRestoreCreate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

required_end_traits()

Returns list of required traits for end notification

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborRestoreDelete(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborScheduledOpsCreate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

required_end_traits()

Returns list of required traits for end notification

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborScheduledOpsDelete(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

required_end_traits()

Returns list of required traits for end notification

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborTriggerCreate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

optional_start_traits()

Returns list of optional traits for start notification

required_end_traits()

Returns list of required traits for end notification

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborTriggerDelete(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.KarborTriggerUpdate(context, **kwargs)

Bases: karbor.common.notification.KaborAPINotification

abstract event_type()

Returns the event type (like “create” for karbor.create.start)

abstract required_start_traits()

Returns list of required traits for start notification

class karbor.common.notification.StartNotification(context, **kwargs)

Bases: karbor.common.notification.EndNotification

karbor.common.opts module

karbor.common.opts.list_opts()

Module contents