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.

Sign up for GitHub

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

Jump to bottom

Update Readme with the optional retry CR parameters #121

Merged
merged 1 commit into from
Jan 17, 2024
Merged

Update Readme with the optional retry CR parameters #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,17 @@ 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` - fence-agent name
* `sharedparameters` - cluster wide parameters for executing the fence agent
* `nodeparameters` - node specific parameters for executing the fence agent
* `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".

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 All @@ -106,6 +116,9 @@ metadata:
name: worker-1
spec:
agent: fence_ipmilan
retrycount: 5
retryinterval: "5s"
timeout: "60s"
sharedparameters:
--username: "admin"
--password: "password"
Expand Down