Management Domain


The domain controller running on the master node stores its configuration and run-time information in an embedded database

All database tables and indexes can be accessed using the type information and schema definitions from a single database schema class:

class cfxdb.globalschema.GlobalSchema(db)[source]

Global (master node wide) database schema.

nodes: Nodes

Nodes.

idx_nodes_by_pubkey: IndexNodesByPubkey

Index on nodes (by pubkey).

idx_nodes_by_authid: IndexNodesByAuthid

Index on nodes (by authid).

organizations: Organizations

Organizations.

idx_organizations_by_name: IndexOrganizationsByName

Index on organizations (by name).

users: Users

Users.

idx_users_by_pubkey: IndexUsersByPubkey

Index on users (by pubkey).

idx_users_by_email: IndexUsersByEmail

Index on users (by email).

activation_tokens: ActivationTokens

User activation tokens.

idx_act_tokens_by_authid_pubkey: IndexActivationTokensByAuthidPubkey

Index on user activation tokens (by authid, pubkey).

mrealms: ManagementRealms

Management realms.

idx_mrealms_by_name: IndexManagementRealmByName

Index on management realms (by name).

users_mrealm_roles: UserMrealmRoles

User roles map (by mrealm_oid, user_oid to UserRoles).

usage: UsageRecords

Usage metering records (by timestamp).

static attach(db: Database) object[source]

Factory to create a schema from attaching to a database. The schema tables will be automatically mapped as persistant maps and attached to the database slots.

Parameters

db – Database to which to attach this schema.

Returns

Open database handle with attached schema, an instance of GlobalSchema.

Note

There exists only one domain controller database per master node. This database is separate from all managament realm controller databases, and only used to book keep users, Management realms and paired nodes. All configuration and management within a given management realm is then stored in the management realm controller database dedicated to the respective realm.

class cfxdb.common.ConfigurationElement(oid=None, label=None, description=None, tags=None, _unknown=None)[source]

Bases: object

CFC configuration element, an abstract “thing” with a unique identifier (“oid”, which is of type UUID) and that can be user documented using

  • label

  • description

  • tags

These elements are under user (application) control and not interpreted by the CFC backend code (beyond their basic types of string or list of string).

Configuration elements can be nearly everything in CFC configuration:

  • Users

  • Mrealms

  • Nodes

oid = None

Object ID.

label = None

User label for object (optional free text).

description = None

User description for object (optional free text)

tags = None

User tags for object (optional free list of text portions)