cfxdb.mrealm

Submodules

• cfxdb.mrealm.application_realm
• cfxdb.mrealm.arealm_role_association
• cfxdb.mrealm.cluster
• cfxdb.mrealm.cluster_node_membership
• cfxdb.mrealm.credential
• cfxdb.mrealm.management_realm
• cfxdb.mrealm.node
• cfxdb.mrealm.permission
• cfxdb.mrealm.principal
• cfxdb.mrealm.role
• cfxdb.mrealm.router_cluster
• cfxdb.mrealm.router_cluster_node_membership
• cfxdb.mrealm.router_workergroup
• cfxdb.mrealm.router_workergroup_cluster_placement
• cfxdb.mrealm.types
• cfxdb.mrealm.web_cluster
• cfxdb.mrealm.web_cluster_node_membership
• cfxdb.mrealm.web_service

Classes

ApplicationRealm	Application realm database configuration object.
ApplicationRealmRoleAssociation	Association of a role with an application realm.
ApplicationRealmStatus
AuthenticationMethod
Cluster	CFC Cluster database configuration object.
ClusterNodeMembership	Membership of a node in a cluster.
ClusterStatus
Credential	Credentials created for use with WAMP authentication.
ManagementRealm	Management realm database configuration object.
MatchType
Node	Nodes paired with management realms on this master node.
Permission	Role permission database object.
Principal	Principals created for use with WAMP authentication. A principal represents the identity
Role	Roles created for use with application-level authorization and permissions
RouterCluster	A router cluster is able to run (application) realms, and is hosted on a groups of router workers
RouterClusterNodeMembership	Membership of a managed node (paired within a management realm) to a router cluster.
RouterWorkerGroup	Router worker group database configuration object.
RouterWorkerGroupClusterPlacement	Placement of router worker groups onto router clusters, specifically router workers
UriCheckLevel
WebCluster	Web cluster database configuration object.
WebClusterNodeMembership	Information about memberships of nodes in web clusters.
WebService	Web service:
WorkerGroupStatus

Package Contents

class ApplicationRealm(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, name: str | None = None, status: int | None = None, workergroup_oid: uuid.UUID | None = None, webcluster_oid: uuid.UUID | None = None, datamarket_oid: uuid.UUID | None = None, changed: numpy.datetime64 | None = None, owner_oid: uuid.UUID | None = None, _unknown: Any | None = None)

Bases: cfxdb.common.ConfigurationElement

Application realm database configuration object.

STATUS_BY_CODE

STATUS_BY_NAME

STATUS_DEGRADED = 7

STATUS_ERROR = 6

STATUS_PAUSED = 4

STATUS_RUNNING = 3

STATUS_STARTING = 2

STATUS_STOPPED = 1

STATUS_STOPPING = 5

__eq__(other: Any) → bool

__ne__(other: Any) → bool

__str__() → str

_unknown = None

changed = None

copy(other: ApplicationRealm, overwrite: bool = False)

Copy over other object.

Parameters:

• other – Other application realm to copy data from.

• overwrite – Overwrite members already set.

datamarket_oid = None

marshal() → Dict[str, Any]

Marshal this object to a generic host language object.

name = None

owner_oid = None

static parse(data: Dict[str, Any]) → ApplicationRealm

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

Parameters:

data – Generic host language object

Returns:

New instance of this class.

status = None

webcluster_oid = None

workergroup_oid = None

class ApplicationRealmRoleAssociation(arealm_oid: uuid.UUID | None = None, role_oid: uuid.UUID | None = None, _unknown=None)

Bases: object

Association of a role with an application realm.

__eq__(other)

__ne__(other)

__str__()

_unknown = None

Object ID of the application realm this association applies to.

Parameters:

role_oid – Object ID of the role this association applies to.

Type:

param arealm_oid

arealm_oid = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

role_oid = None

class ApplicationRealmStatus

Bases: object

DEGRADED = 7

ERROR = 6

NONE = 0

PAUSED = 4

RUNNING = 3

STARTING = 2

STOPPED = 1

STOPPING = 5

class AuthenticationMethod

Bases: object

ANONYMOUS = 1

COOKIE = 5

CRYPTOSIGN = 6

NONE = 0

SCRAM = 7

TICKET = 2

TLS = 4

WAMPCRA = 3

class Cluster(oid: uuid.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.UUID | None = None, changed: numpy.datetime64 | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

CFC Cluster database configuration object.

__eq__(other)

__ne__(other)

__str__()

changed = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

name = None

owner_oid = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

status = None

class ClusterNodeMembership(cluster_oid: uuid.UUID | None = None, node_oid: uuid.UUID | None = None, _unknown=None)

Bases: object

Membership of a node in a cluster.

__eq__(other)

__ne__(other)

__str__()

_unknown = None

cluster_oid = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

node_oid = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

class ClusterStatus

Bases: object

DEGRADED = 7

ERROR = 6

NONE = 0

PAUSED = 4

RUNNING = 3

STARTING = 2

STOPPED = 1

STOPPING = 5

class Credential(oid: uuid.UUID | None = None, created: numpy.datetime64 | None = None, authmethod: str | None = None, authid: str | None = None, realm: str | None = None, authconfig: dict | None = None, principal_oid: uuid.UUID | None = None, _unknown=None)

Bases: object

Credentials created for use with WAMP authentication.

__eq__(other)

__ne__(other)

__str__()

_unknown = None

authconfig = None

authid = None

authmethod = None

copy(other, overwrite=False)

Copy over other object.

Parameters:

other (instance of ManagementRealm) – Other credential to copy data from.

Returns:

created = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

oid = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

principal_oid = None

realm = None

class ManagementRealm(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, name: str | None = None, created: datetime.datetime | None = None, owner: uuid.UUID | None = None, cf_router_worker: str | None = None, cf_container_worker: str | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

Management realm database configuration object.

__eq__(other)

__ne__(other)

__str__()

_unknown = None

cf_container_worker = None

cf_router_worker = None

copy(other, overwrite=False)

Copy over other object.

Parameters:

other (instance of ManagementRealm) – Other management realm to copy data from.

Returns:

created = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

name = None

owner = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

class MatchType

Bases: object

EXACT = 1

NONE = 0

PREFIX = 2

WILDCARD = 3

class Node(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, owner_oid: uuid.UUID | None = None, pubkey: str | None = None, cluster_ip: str | None = None, mrealm_oid: uuid.UUID | None = None, authid: str | None = None, authextra: dict | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

Nodes paired with management realms on this master node.

__eq__(other)

__ne__(other)

__str__()

authextra = None

authid = None

cluster_ip = None

copy(other, overwrite=False)

Copy over other object.

Parameters:

other (instance of ManagementRealm) – Other management realm to copy data from.

Returns:

marshal()

Marshal this object to a generic host language object.

Returns:

dict

mrealm_oid = None

owner_oid = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

pubkey = None

class Permission(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, role_oid: uuid.UUID | None = None, uri: str | None = None, uri_check_level: int | None = None, match: int | None = None, allow_call: bool | None = None, allow_register: bool | None = None, allow_publish: bool | None = None, allow_subscribe: bool | None = None, disclose_caller: bool | None = None, disclose_publisher: bool | None = None, cache: bool | None = None, created: numpy.datetime64 | None = None, owner: uuid.UUID | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

Role permission database object.

MATCH_TYPES_FROMSTR

MATCH_TYPES_TOSTR

MATCH_TYPE_EXACT: int = 1

MATCH_TYPE_NONE: int = 0

MATCH_TYPE_PREFIX: int = 2

MATCH_TYPE_WILDCARD: int = 3

URI_CHECK_LEVELS_FROMSTR

URI_CHECK_LEVELS_TOSTR

URI_CHECK_LEVEL_LOOSE: int = 2

URI_CHECK_LEVEL_NONE: int = 0

URI_CHECK_LEVEL_STRICT: int = 1

__eq__(other)

__ne__(other)

__str__()

_unknown = None

allow_call = None

allow_publish = None

allow_register = None

allow_subscribe = None

cache = None

copy(other, overwrite=False)

Copy over other object.

Parameters:

other (instance of ManagementRealm) – Other permission to copy data from.

Returns:

created = None

disclose_caller = None

disclose_publisher = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

match = None

owner = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

role_oid = None

uri = None

uri_check_level = None

class Principal(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, modified: int | None = None, arealm_oid: uuid.UUID | None = None, authid: str | None = None, role_oid: uuid.UUID | None = None, authextra: dict | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

Principals created for use with WAMP authentication. A principal represents the identity an application client is authenticated to the application realm joined.

A principal must have at least one cfxdb.mrealmschema.Credential added. When an application client connects, it will offer an authmethod and request a realm and (usually) authid. When a matching cfxdb.mrealmschema.Credential is found, and authentication succeeds using that, the client will be authenticated under the cfxdb.mrealmschema.Principal associated with the credential.

Note

It is important to note that while the realm and authid requested by the client (and defined in the respective cfxdb.mrealmschema.Credential) will usually be identical to the realm and authid actually assigned (as defined in the cfxdb.mrealmschema.Principal associated with the credential), this is allowed to differ in general.

__eq__(other)

__ne__(other)

__str__()

_unknown = None

arealm_oid = None

authextra = None

authid = None

copy(other, overwrite=False)

Copy over other object.

Parameters:

other (instance of cfxdb.mrealm.Principal) – Other principal to copy data from.

Returns:

marshal()

Marshal this object to a generic host language object.

Returns:

dict

modified = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

role_oid = None

class Role(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, name: str | None = None, created: numpy.datetime64 | None = None, owner: uuid.UUID | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

Roles created for use with application-level authorization and permissions in application realms.

__eq__(other)

__ne__(other)

__str__()

_unknown = None

copy(other, overwrite=False)

Copy over other object.

Parameters:

other (instance of ManagementRealm) – Other role to copy data from.

Returns:

created = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

name = None

owner = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

class RouterCluster(oid: uuid.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.UUID | None = None, changed: numpy.datetime64 | None = None, _unknown=None)

Bases: cfxdb.mrealm.cluster.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.

__eq__(other)

__ne__(other)

__str__()

marshal()

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

class RouterClusterNodeMembership(cluster_oid: uuid.UUID | None = None, node_oid: uuid.UUID | None = None, softlimit: int | None = None, hardlimit: int | None = None, _unknown=None)

Bases: cfxdb.mrealm.cluster_node_membership.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.

__eq__(other)

__ne__(other)

__str__()

hardlimit = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

softlimit = None

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

Bases: cfxdb.common.ConfigurationElement

Router worker group database configuration object.

__eq__(other)

__ne__(other)

__str__()

changed = None

cluster_oid = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

name = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

scale = 1

status = None

class RouterWorkerGroupClusterPlacement(oid: uuid.UUID | None = None, worker_group_oid: uuid.UUID | None = None, cluster_oid: uuid.UUID | None = None, node_oid: uuid.UUID | None = None, worker_name: str | None = None, status: int | None = None, changed: numpy.datetime64 | None = None, tcp_listening_port: int | None = None, _unknown: dict | None = None)

Bases: object

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

__eq__(other)

__ne__(other)

__str__()

_unknown = None

changed = None

cluster_oid = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

node_oid = None

oid = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

status = None

tcp_listening_port = None

worker_group_oid = None

worker_name = None

class UriCheckLevel

Bases: object

LOOSE = 2

NONE = 0

STRICT = 1

class WebCluster(oid: uuid.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.UUID | None = None, changed: numpy.datetime64 | None = None, tcp_version: int | None = None, tcp_port: int | None = None, tcp_shared: bool | None = None, tcp_interface: str | None = None, tcp_backlog: int | None = None, tls_key: str | None = None, tls_certificate: str | None = None, tls_chain_certificates: List[str] | None = None, tls_ca_certificates: List[str] | None = None, tls_dhparam: str | None = None, tls_ciphers: str | None = None, http_client_timeout: int | None = None, http_hsts: bool | None = None, http_hsts_max_age: int | None = None, http_access_log: bool | None = None, http_display_tracebacks: bool | None = None, _unknown=None)

Bases: cfxdb.mrealm.cluster.Cluster

Web cluster database configuration object.

__eq__(other)

__ne__(other)

__str__()

http_access_log = None

http_client_timeout = None

http_display_tracebacks = None

http_hsts = None

http_hsts_max_age = None

marshal()

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

tcp_backlog = None

tcp_interface = None

tcp_port = None

tcp_shared = None

tcp_version = None

tls_ca_certificates = None

tls_certificate = None

tls_chain_certificates = None

tls_ciphers = None

tls_dhparam = None

tls_key = None

class WebClusterNodeMembership(cluster_oid: uuid.UUID | None = None, node_oid: uuid.UUID | None = None, parallel: int | None = None, standby: bool | None = None, _unknown=None)

Bases: cfxdb.mrealm.cluster_node_membership.ClusterNodeMembership

Information about memberships of nodes in web clusters.

__eq__(other)

__ne__(other)

__str__()

marshal()

Marshal this object to a generic host language object.

Returns:

dict

parallel = None

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

standby = None

class WebService(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, service_type: str | None = None, webcluster_oid: uuid.UUID | None = None, path: str | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

Web service:

• check_web_path_service

__eq__(other)

__ne__(other)

__str__()

marshal()

Marshal this object to a generic host language object.

Returns:

dict

other(key, default=None)

static parse(data)

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

Parameters:

data (dict) – Generic host language object

Returns:

instance of WebService

path = None

service_type = None

webcluster_oid = None

class WorkerGroupStatus

Bases: object

DEGRADED = 7

ERROR = 6

NONE = 0

PAUSED = 4

RUNNING = 3

STARTING = 2

STOPPED = 1

STOPPING = 5