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
| API | platform.etorm.com/v1alpha1 |
| Resource | incidents (cluster-scoped inside its cluster) |
| Short names | inc |
| Available in | the platform and project clusters |
| Status | written 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
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
severity | string (one of) | "Warning" | Info, Warning, Critical | How urgent it is. | |
reason | string | yes | up to 63 characters | A word from the reason registry. | |
needsHuman | string (one of) | yes | Exhausted, Spend, Bootstrap, Legal, Unsafe | Why 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. | |
summary | string | yes | up to 512 characters | What happened, in a sentence. | |
subjects | list of object | up to 16 items | The objects involved. | ||
subjects[].kind | string | yes | Kind of the object. | ||
subjects[].name | string | yes | Name of the object. | ||
subjects[].cluster | string | "root" | Its cluster. | ||
subjects[].group | string | Its API group. | |||
subjects[].version | string | "v1alpha1" | Its API version. | ||
subjects[].plural | string | Its plural resource name. | |||
subjects[].condition | string | "Ready" | The condition whose recovery resolves the incident. | ||
labels | object | Labels 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. | |||
evidence | object (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. | |||
acknowledged | boolean | false | A person has seen it (set by a person). | ||
resolve | boolean | false | A person says it is resolved (set by a person); the platform also resolves it when every subject has recovered. | ||
note | string | up to 1024 characters | A person's note. |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
phase | string (one of) | Open, Acknowledged, Resolved | Where it stands. | ||
openedAt | integer | Unix time it was opened. | |||
resolvedAt | integer | Unix time it was resolved. | |||
resolvedBy | string | recovered or the person who resolved it. | |||
recoveredSince | integer | Unix time since when every subject has been ready again (it is resolved once that has lasted the settle time). | |||
lastNotifiedAt | integer | Unix time a person was last notified. | |||
timeline | list of object | What happened, in order (at most 100 entries). | |||
timeline[].at | integer | Unix time. | |||
timeline[].event | string | What happened. | |||
conditions | list of object | Ready (resolved) and Degraded (open). | |||
conditions[].type | string | Condition type. | |||
conditions[].status | string | True, False or Unknown. |
Columns in listings
| Column | From |
|---|---|
| Severity | .spec.severity |
| Needs | .spec.needsHuman |
| Phase | .status.phase |
| Reason | .spec.reason |