Web Clusters

WebCluster

class cfxdb.mrealm.WebCluster(oid: Optional[UUID] = None, label: Optional[str] = None, description: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, status: Optional[int] = None, owner_oid: Optional[UUID] = None, changed: Optional[datetime64] = None, tcp_version: Optional[int] = None, tcp_port: Optional[int] = None, tcp_shared: Optional[bool] = None, tcp_interface: Optional[str] = None, tcp_backlog: Optional[int] = None, tls_key: Optional[str] = None, tls_certificate: Optional[str] = None, tls_chain_certificates: Optional[List[str]] = None, tls_ca_certificates: Optional[List[str]] = None, tls_dhparam: Optional[str] = None, tls_ciphers: Optional[str] = None, http_client_timeout: Optional[int] = None, http_hsts: Optional[bool] = None, http_hsts_max_age: Optional[int] = None, http_access_log: Optional[bool] = None, http_display_tracebacks: Optional[bool] = None, _unknown=None)[source]

Bases: Cluster

Web cluster database configuration object.

Parameters

  • oid – Object ID of node

  • label – Optional user label of node

  • description – Optional user description of node

  • tags – Optional list of user tags on node

  • tcp_version – IP version, either 4 for 6

  • tcp_port – IP listening port

  • tcp_shared – enable TCP port sharing

  • tcp_interface – listen on this interface

  • tcp_backlog – TCP accept backlog queue size

  • tls_key – TLS server private key to use

  • tls_certificate – TLS server certificate to use

  • tls_chain_certificates – TLS certificate chain

  • tls_ca_certificates – CA certificates to use

  • tls_dhparam – DH parameter file

  • tls_ciphers – Ciphers list

  • http_client_timeout – HTTP client inactivity timeout

  • http_hsts – enable HTTP strict transport security (HSTS)

  • http_hsts_max_age – HSTS maximum age to announce

  • http_access_log – enable Web request access logging

  • http_display_tracebacks – enable tracebacks when running into Web errors

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 cfxdb.mrealmschema.WebClusters(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Web cluster database configuration object (webcluster_oid -> webcluster).

class cfxdb.mrealmschema.IndexWebClusterByName(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of web clusters by cluster name (webcluster_name -> webcluster_oid).

class cfxdb.mrealm.WebClusterNodeMembership(cluster_oid: Optional[UUID] = None, node_oid: Optional[UUID] = None, parallel: Optional[int] = None, standby: Optional[bool] = None, _unknown=None)[source]

Bases: ClusterNodeMembership

Information about memberships of nodes in web clusters.

Parameters

  • cluster_oid – Object ID of the cluster the node is member in.

  • node_oid – Object ID of the node that is member in the cluster.

  • parallel – Default parallel degree per node in this cluster.

  • standby – Flag indicating whether this is a (currently inactive) standby node.

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 cfxdb.mrealmschema.WebClusterNodeMemberships(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidUuidCbor

Information about memberships of nodes in web clusters ((webcluster_oid, node_oid) -> webcluster_node_membership).

WebService

class cfxdb.mrealm.WebService(oid: Optional[UUID] = None, label: Optional[str] = None, description: Optional[str] = None, tags: Optional[List[str]] = None, service_type: Optional[str] = None, webcluster_oid: Optional[UUID] = None, path: Optional[str] = None, _unknown=None)[source]

Bases: ConfigurationElement

Web service:

  • check_web_path_service

Parameters

  • oid – Object ID of this web service.

  • label – Optional user label of this web service.

  • description – Optional user description of this web service.

  • tags – Optional list of user tags on this web service.

  • path – HTTP URL path of the Web service, eg /myapp or /myapp/dashboard/72.

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 cfxdb.mrealmschema.WebServices(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Web cluster services (webservice_oid -> webservice).

class cfxdb.mrealmschema.IndexWebServiceByPath(slot=None, compress=None)[source]

Bases: MapUuidStringUuid

Index of web services by web cluster and web service name ((webcluster_oid, webservice_name) -> webservice_oid).

class cfxdb.mrealmschema.IndexWebClusterWebServices(slot=None, compress=None)[source]

Bases: MapUuidUuidUuid

Index of web services by web cluster and web service ((webcluster_oid, webservice_oid) -> webservice_oid).