Resources / Host

Host

One machine of the platform and what it must run. The agent on the machine starts on boot, reads this object and makes the machine match it: it starts what is missing, makes the gateway container carry its endpoint address and run the gateway agent, and joins the member containers to their VPCs. It reports what it found, and a coarse heartbeat.

Overview

APIplatform.etorm.com/v1alpha1
Resourcehosts (cluster-scoped inside its cluster)
Short nameshost
Available inthe platform only
Statuswritten by a controller through /status

Minimal example

apiVersion: platform.etorm.com/v1alpha1
kind: Host
metadata:
  name: example
spec: {}

Spec

FieldTypeRequiredDefaultAllowedDescription
classstring"lab"up to 63 charactersWhat kind of machine this is (lab, server, relay, node); placement uses it.
steadybooleanfalseWhether the machine is expected to be on all the time. A steady host that stops reporting is Unreachable.
heartbeatSecondsinteger600300 to 3600How often the agent writes its heartbeat when nothing else changed. Status is written when the observed state changes and at most this often otherwise, never on every pass. A host that missed three heartbeats is Unreachable.
agentArtifactobjectThe agent build the host should run (informational until self-update exists).
agentArtifact.namestringup to 63 charactersName of the artifact.
agentArtifact.versionstringup to 63 charactersVersion or digest.
workloadslist of objectup to 64 itemsThe containers the machine runs, in the order they are brought up (the gateway first).
workloads[].namestringyeslength 1 to 63The container's name.
workloads[].imagestringup to 255 charactersThe image it was made from (informational: the agent starts existing containers and does not make new ones).
workloads[].rolestring (one of)"other"gateway, member, othergateway: carries the Gateway's endpoint address and runs the gateway agent. member: joins a VPC from its Account. other: only kept running.
workloads[].gatewayobjectFor role gateway.
workloads[].gateway.namestringyeslength 1 to 63The Gateway this container is.
workloads[].gateway.serverstring"https://api.etorm.com"up to 255 charactersThe API the gateway agent talks to.
workloads[].gateway.dirstring"/tmp"up to 255 charactersThe directory in the container that holds the agent binary (etorm-v<N>), ca.pem, agent.token and gateway.key.
workloads[].memberobjectFor role member.
workloads[].member.projectstringyeslength 1 to 63The project whose Account carries this container's WireGuard key (/tmp/key in the container; the Account is found by the key).

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready (everything the host should run runs and the members are connected), Degraded (something is missing or not connected) or Unreachable (set by the platform when the heartbeat stops).
observedobjectWhat the agent found at its last change, without anything that changes on every pass (no handshake ages or counters).
observed.containerslist of objectOne entry per workload.
observed.containers[].namestringThe container.
observed.containers[].statestringrunning, stopped or missing.
observed.containers[].detailstringFor a member, connected or what is wrong; for the gateway, whether the endpoint address and the agent are in place.
heartbeatobjectWhen the agent last wrote this status. Coarse, at most every spec.heartbeatSeconds.
heartbeat.atstringRFC 3339.
heartbeat.unixintegerThe same in Unix seconds.
conditionslist of objectReady, and Degraded with the reason (Missing, NotConnected, NoAccount, AgentNotRunning).
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Class.spec.class
Phase.status.phase
Heartbeat.status.heartbeat.at

All resources