The nova.servicegroup.api Module

Define APIs for the servicegroup access.

class API

Bases: object

get_all(group_id)

Returns ALL members of the given group.

get_one(group_id)

Returns one member of the given group. The strategy to select the member is decided by the driver (e.g. random or round-robin).

join(member_id, group_id, service=None)

Add a new member to the ServiceGroup

@param member_id: the joined member ID @param group_id: the group name, of the joined member @param service: the parameter can be used for notifications about disconnect mode and update some internals

leave(member_id, group_id)

Explicitly remove the given member from the ServiceGroup monitoring.

service_is_up(member)

Check if the given member is up.

class ServiceGroupDriver

Bases: object

Base class for ServiceGroup drivers.

get_all(group_id)

Returns ALL members of the given group.

get_one(group_id)

The default behavior of get_one is to randomly pick one from the result of get_all(). This is likely to be overridden in the actual driver implementation.

is_up(member)

Check whether the given member is up.

join(member_id, group_id, service=None)

Join the given service with it’s group.

leave(member_id, group_id)

Remove the given member from the ServiceGroup monitoring.