Resources / ControllerPlacement

ControllerPlacement

How many instances of one of the platform's controllers must exist, on which classes of machine, and with which program. The placement controller creates the Compute processes, spreads them over distinct machines and replaces an instance whose machine or heartbeat is lost. Platform processes only.

Overview

APIplatform.etorm.com/v1alpha1
Resourcecontrollerplacements (cluster-scoped inside its cluster)
Short namescplace
Available inthe platform and project clusters
Statuswritten by a controller through /status

Minimal example

apiVersion: platform.etorm.com/v1alpha1
kind: ControllerPlacement
metadata:
  name: example
spec:
  controller: "<controller>"
  program:
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
controllerstringyeslength 1 to 63The controller this placement runs, for example cloud-operator (a DNS label; the processes are named after it).
programobjectyesThe Compute program every instance runs.
program.namestringyeslength 1 to 63Name of the program.
program.systembooleantrueTrue for a program of the platform (a system program).
replicasinteger22 to 8How many instances. At least two, on distinct machines, so that no controller is a single point of failure.
hostClasseslist of string["cloud-node"]up to 8 itemsThe classes of machine that may host an instance: cloud-node (an external-capacity node), or the class of a Host (lab, server, relay, node). A Host that is not steady is never a target.
configobjectSettings every instance reads by key (not secret).
secretslist of objectup to 32 itemsSecrets every instance may read (as the secrets of a Process, spec 0021).
secrets[].secretRefobjectyes
secrets[].secretRef.namestringyeslength 1 to 63Name of the secret.
secrets[].keyslist of stringup to 32 itemsOnly these keys; none: all.
secrets[].asobjectyesDelivery: host.
secrets[].as.hostobject
resourcesobject{}What each instance may use.
resources.memoryPowerinteger80 to 12Memory as a power of two of 64 KiB (8 is 16 MiB).
resources.cpuMillicoresinteger2001 to 1000Processor time on average, in thousandths of a core.
resources.maxCpuMillicoresinteger1 to 1000The most a remediation may raise the allowance to.
heartbeatSecondsinteger300300 to 3600The interval of an instance's heartbeat (the node host reports a process at least this often); an instance silent for three of them is replaced.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready (every instance placed and heard from) or Degraded.
runningintegerInstances placed and heard from.
instanceslist of objectOne entry per instance.
instances[].processstringThe Compute process.
instances[].hoststringThe machine it is placed on.
instances[].programstringThe program it runs.
instances[].lastSeenintegerUnix time of the last heartbeat of the machine that hosts it.
instances[].statestringPlaced, Starting, HeartbeatMissing or Unplaced.
conditionslist of objectDetailed state: Ready, and Degraded with HeartbeatMissing or NoCapacity.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Controller.spec.controller
Replicas.spec.replicas
Running.status.running
Phase.status.phase

All resources