Skip to content

Commit 5fca520

Browse files
committed
Documentation for updated remediation templates
1 parent b4ad670 commit 5fca520

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

modules/eco-configuring-machine-health-check-with-self-node-remediation.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,10 @@ metadata:
2828
name: selfnoderemediationtemplate-sample
2929
spec:
3030
template:
31-
spec: {}
31+
spec:
32+
remediationStrategy: ResourceDeletion <1>
3233
----
34+
<1> Specifies the remediation strategy. The default strategy is `ResourceDeletion`.
3335

3436
.. To create the `SelfNodeRemediationTemplate` CR, run the following command:
3537
+

modules/eco-self-node-remediation-operator-about.adoc

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,16 @@ If a watchdog device is unavailable, the `SelfNodeRemediationConfig` CR uses a s
5555
[id="understanding-self-node-remediation-remediation-template-config_{context}"]
5656
== Understanding the Self Node Remediation Template configuration
5757

58-
The Self Node Remediation Operator also creates the `SelfNodeRemediationTemplate` CR with the name `self-node-remediation-default-template` in the Self Node Remediation Operator's namespace. This CR defines the remediation strategy for the nodes.
58+
The Self Node Remediation Operator also creates the `SelfNodeRemediationTemplate` Custom Resource Definition (CRD). This CRD defines the remediation strategy for the nodes. The following remediation strategies are available:
5959

60-
The default remediation strategy is `NodeDeletion` that removes the `node` object.
61-
In {product-title} 4.10, the Self Node Remediation Operator introduced a new remediation strategy called `ResourceDeletion`. The `ResourceDeletion` remediation strategy removes the pods and associated volume attachments on the node rather than the `node` object. This strategy helps to recover workloads faster.
60+
`ResourceDeletion`:: This remediation strategy removes the pods and associated volume attachments on the node rather than the node object. This strategy helps to recover workloads faster. `ResourceDeletion` is the default remediation strategy.
61+
62+
`NodeDeletion`:: This remediation strategy removes the node object.
63+
64+
The Self Node Remediation Operator creates the following `SelfNodeRemediationTemplate` CRs for each strategy:
65+
66+
* `self-node-remediation-resource-deletion-template`, which the `ResourceDeletion` remediation strategy uses
67+
* `self-node-remediation-node-deletion-template`, which the `NodeDeletion` remediation strategy uses
6268

6369
The `SelfNodeRemediationTemplate` CR resembles the following YAML file:
6470

@@ -67,15 +73,13 @@ The `SelfNodeRemediationTemplate` CR resembles the following YAML file:
6773
apiVersion: self-node-remediation.medik8s.io/v1alpha1
6874
kind: SelfNodeRemediationTemplate
6975
metadata:
70-
creationTimestamp: "2022-03-02T08:02:40Z"
71-
generation: 1
72-
name: self-node-remediation-default-template
73-
namespace: openshift-operators
74-
resourceVersion: "596469"
75-
uid: 5d29e437-c485-48fa-ba9e-0354649afd31
76-
spec:
77-
template:
76+
creationTimestamp: "2022-03-02T08:02:40Z"
77+
name: self-node-remediation-<remediation_object>-deletion-template <1>
78+
namespace: openshift-operators
7879
spec:
79-
remediationStrategy: NodeDeletion <1>
80+
template:
81+
spec:
82+
remediationStrategy: <remediation_strategy> <2>
8083
----
81-
<1> Specifies the remediation strategy. The default remediation strategy is `NodeDeletion`.
84+
<1> Specifies the type of remediation template based on the remediation strategy. Replace `<remediation_object>` with either `resource` or `node`, for example, `self-node-remediation-resource-deletion-template`.
85+
<2> Specifies the remediation strategy. The remediation strategy can either be `ResourceDeletion` or `NodeDeletion`.

0 commit comments

Comments
 (0)