diff --git a/README.md b/README.md index f1e21eb8..0653a967 100644 --- a/README.md +++ b/README.md @@ -192,9 +192,9 @@ The CR includes the following parameters: * `retrycount` - number of times to retry the fence agent in case of failure. The default is 5. * `retryinterval` - interval between retries in seconds. The default is "5s". * `timeout` - timeout for the fence agent in seconds. The default is "60s". -* `remediationStrategy` - either `ResourceDeletion` or `OutOfServiceTaint`: - * `ResourceDeletion`: This remediation strategy removes the pods on the node. - * `OutOfServiceTaint`: This remediation strategy implicitly causes the removal of the pods and associated volume attachments on the node. It achieves this by placing the [`OutOfServiceTaint` taint](https://kubernetes.io/docs/reference/labels-annotations-taints/#node-kubernetes-io-out-of-service) on the node. +* `remediationStrategy` - either `OutOfServiceTaint` or `ResourceDeletion`: + * `OutOfServiceTaint`: This remediation strategy implicitly causes the deletion of the pods and the detachment of the associated volumes on the node. It achieves this by placing the [`OutOfServiceTaint` taint](https://kubernetes.io/docs/reference/labels-annotations-taints/#node-kubernetes-io-out-of-service) on the node. + * `ResourceDeletion`: This remediation strategy deletes the pods on the node. The FenceAgentsRemediation CR is created by the administrator and is used to trigger the fence agent on a specific node. The CR includes an *agent* field for the fence agent name, *sharedparameters* field with all the shared, not specific to a node, parameters, and a *nodeparameters* field to specify the parameters for the fenced node. For better understanding please see the below example of FenceAgentsRemediation CR for node `worker-1` (see it also as the [sample FAR](https://github.com/medik8s/fence-agents-remediation/blob/main/config/samples/fence-agents-remediation_v1alpha1_fenceagentsremediation.yaml)):