Lexicon Garden

at.happyproto.admin.defs

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · defs
Kinddefs
Authorityadmin.happyproto.at
Indexed
Compare Edit in builder → Fork →

#autoscale

object

The autoscaler's settings and what it is waiting on.

Properties

blockedBy

string

A failed request that holds off new ones until staff retry or cancel it.

cooldownUntil

string · datetime

No new request before this. Absent once it has passed.

costEur

string

What each host it orders costs a month, in euros, as a decimal string.

current

requiredref
Reference

enabled

requiredboolean

On in the provisioner's config, with the GitHub App set up.

hosts

integer

Hosts that are not retired.

inFlight

integer

Requests under way: 0 or 1.

lowSince

string · datetime

Since when free capacity has been below a threshold. Absent while it is fine.

maxHosts

integer

The most hosts it may bring the fleet to.

paused

requiredboolean

Paused by staff: no new requests, though one under way carries on.

pausedAt

string · datetime

pausedBy

string · did

The staff DID that paused it.

thresholds

ref
Reference

#encryptionKey

object

An instance's encryption key and where it is in a rotation.

Properties

blockedBy

string

Why a rotation cannot start now, when it cannot: the code rotateEncryptionKey would refuse with.

  • knownValues: OperationInProgress | RotationInProgress | InstanceStopped | NotLive | RotationUnsupported | AgentUnreachable | NotSettled

canRotate

requiredboolean

Whether a rotation can start now.

failure

ref

The instance's latest operation, when it failed and the instance with it. Any kind: a KeyMismatch can fail an update or an upgrade too.

Reference

operation

ref

The rotate_key or retire_key operation in progress, if any.

Reference

rotatedAt

string · datetime

When the current key became current. Absent for the key the instance was created with.

sealing

ref

Only while sealing, and only when the instance's host answered.

Reference

stage

requiredstring

none: one key. rotating: a new key is made but not live yet. sealing: it is live and HappyView is re-sealing what the old key sealed. retiring: the old key is being removed. failed: the instance is failed and its latest operation is a failed rotate_key or retire_key; retrying the instance sends its keys again.

  • knownValues: none | rotating | sealing | retiring | failed

#event

object

One line of a request's timeline.

Properties

at

requiredstring · datetime

kind

requiredstring
  • knownValues: requested | dispatched | step_started | step_finished | ordering | configuring | verifying | registered | failed | cancelled | retried | cancel_requested | deploy_cancelled

message

string

What happened, in the provisioner's words.

runUrl

string · uri

The GitHub Actions run the event came from.

#freeCapacity

object

Free capacity across the active hosts. An over-committed host counts as none.

Properties

freeDiskGb

integer

freeMemoryMb

integer

#hostRequest

object

A tenant host the autoscaler asked for.

Properties

cancelRunUrl

string · uri

costEur

string

The host's monthly cost in euros, as a decimal string.

createdAt

requiredstring · datetime

currentStep

string

The workflow step running now.

deployRunUrl

string · uri

dispatchedAt

string · datetime

error

string

Why it failed.

events

array

Oldest first. Only on a single request.

itemsref
Reference

finishedAt

string · datetime

id

requiredstring

A UUID.

name

requiredstring

The host's name, like tenant-4.

requestedBy

string

system, or the staff DID.

state

requiredstring
  • knownValues: requested | ordering | configuring | verifying | registered | failed | cancelling | cancelled

trigger

ref
Reference

updatedAt

string · datetime

workflowRunUrl

string · uri

#keyFailure

object

Properties

errorCode

string

The provisioner's error code. KeyMismatch: the host refused an apply that would drop the key the instance seals with. It needs an operator, not a retry.

  • knownValues: KeyMismatch

kind

requiredstring

The operation's kind, as on #operation.

operationId

requiredstring

#sealing

object

Properties

previousKeyLive

requiredboolean

Whether the instance runs with both keys. False when its rotate_key has not reached it, for instance because it failed: then remaining reads 0 without anything being re-sealed, and retrying the instance sends both keys again.

remaining

requiredinteger

Values only the old key opens. The old key is retired once this reaches 0.

  • minimum: 0

unreadable

requiredinteger

Values neither key opens. They were unreadable before the rotation, too.

  • minimum: 0

#thresholds

object

When the autoscaler orders a host: free capacity across active hosts below either figure for sustainSecs, and no request in the last cooldownSecs.

Properties

cooldownSecs

integer

freeDiskGb

integer

freeMemoryMb

integer

sustainSecs

integer

#trigger

object

Free capacity when the request was made, and the thresholds it was below.

Properties

freeDiskGb

integer

freeMemoryMb

integer

hosts

array
itemsref
Reference

lowSince

string · datetime

thresholds

ref
Reference

#triggerHost

object

Properties

freeDiskGb

integer

freeMemoryMb

integer

name

string

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.happyproto.admin.getAutoscale

    query

    The autoscaler: on or paused, how many hosts it may add, what it is waiting on, and free capacity against its thresholds. Staff only.