~ knotless Search/
↑↓ move↵ open⇧↵ all results
0
0
main
41 lines · 2.0 KB Raw History
{
  "lexicon": 1,
  "id": "com.publicdomainrelay.temp.cluster.controlPlaneDown",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Take the named cluster's control plane down: flip its desired state to not-running and dematerialise the process group. The store is RETAINED - the objects, the S3 prefix and the OpenBao path all survive, so a later controlPlaneUp resumes the same cluster. Idempotent: calling it on a cluster that is already down is a success. Ordering is load-bearing and belongs to the materialiser, not to the caller: phase goes Unavailable first, the tenant path is asserted shut, and only then is the process group reaped in reverse.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": ["name"],
          "properties": {
            "name": {
              "type": "string",
              "description": "The cluster label, unique within the calling account."
            }
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "properties": {
            "phase": {
              "type": "string",
              "knownValues": ["Unavailable", "Ready"],
              "description": "The phase the cluster is heading to. Unavailable means the teardown order has been accepted; it is asynchronous and this response does not wait for it."
            }
          }
        }
      },
      "errors": [
        { "name": "InvalidRequest", "description": "Name absent, or not a legal RFC-1123 label within 63 characters." },
        { "name": "Unauthorized", "description": "Missing or invalid service-auth token. Also returned when the token's aud is not this service or its lxm is not this method." },
        { "name": "ClusterNotFound", "description": "This account has no cluster of that name. Deliberately indistinguishable from a name that belongs to another account." }
      ]
    }
  }
}