Router Clusters

RouterCluster

class RouterCluster(oid: UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, name: str | None = None, status: int | None = None, owner_oid: UUID | None = None, changed: datetime64 | None = None, _unknown=None)[source]

Bases: Cluster

A router cluster is able to run (application) realms, and is hosted on a groups of router workers kept in sync and meshed via router-to-router links.

marshal()[source]

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)[source]

Parse generic host language object into an object of this class.

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

class RouterClusters(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

A router cluster is able to run (application) realms, and is hosted on a groups of router workers kept in sync and meshed via router-to-router links (routercluster_oid -> routercluster).

class IndexRouterClusterByName(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of router clusters by router cluster names (routercluster_name -> routercluster_oid).

class RouterClusterNodeMembership(cluster_oid: UUID | None = None, node_oid: UUID | None = None, softlimit: int | None = None, hardlimit: int | None = None, _unknown=None)[source]

Bases: ClusterNodeMembership

Membership of a managed node (paired within a management realm) to a router cluster. A router cluster is able to run “data planes”, which are groups of router workers kept in sync, and meshed via router-to-router links. Finally, “(application) realms” can be started in data planes.

marshal()[source]

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)[source]

Parse generic host language object into an object of this class.

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

class RouterClusterNodeMemberships(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidUuidCbor

Membership of a managed node (paired within a management realm) to a router cluster ((cluster_oid, node_oid) -> cluster_node_membership).

RouterWorkerGroup

class RouterWorkerGroup(oid: UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, cluster_oid: UUID | None = None, name: str | None = None, scale: int | None = None, status: int | None = None, changed: datetime64 | None = None, _unknown=None)[source]

Bases: ConfigurationElement

Router worker group database configuration object.

marshal()[source]

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)[source]

Parse generic host language object into an object of this class.

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

class RouterWorkerGroups(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Router worker group database configuration object (workergroup_oid -> workergroup).

class IndexWorkerGroupByCluster(slot=None, compress=None)[source]

Bases: MapUuidStringUuid

Index of router worker groups by router clusters and group names ((cluster_oid, workergroup_name) -> workergroup_oid).

class IndexWorkerGroupByPlacement(slot=None, compress=None)[source]

Bases: MapUuidUuidUuidUuid

Index of router worker groups by cluster, node and placement ((cluster_oid, node_oid, placement_oid) -> workergroup_oid).

class RouterWorkerGroupClusterPlacement(oid: UUID | None = None, worker_group_oid: UUID | None = None, cluster_oid: UUID | None = None, node_oid: UUID | None = None, worker_name: str | None = None, status: int | None = None, changed: datetime64 | None = None, tcp_listening_port: int | None = None, _unknown: dict | None = None)[source]

Bases: object

Placement of router worker groups onto router clusters, specifically router workers and xbrmm workers running as part of router worker groups.

marshal()[source]

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)[source]

Parse generic host language object into an object of this class.

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

class RouterWorkerGroupClusterPlacements(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Router worker group placements of workers (placement_oid -> placement).

class IndexClusterPlacementByWorkerName(slot=None, compress=None)[source]

Bases: MapUuidUuidUuidStringUuid

Index of router worker group placements by worker group, cluster, node and worker name ((workergroup_oid, cluster_oid, node_oid, worker_name) -> placement_oid).