Resources / Incident

Incident

The only way the platform asks a person for help: opened by a controller when it has done what it is allowed to do or needs something only a person can give (spec 0047 section 6).

Overview

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

Minimal example

apiVersion: platform.etorm.com/v1alpha1
kind: Incident
metadata:
  name: example
spec:
  reason: "<reason>"
  needsHuman: Exhausted
  summary: "<summary>"

Spec

FieldTypeRequiredDefaultAllowedDescription
severitystring (one of)"Warning"Info, Warning, CriticalHow urgent it is.
reasonstringyesup to 63 charactersA word from the reason registry.
needsHumanstring (one of)yesExhausted, Spend, Bootstrap, Legal, UnsafeWhy a person is needed: a remediation budget is used up, money would be spent, a new trust anchor is needed, a legal matter, or an action outside the bounded list.
summarystringyesup to 512 charactersWhat happened, in a sentence.
subjectslist of objectup to 16 itemsThe objects involved.
subjects[].kindstringyesKind of the object.
subjects[].namestringyesName of the object.
subjects[].clusterstring"root"Its cluster.
subjects[].groupstringIts API group.
subjects[].versionstring"v1alpha1"Its API version.
subjects[].pluralstringIts plural resource name.
subjects[].conditionstring"Ready"The condition whose recovery resolves the incident.
labelsobjectLabels copied to the incident's metadata. `etorm.com/needs-code: "true"` marks a failure no listed action repaired: an agent or a person has to change code or desired state.
evidenceobject (free-form)What the opener knew: for a link chain, the Intent's chain with the last probe results, the attempts and per-action statistics.
acknowledgedbooleanfalseA person has seen it (set by a person).
resolvebooleanfalseA person says it is resolved (set by a person); the platform also resolves it when every subject has recovered.
notestringup to 1024 charactersA person's note.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestring (one of)Open, Acknowledged, ResolvedWhere it stands.
openedAtintegerUnix time it was opened.
resolvedAtintegerUnix time it was resolved.
resolvedBystringrecovered or the person who resolved it.
recoveredSinceintegerUnix time since when every subject has been ready again (it is resolved once that has lasted the settle time).
lastNotifiedAtintegerUnix time a person was last notified.
timelinelist of objectWhat happened, in order (at most 100 entries).
timeline[].atintegerUnix time.
timeline[].eventstringWhat happened.
conditionslist of objectReady (resolved) and Degraded (open).
conditions[].typestringCondition type.
conditions[].statusstringTrue, False or Unknown.

Columns in listings

ColumnFrom
Severity.spec.severity
Needs.spec.needsHuman
Phase.status.phase
Reason.spec.reason

All resources