Skip to content

Commit

Permalink
Update Readme with the optional retry CR parameters
Browse files Browse the repository at this point in the history
Signed-off-by: Carlo Lobrano <[email protected]>
  • Loading branch information
clobrano committed Jan 8, 2024
1 parent a34fe8c commit 20d985a
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,19 @@ FAR CRs are deleted by NHC after it sees the Node is healthy again.

#### Example CR

The FAR, `FenceAgentsRemediation`, CR is created by the admin 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 *nodeparameters* field to specify the parameters for the fenced node.
The FAR CR (CustomResource), created by the admin, is used to trigger the fence-agent on a specific node.

The CR includes the following parameters:
* `agent` - the fence-agent name
* `sharedparameters` - all the shared, not specific to a node, parameters
* `nodeparameters` - the parameters for the fenced node

Optionally, the CR can include further parameters to specify how the operator should retry the fence-agent command in case of failure:

* `.spec.retrycount` - the number of times to retry the fence-agent in case of failure. Default is 5.
* `.spec.retryinterval` - the interval between retries in seconds. Default is "5s".
* `.spec.timeout` - the timeout for the fence-agent in seconds. Default is "60s".

For better understanding please see the below example of FAR 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)):

```yaml
Expand Down

0 comments on commit 20d985a

Please sign in to comment.