lexicons and xrpc
lexicon
com.publicdomainrelay.temp.cluster.controlPlaneDown
The gateway takes the named cluster's control plane down: it flips its desired state to not-running and dematerialises 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
| field | type | description |
|---|---|---|
name * | string | The cluster label, unique within the calling account. |
output
| field | type | description |
|---|---|---|
phase * | string | The cluster's status phase as read right after the not-running spec is written. The teardown is asynchronous and this response does not wait for it, so the phase is often still the one before (Ready); Unavailable once the materialiser has taken it down. knownValues ["Unavailable","Ready","Initializing","Draining"] |
errors
| error | description |
|---|---|
InvalidRequest | Name absent, or not a legal RFC-1123 label within 63 characters. |
Unauthorized | Missing or invalid service-auth token. Also returned when the token's aud is not this service or its lxm is not this method. |
ClusterNotFound | This account has no cluster of that name. Deliberately indistinguishable from a name that belongs to another account. |
ClusterUnavailable | 503: the gateway could not resolve the token issuer's signing key in time. Retry. |
InternalError | 500: a failure the gateway maps to no named error. |
used in
no page of these docs names it yet.
raw schema: lexicons/com/publicdomainrelay/temp/cluster/controlPlaneDown.json
{
"lexicon": 1,
"id": "com.publicdomainrelay.temp.cluster.controlPlaneDown",
"defs": {
"main": {
"type": "procedure",
"description": "The gateway takes the named cluster's control plane down: it flips its desired state to not-running and dematerialises 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",
"required": [
"phase"
],
"properties": {
"phase": {
"type": "string",
"knownValues": [
"Unavailable",
"Ready",
"Initializing",
"Draining"
],
"description": "The cluster's status phase as read right after the not-running spec is written. The teardown is asynchronous and this response does not wait for it, so the phase is often still the one before (Ready); Unavailable once the materialiser has taken it down."
}
}
}
},
"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."
},
{
"name": "ClusterUnavailable",
"description": "503: the gateway could not resolve the token issuer's signing key in time. Retry."
},
{
"name": "InternalError",
"description": "500: a failure the gateway maps to no named error."
}
]
}
}
}