lexicons and xrpc
lexicon
com.publicdomainrelay.temp.cluster.controlPlaneUp
The gateway brings the named cluster's control plane up: it flips the Cluster's desired state to running and materialises its process group and objects, in order. Idempotent and safe to retry - the call flips a declaration and the materialiser does the work. While the cluster is Initializing this method answers 429 with a Retry-After header, which client-go honours automatically; an implementation that retried forever instead would make that promise a lie. Refused once the cluster is Draining, because a process group must not be spawned into a running teardown order. Does NOT provision nodes - nodes are the automatic content-delta trigger's business.
input
| field | type | description |
|---|---|---|
name * | string | The cluster label, unique within the calling account. |
output
| field | type | description |
|---|---|---|
phase * | string | The cluster's phase as of this call. Initializing means the 429 is still in force. knownValues ["Unavailable","Initializing","Ready","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. |
IdentityRevoked | The caller's identity carries a deny record for this account. |
ClusterNotFound | This account has no cluster of that name. Deliberately indistinguishable from a name that belongs to another account. |
ClusterDraining | The cluster is being torn down and its desired state is frozen. Not retryable: a Draining cluster cannot be un-drained, by design - a cancellable teardown gate is a gate an operator clears to make the symptom go away. |
ClusterInitializing | The cluster is still coming up. RETRYABLE: carries Retry-After, and client-go retries on it without further instruction. |
ClusterUnavailable | 503: the gateway could not resolve the token issuer's signing key in time, or could not read the caller's deny record. 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/controlPlaneUp.json
{
"lexicon": 1,
"id": "com.publicdomainrelay.temp.cluster.controlPlaneUp",
"defs": {
"main": {
"type": "procedure",
"description": "The gateway brings the named cluster's control plane up: it flips the Cluster's desired state to running and materialises its process group and objects, in order. Idempotent and safe to retry - the call flips a declaration and the materialiser does the work. While the cluster is Initializing this method answers 429 with a Retry-After header, which client-go honours automatically; an implementation that retried forever instead would make that promise a lie. Refused once the cluster is Draining, because a process group must not be spawned into a running teardown order. Does NOT provision nodes - nodes are the automatic content-delta trigger's business.",
"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",
"Initializing",
"Ready",
"Draining"
],
"description": "The cluster's phase as of this call. Initializing means the 429 is still in force."
}
}
}
},
"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": "IdentityRevoked",
"description": "The caller's identity carries a deny record for this account."
},
{
"name": "ClusterNotFound",
"description": "This account has no cluster of that name. Deliberately indistinguishable from a name that belongs to another account."
},
{
"name": "ClusterDraining",
"description": "The cluster is being torn down and its desired state is frozen. Not retryable: a Draining cluster cannot be un-drained, by design - a cancellable teardown gate is a gate an operator clears to make the symptom go away."
},
{
"name": "ClusterInitializing",
"description": "The cluster is still coming up. RETRYABLE: carries Retry-After, and client-go retries on it without further instruction."
},
{
"name": "ClusterUnavailable",
"description": "503: the gateway could not resolve the token issuer's signing key in time, or could not read the caller's deny record. Retry."
},
{
"name": "InternalError",
"description": "500: a failure the gateway maps to no named error."
}
]
}
}
}