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 CSV description #79

Merged
merged 8 commits into from
Jan 30, 2024
Merged

Update CSV description #79

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
77b06e6
Update CSV short description
razo7 Sep 19, 2023
f92bf19
Update CSV description
razo7 Sep 20, 2023
6272d9c
Update CSV URL
razo7 Sep 20, 2023
79a4891
Correct FAR remediation resolution as not automatic and not providing HA
razo7 Sep 26, 2023
6b56bb9
Better phrasing for workload availability
razo7 Oct 4, 2023
7d46860
Reconstruct FAR description and fix links
razo7 Jan 24, 2024
ac4ed81
Use medik8s.io description plus Compatability section and fix tyops
razo7 Jan 25, 2024
88b1135
Typo fix
razo7 Jan 28, 2024
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
33 changes: 22 additions & 11 deletions bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,10 @@ metadata:
categories: OpenShift Optional
containerImage: ""
createdAt: ""
description: Fence Agents Remediation Operator for remediating nodes using upstream
fence-agents.
description: Fence Agents Remediation Operator uses well-known agents to fence
and remediate unhealthy nodes. In this process it can minimize downtime for
stateful applications, restores compute capacity if transient failures occur,
and increases the availability of workloads.
olm.skipRange: '>=0.0.1'
operators.operatorframework.io/builder: operator-sdk-v1.30.0
operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
Expand Down Expand Up @@ -117,13 +119,22 @@ spec:
displayName: Shared Parameters
path: template.spec.sharedparameters
version: v1alpha1
description: "Fence Agents Remediation Operator (FAR)\n\nThe operator will remediate/fence
a node when a FenceAgentsRemediation (far) custom resource exists with the node's
name.\nFAR uses an existing set of upstream fencing agents for environments with
a \ntraditional API end-point (e.g., IPMI) for power cycling cluster nodes.\n\nThe
operator is recommended to be used with Node Healthcheck Operator for easier and
smoother experience,\nbut it can also work as a standalonde remediator for the
more advanced user.\n"
description: |
Fence Agents Remediation (*FAR*) is a Kubernetes operator that *fence* and remediate unhealthy to healthy nodes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typos
"fence" -> "fences"
"remediate" -> "remediates"

Using a traditional Application Programming Interface (API) FAR runs uses well-known fence agents to remediate a node from an unhealthy state by power cycling the node,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: either runs or uses

and afterwards it delets the node's resources.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: delets -> deletes

By doing so, FAR can minimize downtime for stateful applications, restores compute capacity if transient failures occur, and increases the availability of workloads.
Copy link
Contributor

@clobrano clobrano Jan 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is incorrect. The sentence begins with "FAR can..." so all the other verbs shouldn't use the third form present tense (FAR can minimize, can restore, can increase).
Maybe, you could just remove the first "can" and begin with "FAR minimizes..."?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence begins with "FAR can..." so all the other verbs shouldn't use the third form present tense (FAR can minimize, can restore, can increase).

The can is intended as a best effort from FAR, I will just use V1 of the verbs.


FAR is one of the remediator operators by [Medik8s](https://www.medik8s.io/remediation/remediation/),
such as [Self Node Remediation](https://github.com/medik8s/self-node-remediation) and [Machine Deletion Remediation](https://github.com/medik8s/machine-deletion-remediation),
that were designed to run with the Node HealthCheck Operator [(NHC)](https://github.com/medik8s/node-healthcheck-operator) which detects an unhealthy node and creates remediation CR.
It is recommended to use FAR with NHC for an easier and smoother experience by fully automate the remediation process, but it can be used as a standalone remediator for the more experienced user.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/automate/automating


FAR is recommended when a node becomes unhealthy, and we want to completely fence/isolate the node from a cluster, since we can not “trust” the unhealthy node,
to prevent it from accessing the shared resources like [RWO volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes).
Moreover, FAR is *robust* as it can remediate an unhealthy node using a traditional API (e.g., IPMI) while still keeping control plane connectivity,
Copy link
Contributor

@clobrano clobrano Jan 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what you mean by "traditional API" 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As regular/known API. But maybe the traditional isn't useful here.

and it is *diverse* since it includes [numerous fence agents](https://github.com/ClusterLabs/fence-agents) to choose from.
Each one of these agents is designed for different types of clusters, such as bare metal servers, virtual machines, cloud platforms, etc.
displayName: Fence Agents Remediation Operator
icon:
- base64data: base64EncodedIcon
Expand Down Expand Up @@ -352,9 +363,9 @@ spec:
- baremetal
links:
- name: Fence Agents Remediation
url: https://medik8s.io
url: https://www.medik8s.io/remediation/fence-agents-remediation/fence-agents-remediation/
- name: Source Code
url: https://github.com/medik8s/fence-agents-remediation
url: https://www.github.com/medik8s/fence-agents-remediation
maintainers:
- email: [email protected]
name: Medik8s Team
Expand Down
33 changes: 22 additions & 11 deletions config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ metadata:
categories: OpenShift Optional
containerImage: ""
createdAt: ""
description: Fence Agents Remediation Operator for remediating nodes using upstream
fence-agents.
description: Fence Agents Remediation Operator uses well-known agents to fence
and remediate unhealthy nodes. In this process it can minimize downtime for
stateful applications, restores compute capacity if transient failures occur,
and increases the availability of workloads.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: "availability" sounds like uncountable to me, so I'd say "improve", more than "increase"

olm.skipRange: '>=0.0.1'
repository: https://github.com/medik8s/fence-agents-remediation
support: Medik8s
Expand Down Expand Up @@ -76,13 +78,22 @@ spec:
displayName: Shared Parameters
path: template.spec.sharedparameters
version: v1alpha1
description: "Fence Agents Remediation Operator (FAR)\n\nThe operator will remediate/fence
a node when a FenceAgentsRemediation (far) custom resource exists with the node's
name.\nFAR uses an existing set of upstream fencing agents for environments with
a \ntraditional API end-point (e.g., IPMI) for power cycling cluster nodes.\n\nThe
operator is recommended to be used with Node Healthcheck Operator for easier and
smoother experience,\nbut it can also work as a standalonde remediator for the
more advanced user.\n"
description: |
Fence Agents Remediation (*FAR*) is a Kubernetes operator that *fence* and remediate unhealthy to healthy nodes.
Using a traditional Application Programming Interface (API) FAR runs uses well-known fence agents to remediate a node from an unhealthy state by power cycling the node,
and afterwards it delets the node's resources.
By doing so, FAR can minimize downtime for stateful applications, restores compute capacity if transient failures occur, and increases the availability of workloads.

FAR is one of the remediator operators by [Medik8s](https://www.medik8s.io/remediation/remediation/),
such as [Self Node Remediation](https://github.com/medik8s/self-node-remediation) and [Machine Deletion Remediation](https://github.com/medik8s/machine-deletion-remediation),
that were designed to run with the Node HealthCheck Operator [(NHC)](https://github.com/medik8s/node-healthcheck-operator) which detects an unhealthy node and creates remediation CR.
It is recommended to use FAR with NHC for an easier and smoother experience by fully automate the remediation process, but it can be used as a standalone remediator for the more experienced user.

FAR is recommended when a node becomes unhealthy, and we want to completely fence/isolate the node from a cluster, since we can not “trust” the unhealthy node,
to prevent it from accessing the shared resources like [RWO volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes).
Moreover, FAR is *robust* as it can remediate an unhealthy node using a traditional API (e.g., IPMI) while still keeping control plane connectivity,
and it is *diverse* since it includes [numerous fence agents](https://github.com/ClusterLabs/fence-agents) to choose from.
Each one of these agents is designed for different types of clusters, such as bare metal servers, virtual machines, cloud platforms, etc.
displayName: Fence Agents Remediation Operator
icon:
- base64data: base64EncodedIcon
Expand Down Expand Up @@ -113,9 +124,9 @@ spec:
- baremetal
links:
- name: Fence Agents Remediation
url: https://medik8s.io
url: https://www.medik8s.io/remediation/fence-agents-remediation/fence-agents-remediation/
- name: Source Code
url: https://github.com/medik8s/fence-agents-remediation
url: https://www.github.com/medik8s/fence-agents-remediation
maintainers:
- email: [email protected]
name: Medik8s Team
Expand Down
Loading