API Reference

struct ClusterDiscover {
  /// ID of the discovered cluster.
  cluster_id: String,

  /// List of all the nodes in the cluster
  nodes: List<ClusterDiscoveryNode>,
}

struct ClusterDiscoveryNode {
  /// Address to connect to the node’s agent service.
  agent_address: String,

  /// Platform defined ID on the node.
  node_id: String,
}

struct ClusterDiscoverResponse {
  /// List of clusters on the platform.
  clusters: List<ClusterDiscover>,
}

struct NodeProvisionRequest {
  /// Attributes about the cluster the node should be provisioned in.
  cluster: {
    /// Additional attributes attached to all nodes in the cluster.
    /// These attributes can be used by the Platform to customise nodes in the cluster.
    attributes: Map<String, JSON>,

    /// ID of the cluster to add the node to.
    cluster_id: String,

    /// Software for the store to provision (i.e, mongodb, zookeeper, ...).
    store: String,

    /// Version string for store nodes.
    store_version: String,

    /// Map of node group configurations.
    /// A cluster can be composed of differently configured nodes.
    nodes: {
      [node_group_id]: {
        /// Additional attributes for nodes in this group.
        /// Extends `cluster.attributes` or override values with the same key.
        attributes: Map<String, JSON>,

        /// Number of overall desired nodes for this group.
        desired_count: u32,

        /// Platform specific class of node to provision (such as instance type).
        /// If a platform does not support node types this can be anything.
        node_class: String,

        /// Version string for store nodes in this group, defaults to `cluster.store_version`.
        version: Option<String>
      }
    }
  },

  /// Node provisioning information.
  provision: {
    /// ID of the node group to provision.
    node_group_id: String,
  }
}

struct NodeProvisionResponse {
  /// Number of nodes being provisioned by this request.
  count: u32,

  /// If available, the Platform can return a list of node IDs being provisioned.
  node_ids: Option<List<String>>,
}

struct NodeDeprovisionRequest {
  /// ID of the cluster the node should be a member of.
  cluster_id: String,

  /// ID of the node to deprovision.
  node_id: String,
}