Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs with the new remediationStrategy spec #145

Merged
merged 7 commits into from
May 22, 2024
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,10 +152,18 @@ metadata:
name: fenceagentsremediationtemplate-default
namespace: default
spec:
template: {}
template:
spec:
remediationStrategy: <remediation_strategy>
```

> *Note*: FenceAgentsRemediationTemplate CR must be created in the same namespace that the FAR operator has been installed.

The `.spec.template.spec.remediation_strategy` field can either be `ResourceDeletion` or `OutOfServiceTaint`:
clobrano marked this conversation as resolved.
Show resolved Hide resolved

- `ResourceDeletion`: This remediation strategy removes the pods on the node, rather than the removal of the node object. This strategy recovers workloads faster.
clobrano marked this conversation as resolved.
Show resolved Hide resolved
- `OutOfServiceTaint`: This remediation strategy implicitly causes the removal of the pods and associated volume attachments on the node, rather than the removal of the node object. It achieves this by placing the `OutOfServiceTaint` taint on the node. The `OutOfServiceTaint` strategy also represents a non-graceful node shutdown. A non-graceful node shutdown occurs when a node is shutdown and not detected, instead of triggering an in-operating system shutdown.
razo7 marked this conversation as resolved.
Show resolved Hide resolved


Configuring NodeHealthCheck to use the example `fenceagentsremediationtemplate-default` template above.

Expand Down