The karbor.manager Module

Base Manager class.

Managers are responsible for a certain aspect of the system. It is a logical grouping of code relating to a portion of the system. In general other components should be using the manager to make changes to the components that it is responsible for.

We have adopted a basic strategy of Smart managers and dumb data, which means rather than attaching methods to data objects, components should call manager methods that act on the data.

Methods on managers that can be executed locally should be called directly. If a particular method must execute on a remote host, this should be done via rpc to the service that wraps the manager

Managers should be responsible for most of the db access, and non-implementation specific data. Anything implementation specific that can’t be generalized should be done by the Driver.

Managers will often provide methods for initial setup of a host or periodic tasks to a wrapping service.

This module provides Manager, a base class for managers.

class karbor.manager.Manager(host=None, db_driver=None)

Bases: karbor.db.base.Base, karbor.manager.PeriodicTasks

RPC_API_VERSION = ‘1.0’

cleanup_host()

Hook to do cleanup work when the service shuts down.

Child classes should override this method.

init_host(**kwargs)

Handle initialization if this is a standalone service.

A hook point for services to execute tasks before the services are made available (i.e. showing up on RPC and starting to accept RPC calls) to other components. Child classes should override this method.

init_host_with_rpc()

A hook for service to do jobs after RPC is ready.

Like init_host(), this method is a hook where services get a chance to execute tasks that need RPC. Child classes should override this method.

is_working()

Method indicating if service is working correctly.

This method is supposed to be overridden by subclasses and return if manager is working correctly.

periodic_tasks(context, raise_on_error=False)

Tasks to be run at a periodic interval.

service_config()

service_version()

target = <Target version=1.0>

class karbor.manager.PeriodicTasks

Bases: oslo_service.periodic_task.PeriodicTasks