generated from canonical/template-operator
-
Notifications
You must be signed in to change notification settings - Fork 8
Internal Data Model
Mehdi Bendriss edited this page Jul 9, 2024
·
21 revisions
Backwards compatibility, during minor version upgrades, can be broken due to changes in the relations data.
This document is intended only for charm developers.
We aim to document the internal data models currently used in order to carefully assess any breaking changes in future releases of the OpenSearch charm.
-
- Label prefix:
<app_name>:app:
- Content:
-
admin-password
: password of the admin user of the charm - created when deploying the charm first, this is the operator user of the charm. -
kibanaserver-password
: password of the kibanaserver user when being integrated with theopensearch-dashboards
charm, this user configures the opensearch dashboards internal config files. -
monitor-password
: password of the monitor user needed when integrating with COS for reporting metrics.
-
- Label prefix:
-
Label: label1 Content: *
admin_password
: password of the admin user of the charm.
-
- Label prefix:
<app_name>:app:<unit_id>:
Content:-
admin_password
: password of the admin user of the charm.
-
- Label prefix:
-
Label: label1 Content: *
admin_password
: password of the admin user of the charm.
class App(Model):
"""Data class representing an application."""
id: Optional[str] = None
short_id: Optional[str] = None
name: Optional[str] = None
model_uuid: Optional[str] = None
class Node(Model):
"""Data class representing a node in a cluster."""
name: str
roles: List[str]
ip: str
app: App
unit_number: int
temperature: Optional[str] = None
class DeploymentType(BaseStrEnum):
"""Nature of a sub cluster deployment."""
MAIN_ORCHESTRATOR = "main-orchestrator"
FAILOVER_ORCHESTRATOR = "failover-orchestrator"
OTHER = "other"
class StartMode(BaseStrEnum):
"""Mode of start of units in this deployment."""
WITH_PROVIDED_ROLES = "start-with-provided-roles"
WITH_GENERATED_ROLES = "start-with-generated-roles"
class Directive(BaseStrEnum):
"""Directive indicating what the pending actions for the current deployments are."""
NONE = "none"
SHOW_STATUS = "show-status"
WAIT_FOR_PEER_CLUSTER_RELATION = "wait-for-peer-cluster-relation"
INHERIT_CLUSTER_NAME = "inherit-name"
VALIDATE_CLUSTER_NAME = "validate-cluster-name"
RECONFIGURE = "reconfigure-cluster"
class State(BaseStrEnum):
"""State of a deployment, directly mapping to the juju statuses."""
ACTIVE = "active"
BLOCKED_WAITING_FOR_RELATION = "blocked-waiting-for-peer-cluster-relation"
BLOCKED_WRONG_RELATED_CLUSTER = "blocked-wrong-related-cluster"
BLOCKED_CANNOT_START_WITH_ROLES = "blocked-cannot-start-with-current-set-roles"
BLOCKED_CANNOT_APPLY_NEW_ROLES = "blocked-cannot-apply-new-roles"
class DeploymentState(Model):
"""Full state of a deployment, along with the juju status."""
value: State
message: str = Field(default="")
class PeerClusterConfig(Model):
"""Model class for the multi-clusters related config set by the user."""
cluster_name: str
init_hold: bool
roles: List[str]
data_temperature: Optional[str] = None
class DeploymentDescription(Model):
"""Model class describing the current state of a deployment / sub-cluster."""
app: App
config: PeerClusterConfig
start: StartMode
pending_directives: List[Directive]
typ: DeploymentType
state: DeploymentState = DeploymentState(value=State.ACTIVE)
promotion_time: Optional[float]
class S3RelDataCredentials(Model):
"""Model class for credentials passed on the PCluster relation."""
access_key: str = Field(alias="access-key")
secret_key: str = Field(alias="secret-key")
class PeerClusterRelDataCredentials(Model):
"""Model class for credentials passed on the PCluster relation."""
admin_username: str
admin_password: str
admin_password_hash: str
kibana_password: str
kibana_password_hash: str
monitor_password: str
admin_tls: Dict[str, Optional[str]]
s3: Optional[S3RelDataCredentials]
class PeerClusterApp(Model):
"""Model class for representing an application part of a large deployment."""
app: App
planned_units: int
units: List[str]
class PeerClusterFleetApps(Model):
"""Model class for all applications in a large deployment as a dict."""
__root__: Dict[str, PeerClusterApp]
class PeerClusterRelData(Model):
"""Model class for the PCluster relation data."""
cluster_name: str
cm_nodes: List[Node]
credentials: PeerClusterRelDataCredentials
deployment_desc: Optional[DeploymentDescription]
class PeerClusterRelErrorData(Model):
"""Model class for the PCluster relation data."""
cluster_name: Optional[str]
should_sever_relation: bool
should_wait: bool
blocked_message: str
deployment_desc: Optional[DeploymentDescription]
class PeerClusterOrchestrators(Model):
"""Model class for the PClusters registered main/failover clusters."""
_TYPES = Literal["main", "failover"]
main_rel_id: int = -1
main_app: Optional[App]
failover_rel_id: int = -1
failover_app: Optional[App]
We distinguish between the different types of relations.
-
- Relation endpoint:
opensearch-peers
: - Content:
-
security_index_initialised: bool
: whether the security index has been initialized through the opensearch securityadmin script. -
admin_user_initialized: bool
: indicates that the admin user has been created and set. -
bootstrap_contributors_count: int
: count of bootstrap process contributors. -
deployment_description: DeploymentDescription
: description of the current deployment. -
nodes_config: List[Node]
: full list of current nodes configured by the charm.- to be deprecated - once confirmed opensearch is able to make an election with an even number of cm eligible nodes
-
update-ts: int
: current time in nanoseconds since epoch (used to trigger apeer-rel-changed
event by the leader).- to be deprecated in favor of the same flag in unit data
-
- Relation endpoint:
-
- Relation endpoint:
opensearch-peers
- Content:
-
orchestrators: PeerClusterOrchestrators
: List of registered orchestrators in this application. -
cluster_fleet_apps: PeerClusterFleetApps
: Mapping offull application id
andPeerClusterApp
(full descriptor of a juju opensearch app) -
cluster_fleet_apps_rels: PeerClusterApp
: (Only on the orchestrators side) - Mapping related application full names and large deployment relation id.
-
- Relation endpoint:
-
- Relation endpoint:
node-lock-fallback
- Content:
-
unit-with-lock: str
: full name of the unit holding the lock, when peer relation is used for locking. -
leader-acquired-lock-after-juju-event-id: str
: indicates the juju event id whereunit-with-lock
was set.
-
- Relation endpoint:
-
- Relation endpoint:
upgrade-version-a
- Content:
-
versions: Dict[str, str] / {"charm": "", "workload": ""}
: descriptor of the current charm and workload (opensearch) versions. -
upgrade-resumed: bool
: whether the upgrade procedure resumed after confirming the first unit to upgrade is healthy. -
-unused-timestamp-upgrade-resume-last-updated: str
: set current time to trigger a relation changed event.
-
- Relation endpoint:
-
- Relation endpoint:
opensearch-peers
- Content:
-
started: bool
: whether this unit has fully started and the node is up. -
tls_configured: bool
: flag set when TLS is fully configured in a unit (the TLS secrets / certificates and keys have been set and stored on disk) -
bootstrap_contributor: bool
: whether acluster_manager
eligible node has been part of the bootstrapping process (initial_cluster_manager
inopensearch.yml
) -
certs_exp_checked_at: str
: expiration date of the certificates (date_format%Y-%m-%d %H:%M:%S
) -
update-ts: int
: current time in nanoseconds since epoch (used to trigger apeer-rel-changed
event by any unit).
-
- Relation endpoint:
-
- Relation endpoint:
node-lock-fallback
- Content:
-
lock-requested: bool
: whether this unit requested the lock. -
-trigger: str
: set the current juju context id to trigger a rel changed event on the leader (from a non leader unit).
-
- Relation endpoint:
-
- Relation endpoint:
upgrade-version-a
- Content:
-
snap_revision: str
: current revision of the installed snap. -
workload_version: str
: current version of the opensearch workload. -
state: UnitState
: current state of the upgraded/upgrading unit (healthy, restarting, upgrading, outdated)
-
- Relation endpoint:
-
- Relation endpoint:
peer-cluster-orchestrator
. - Content:
-
orchestrators: PeerClusterOrchestrators
: List of orchestrators the Main/Failover provider computed and broadcasted to all related applications. -
cluster_fleet_apps: PeerClusterFleetApps
: The aggregated list of all applications and their descriptions in this fleet (along with their planned units count etc..) -
data: PeerClusterRelData
: Success data set by the orchestrators / providers on the relation. -
error_data: PeerClusterRelErrorData
: Error data set by the orchestrators / providers on the relation.
-
- Relation endpoint:
-
- Relation endpoint:
peer-cluster
. - Content:
-
app: PeerClusterApp
: current detailed app to be reported to the orchestrators. -
is_candidate_failover_orchestrator: bool
: whether the current application can pretend to being elected as a failover orchestrator.
-
- Relation endpoint:
-
- Relation endpoint:
opensearch-client
- Content:
-
version: str
: OpenSearch version. -
index: str
: Index name requested by the client application. -
credentials: Dict[str, str] / {"username": "", "password": ""}
: user name and password created for the new established relation. -
tls-ca: str
: The ca-chain to be used for https by the client. -
endpoints: List[str]
: List of endpoints offered by the opensearch charm.
-
- Relation endpoint: