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

APIintelligence.etorm.com/v1alpha1
Resourceremediationproposals (cluster-scoped inside its cluster)
Short namesremprop
Available inproject clusters only
Statuswritten 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

FieldTypeRequiredDefaultAllowedDescription
swarmRefreference to SwarmyesThe swarm that proposes.
incidentRefstringup to 63 charactersThe Incident it answers, when there is one.
kindstring (one of)yesAction, PolicyAction: run one bounded action once. Policy: add a remediation policy.
targetobjectyesThe object the action is for.
target.clusterstring"platform"up to 63 charactersIts cluster (only platform).
target.groupstringyesup to 253 charactersIts API group.
target.versionstring"v1alpha1"up to 20 charactersIts API version.
target.pluralstringyesup to 63 charactersIts plural resource name.
target.namestringyeslength 1 to 63Its name.
whenobjectThe condition the proposal answers; it must hold on the target when the proposal is looked at.
when.typestringup to 63 charactersCondition type, for example Ready.
when.statusstring (one of)True, False, UnknownThe condition's status.
when.reasonstringup to 63 charactersOptionally, the reason.
actionobjectThe bounded action (for kind Action).
action.typestring (one of)RollbackRelease, ReplaceNode, FailoverDNS, RestartPlacement, RerunBootstrapRequest, RotateNow, RederiveListenerTarget, RestartProcess, RaiseFuel, ReplaceGitProcess, RestoreIngressAffinity, RestartLogShipperOne of the platform's bounded actions.
action.paramsobject (free-form)What the action needs (for example the component of a rollback).
policyobject (free-form)For kind Policy: the Remediation spec suggested.
rationalestringyeslength 1 to 2000Why: the diagnosis. Data for the reader, not an instruction.
decisionobjectA person's (or, for a policy, a reviewer's) decision.
decision.statestring (one of)Approved, RejectedApprove or reject.
decision.reasonstringup to 1000 charactersWhy, for the record.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringProposed, AwaitingApproval, Planned, Executing, Succeeded, Failed, Rejected or Expired.
riskstringlow or high.
messagestringWhat happened last.
remediationRefobjectThe Remediation made for this proposal.
remediationRef.namestringName of the Remediation.
attemptslist of stringOutcomes of the remediation's attempts, oldest first.
decidedBystringWho decided (set by the platform).
conditionslist of objectDetailed state.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Kind.spec.kind
Action.spec.action.type
Target.spec.target.name
Risk.status.risk
Phase.status.phase

All resources