Resources / RemediationProposal
RemediationProposal
An agent's proposal to change the platform: one of the platform's bounded remediation actions on one object, or a new remediation policy. An agent never acts itself: an approved proposal becomes a Remediation that the platform's own controller runs with its budgets and records.
Overview
| API | intelligence.etorm.com/v1alpha1 |
| Resource | remediationproposals (cluster-scoped inside its cluster) |
| Short names | remprop |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: intelligence.etorm.com/v1alpha1
kind: RemediationProposal
metadata:
name: example
spec:
swarmRef:
name: "<name>"
kind: Action
target:
group: "<group>"
plural: "<plural>"
name: "<name>"
rationale: "<rationale>"
Spec
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
swarmRef | reference to Swarm | yes | The swarm that proposes. | ||
incidentRef | string | up to 63 characters | The Incident it answers, when there is one. | ||
kind | string (one of) | yes | Action, Policy | Action: run one bounded action once. Policy: add a remediation policy. | |
target | object | yes | The object the action is for. | ||
target.cluster | string | "platform" | up to 63 characters | Its cluster (only platform). | |
target.group | string | yes | up to 253 characters | Its API group. | |
target.version | string | "v1alpha1" | up to 20 characters | Its API version. | |
target.plural | string | yes | up to 63 characters | Its plural resource name. | |
target.name | string | yes | length 1 to 63 | Its name. | |
when | object | The condition the proposal answers; it must hold on the target when the proposal is looked at. | |||
when.type | string | up to 63 characters | Condition type, for example Ready. | ||
when.status | string (one of) | True, False, Unknown | The condition's status. | ||
when.reason | string | up to 63 characters | Optionally, the reason. | ||
action | object | The bounded action (for kind Action). | |||
action.type | string (one of) | RollbackRelease, ReplaceNode, FailoverDNS, RestartPlacement, RerunBootstrapRequest, RotateNow, RederiveListenerTarget, RestartProcess, RaiseFuel, ReplaceGitProcess, RestoreIngressAffinity, RestartLogShipper | One of the platform's bounded actions. | ||
action.params | object (free-form) | What the action needs (for example the component of a rollback). | |||
policy | object (free-form) | For kind Policy: the Remediation spec suggested. | |||
rationale | string | yes | length 1 to 2000 | Why: the diagnosis. Data for the reader, not an instruction. | |
decision | object | A person's (or, for a policy, a reviewer's) decision. | |||
decision.state | string (one of) | Approved, Rejected | Approve or reject. | ||
decision.reason | string | up to 1000 characters | Why, for the record. |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
phase | string | Proposed, AwaitingApproval, Planned, Executing, Succeeded, Failed, Rejected or Expired. | |||
risk | string | low or high. | |||
message | string | What happened last. | |||
remediationRef | object | The Remediation made for this proposal. | |||
remediationRef.name | string | Name of the Remediation. | |||
attempts | list of string | Outcomes of the remediation's attempts, oldest first. | |||
decidedBy | string | Who decided (set by the platform). | |||
conditions | list of object | Detailed state. | |||
conditions[].type | string | Aspect. | |||
conditions[].status | string | True or False. | |||
conditions[].reason | string | Machine-readable reason. | |||
conditions[].message | string | Human-readable detail. |
Columns in listings
| Column | From |
|---|---|
| Kind | .spec.kind |
| Action | .spec.action.type |
| Target | .spec.target.name |
| Risk | .status.risk |
| Phase | .status.phase |