Home / Keptn v1 Docs / Release 0.18.x / Reference / Configurations / remediation
The remediation configuration describes a remediation workflow
that is called by a remediation
sequence in the project’s shipyard configuration.
It defines what needs to be done but leaves the details to other components.
apiVersion
:
Must be set to spec.keptn.sh/0.1.4
kind
:
Must be set to Remediation
metadata
: name
:
Unique name for this remediation configuration.
Typically, this is a string that defines the service with which this remediation is associated,
followed by a dash and remediation
.
remediations
:
Definitions of the problems this service can identify
and the corrective action to take for each problem.
A remediation is configured based on two properties:
problemType
: Maps a problem to a remediation that matches a problem title
defined in the Action-Provider.
One remediation can declare multiple problem types.
The default
problem type is supported to trigger a remediation for an unknown problem.
actionsOnOpen
: Declares a list of actions triggered in course of the remediation.
action
– specifies a unique name that matches a definition for the
Action Provider (Keptn-service/)
that executes the actiondescription
– provides more details about the actionvalue
– property allows adding an arbitrary list of values for configuring the actionIf multiple actions are declared, Keptn sends out events in sequential order.
The following example shows a remediation configured for the problem types
Response time degradation
and Failure rate increase
as well as the default
problem type that is used for any unknown problem:
To add a remediation config to a service, use the keptn add-resource command:
For this command:
resourceUri
argument must be set to remediation.yaml
.project
argument must match the value of the argument to the metadata
/name
field
in the shipyard configuration.stage
argument must match the name assigned to the appropriate stage in the
shipyard configuration.