Development Stable

Overview

Agents Specification

Platforms Specification

Attributes and Behaviours

Alpha state disclaimer

The specification defined below is in early development cycle and is subject to (potentially breaking) change.

Attributes

There are currently no attributes defined for Platforms. This section exists as a placeholder in case attributes are added in the future.

Behaviours

Behaviours are actions we can request of Platforms as well as activities it performs either in response to commands or automatically.

BehaviourDescription
Cluster Discovery

The Platform MUST enumerate all existing nodes, grouped by Cluster they below to.

For each cluster, the Platform MUST return:

  • The Cluster ID.
  • For all existing nodes in the cluster (regardless of “node health”):
    • The Node ID.
    • The network address to connect to the Data Store Agent.
Node Provisioning

The Platform MUST support provisioning of nodes.

Node provisioning is requested with information of the node(s) to provision. The information provided to the Platform is detailed in the API reference.

The Platform MUST uses the information to provision the node(s) but how this information is used is up to the implementation.
Node Deprovisioning

The Platform MUST support deprovisioning (terminating) nodes that it provisioned.

The deprovisioned node MUST NOT be replaced automatically and MUST not appear in the Cluster Discovery output once deprovisioning is complete.