mode | string (one of) | | "plan" | plan, apply | plan records what would be done and does nothing; apply performs the action. A policy starts in plan. |
when | object | yes | | | Which objects and which condition trigger the action. |
when.group | string | yes | | | API group of the watched kind. |
when.version | string | yes | | | API version. |
when.plural | string | yes | | | Plural resource name of the watched kind. |
when.cluster | string | | "root" | | Logical cluster to look in (default root). |
when.condition | object | yes | | | The condition that must hold. |
when.condition.type | string | yes | | | Condition type, for example Ready. |
when.condition.status | string (one of) | yes | | True, False, Unknown | The status the condition must have. |
when.condition.reason | string | | | | If set, the condition must also have this reason (for example OutOfFuel). |
when.forSeconds | integer | | 120 | at least 0 | For how long it must have held (since its last transition). |
when.failingLink | string | | | up to 63 characters | For an Intent target: act only while this link of its chain is the failing one (status.failingLink). Empty means any. |
when.name | string | | | up to 63 characters | If set, only the object of this name (a one-off action for one object, such as one an agent proposed). |
when.invariant | string | | | up to 63 characters | If set, the targets are the objects the named Invariant (same cluster as the policy) lists as violating, of this kind, instead of objects that hold a condition: the action runs on the violators under this policy's budget, backoff and cooldown (spec 0047 section 6.4). The condition is then not read. |
when.labels | object | | | | If set, only objects that carry every one of these labels (for example the Git processes of Forge, whatever their names). |
action | object | yes | | | The one bounded action. The list is closed: a new action needs a spec change. |
action.type | string (one of) | yes | | RollbackRelease, RedeployComponent, ResetDurableObject, ApplyDeclared, ReplaceNode, FailoverDNS, RestartPlacement, RerunBootstrapRequest, RotateNow, RederiveListenerTarget, RestartProcess, RaiseFuel, ReplaceGitProcess, RestoreIngressAffinity, RestartLogShipper, ScaleOut | Which action. |
action.params | object (free-form) | | | | Parameters the action's owner defines. |
budget | object | | | | At most this many executions per target in the window. |
budget.max | integer | | 2 | at least 1 | Executions allowed. |
budget.windowSeconds | integer | | 3600 | at least 60 | The window. |
backoff | object | | | | The wait after a failed attempt grows by the factor up to the maximum. |
backoff.initialSeconds | integer | | 60 | at least 1 | The first wait. |
backoff.factor | number | | 2 | at least 1 | Growth per consecutive failure. |
backoff.maxSeconds | integer | | 1800 | at least 1 | The longest wait. |
cooldownSeconds | integer | | 600 | at least 0 | No other action on the same target for this long after one. |
afterPolicy | object | | | | Escalation order: this policy acts on a target only after the named policy has used its whole budget on that target and its attempts have finished. The incident for an exhausted budget is opened by the last policy of the chain, not by the ones that escalate. |
afterPolicy.name | string | yes | | up to 63 characters | The policy this one follows. |