From 77b06e6b313a14daeed2b1116a23fe00eb0628d9 Mon Sep 17 00:00:00 2001 From: oraz Date: Tue, 19 Sep 2023 15:43:02 +0300 Subject: [PATCH 1/8] Update CSV short description Improve FAR CSV short description to include that it provide HA and it is done automatically --- .../fence-agents-remediation.clusterserviceversion.yaml | 4 ++-- .../bases/fence-agents-remediation.clusterserviceversion.yaml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml index 5d18a7b7..8200cf72 100644 --- a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml +++ b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml @@ -46,8 +46,8 @@ metadata: categories: OpenShift Optional containerImage: "" createdAt: "" - description: Fence Agents Remediation Operator for remediating nodes using upstream - fence-agents. + description: Fence Agents Remediation Operator provides high availability for + Kubernetes nodes in an automatic manner using well-known fence agents. olm.skipRange: '>=0.0.1' operators.operatorframework.io/builder: operator-sdk-v1.30.0 operators.operatorframework.io/project_layout: go.kubebuilder.io/v3 diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index 15cec669..7e00cda4 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -7,8 +7,8 @@ metadata: categories: OpenShift Optional containerImage: "" createdAt: "" - description: Fence Agents Remediation Operator for remediating nodes using upstream - fence-agents. + description: Fence Agents Remediation Operator provides high availability for + Kubernetes nodes in an automatic manner using well-known fence agents. olm.skipRange: '>=0.0.1' repository: https://github.com/medik8s/fence-agents-remediation support: Medik8s From f92bf19d9792dc2d41329358adb632cb113fbe00 Mon Sep 17 00:00:00 2001 From: oraz Date: Wed, 20 Sep 2023 12:59:11 +0300 Subject: [PATCH 2/8] Update CSV description Improve FAR CSV description better introduction to FAR, other remediatiors and NHC usability, and some pros for using FAR --- ...nts-remediation.clusterserviceversion.yaml | 22 +++++++++++++------ ...nts-remediation.clusterserviceversion.yaml | 22 +++++++++++++------ 2 files changed, 30 insertions(+), 14 deletions(-) diff --git a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml index 8200cf72..47d57ad3 100644 --- a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml +++ b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml @@ -117,13 +117,21 @@ 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 provides high availability for Kubernetes nodes in an automatic manner. + Using a management interface or traditional API, FAR runs a fence agent to remediate a node from an unhealthy state by power cycling the node. + By doing so it minimizes downtime for stateful applications and restores compute capacity if transient failures occur. + + 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) as an external remediator. + It is recommended to use FAR with NHC for an easier and smoother experience, 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 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 management interface (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, and each one of them + 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 diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index 7e00cda4..7f46629f 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -76,13 +76,21 @@ 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 provides high availability for Kubernetes nodes in an automatic manner. + Using a management interface or traditional API, FAR runs a fence agent to remediate a node from an unhealthy state by power cycling the node. + By doing so it minimizes downtime for stateful applications and restores compute capacity if transient failures occur. + + 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) as an external remediator. + It is recommended to use FAR with NHC for an easier and smoother experience, 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 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 management interface (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, and each one of them + 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 From 6272d9c07df5785cf1431816fbdb0047d7bc8d4b Mon Sep 17 00:00:00 2001 From: oraz Date: Wed, 20 Sep 2023 12:59:30 +0300 Subject: [PATCH 3/8] Update CSV URL Use FAR TBA link rather than general medik8s.io --- .../fence-agents-remediation.clusterserviceversion.yaml | 2 +- .../bases/fence-agents-remediation.clusterserviceversion.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml index 47d57ad3..b2f14b5b 100644 --- a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml +++ b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml @@ -360,7 +360,7 @@ spec: - baremetal links: - name: Fence Agents Remediation - url: https://medik8s.io + url: https://medik8s.io/fence-agents-remediation/fence-agents-remediation - name: Source Code url: https://github.com/medik8s/fence-agents-remediation maintainers: diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index 7f46629f..e7bd1897 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -121,7 +121,7 @@ spec: - baremetal links: - name: Fence Agents Remediation - url: https://medik8s.io + url: https://medik8s.io/fence-agents-remediation/fence-agents-remediation - name: Source Code url: https://github.com/medik8s/fence-agents-remediation maintainers: From 79a4891489d1f25f783e818dc8fe78a49a874726 Mon Sep 17 00:00:00 2001 From: oraz Date: Tue, 26 Sep 2023 16:42:17 +0300 Subject: [PATCH 4/8] Correct FAR remediation resolution as not automatic and not providing HA Correcting code review comments --- ...fence-agents-remediation.clusterserviceversion.yaml | 10 +++++----- ...fence-agents-remediation.clusterserviceversion.yaml | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml index b2f14b5b..3a7e691a 100644 --- a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml +++ b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml @@ -46,8 +46,8 @@ metadata: categories: OpenShift Optional containerImage: "" createdAt: "" - description: Fence Agents Remediation Operator provides high availability for - Kubernetes nodes in an automatic manner using well-known fence agents. + description: Fence Agents Remediation Operator can help to increase availability + of workloads in an automatic manner using well-known fence agents. olm.skipRange: '>=0.0.1' operators.operatorframework.io/builder: operator-sdk-v1.30.0 operators.operatorframework.io/project_layout: go.kubebuilder.io/v3 @@ -118,14 +118,14 @@ spec: path: template.spec.sharedparameters version: v1alpha1 description: | - Fence Agents Remediation (*FAR*) is a Kubernetes operator that provides high availability for Kubernetes nodes in an automatic manner. + Fence Agents Remediation (*FAR*) is a Kubernetes operator that can help to increase availability of workloads in an automatic manner using well-known fence agents. Using a management interface or traditional API, FAR runs a fence agent to remediate a node from an unhealthy state by power cycling the node. By doing so it minimizes downtime for stateful applications and restores compute capacity if transient failures occur. 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) as an external remediator. - It is recommended to use FAR with NHC for an easier and smoother experience, but it can be used as a standalone remediator for the more experienced user. + that were designed to run with the Node HealthCheck Operator [(NHC)](https://github.com/medik8s/node-healthcheck-operator) which detects an unhealthy node and create remediation CR. + It is recommended to use FAR with NHC for an easier and smoother experience by fully automatin 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 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). diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index e7bd1897..7805c310 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -7,8 +7,8 @@ metadata: categories: OpenShift Optional containerImage: "" createdAt: "" - description: Fence Agents Remediation Operator provides high availability for - Kubernetes nodes in an automatic manner using well-known fence agents. + description: Fence Agents Remediation Operator can help to increase availability + of workloads in an automatic manner using well-known fence agents. olm.skipRange: '>=0.0.1' repository: https://github.com/medik8s/fence-agents-remediation support: Medik8s @@ -77,14 +77,14 @@ spec: path: template.spec.sharedparameters version: v1alpha1 description: | - Fence Agents Remediation (*FAR*) is a Kubernetes operator that provides high availability for Kubernetes nodes in an automatic manner. + Fence Agents Remediation (*FAR*) is a Kubernetes operator that can help to increase availability of workloads in an automatic manner using well-known fence agents. Using a management interface or traditional API, FAR runs a fence agent to remediate a node from an unhealthy state by power cycling the node. By doing so it minimizes downtime for stateful applications and restores compute capacity if transient failures occur. 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) as an external remediator. - It is recommended to use FAR with NHC for an easier and smoother experience, but it can be used as a standalone remediator for the more experienced user. + that were designed to run with the Node HealthCheck Operator [(NHC)](https://github.com/medik8s/node-healthcheck-operator) which detects an unhealthy node and create remediation CR. + It is recommended to use FAR with NHC for an easier and smoother experience by fully automatin 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 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). From 6b56bb96383c0dac00cc482e1704d9e998474560 Mon Sep 17 00:00:00 2001 From: oraz Date: Wed, 4 Oct 2023 17:07:45 +0300 Subject: [PATCH 5/8] Better phrasing for workload availability Replace 'availability of workloads' with 'workload availability' --- .../fence-agents-remediation.clusterserviceversion.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index 7805c310..82f29fe0 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -7,8 +7,8 @@ metadata: categories: OpenShift Optional containerImage: "" createdAt: "" - description: Fence Agents Remediation Operator can help to increase availability - of workloads in an automatic manner using well-known fence agents. + description: Fence Agents Remediation Operator can help to increase workload availability + in an automatic manner using well-known fence agents. olm.skipRange: '>=0.0.1' repository: https://github.com/medik8s/fence-agents-remediation support: Medik8s @@ -77,7 +77,7 @@ spec: path: template.spec.sharedparameters version: v1alpha1 description: | - Fence Agents Remediation (*FAR*) is a Kubernetes operator that can help to increase availability of workloads in an automatic manner using well-known fence agents. + Fence Agents Remediation (*FAR*) is a Kubernetes operator that can help to increase workload availability in an automatic manner using well-known fence agents. Using a management interface or traditional API, FAR runs a fence agent to remediate a node from an unhealthy state by power cycling the node. By doing so it minimizes downtime for stateful applications and restores compute capacity if transient failures occur. From 7d4686093b29018e049d37f133e3d4c6adf3306b Mon Sep 17 00:00:00 2001 From: oraz Date: Wed, 24 Jan 2024 16:03:20 +0200 Subject: [PATCH 6/8] Reconstruct FAR description and fix links --- ...nts-remediation.clusterserviceversion.yaml | 29 ++++++++++--------- ...nts-remediation.clusterserviceversion.yaml | 29 ++++++++++--------- 2 files changed, 32 insertions(+), 26 deletions(-) diff --git a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml index 3a7e691a..557b7aca 100644 --- a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml +++ b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml @@ -46,8 +46,10 @@ metadata: categories: OpenShift Optional containerImage: "" createdAt: "" - description: Fence Agents Remediation Operator can help to increase availability - of workloads in an automatic manner using well-known 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 @@ -118,20 +120,21 @@ spec: path: template.spec.sharedparameters version: v1alpha1 description: | - Fence Agents Remediation (*FAR*) is a Kubernetes operator that can help to increase availability of workloads in an automatic manner using well-known fence agents. - Using a management interface or traditional API, FAR runs a fence agent to remediate a node from an unhealthy state by power cycling the node. - By doing so it minimizes downtime for stateful applications and restores compute capacity if transient failures occur. + 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 create remediation CR. - It is recommended to use FAR with NHC for an easier and smoother experience by fully automatin the remediation process, but it can be used as a standalone remediator for the more experienced user. + 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 isolate the node from a cluster, since we can not “trust” the unhealthy node, + 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 management interface (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, and each one of them - is designed for different types of clusters, such as bare metal servers, virtual machines, cloud platforms, etc. + 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 @@ -360,9 +363,9 @@ spec: - baremetal links: - name: Fence Agents Remediation - url: https://medik8s.io/fence-agents-remediation/fence-agents-remediation + 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: medik8s@googlegroups.com name: Medik8s Team diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index 82f29fe0..8dda8aa3 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -7,8 +7,10 @@ metadata: categories: OpenShift Optional containerImage: "" createdAt: "" - description: Fence Agents Remediation Operator can help to increase workload availability - in an automatic manner using well-known 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' repository: https://github.com/medik8s/fence-agents-remediation support: Medik8s @@ -77,20 +79,21 @@ spec: path: template.spec.sharedparameters version: v1alpha1 description: | - Fence Agents Remediation (*FAR*) is a Kubernetes operator that can help to increase workload availability in an automatic manner using well-known fence agents. - Using a management interface or traditional API, FAR runs a fence agent to remediate a node from an unhealthy state by power cycling the node. - By doing so it minimizes downtime for stateful applications and restores compute capacity if transient failures occur. + 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 create remediation CR. - It is recommended to use FAR with NHC for an easier and smoother experience by fully automatin the remediation process, but it can be used as a standalone remediator for the more experienced user. + 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 isolate the node from a cluster, since we can not “trust” the unhealthy node, + 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 management interface (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, and each one of them - is designed for different types of clusters, such as bare metal servers, virtual machines, cloud platforms, etc. + 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 @@ -121,9 +124,9 @@ spec: - baremetal links: - name: Fence Agents Remediation - url: https://medik8s.io/fence-agents-remediation/fence-agents-remediation + 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: medik8s@googlegroups.com name: Medik8s Team From ac4ed818e672dd5dab99f423e3fa4b77bb5cd435 Mon Sep 17 00:00:00 2001 From: oraz Date: Thu, 25 Jan 2024 12:02:02 +0200 Subject: [PATCH 7/8] Use medik8s.io description plus Compatability section and fix tyops --- ...nts-remediation.clusterserviceversion.yaml | 23 +++++++++---------- ...nts-remediation.clusterserviceversion.yaml | 23 +++++++++---------- 2 files changed, 22 insertions(+), 24 deletions(-) diff --git a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml index 557b7aca..3facd792 100644 --- a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml +++ b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml @@ -47,9 +47,8 @@ metadata: containerImage: "" createdAt: "" 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. + and remediate unhealthy nodes. The remediation includes rebooting the unhealthy + node using a fence agent, and then evicting workloads from the unhealthy node. olm.skipRange: '>=0.0.1' operators.operatorframework.io/builder: operator-sdk-v1.30.0 operators.operatorframework.io/project_layout: go.kubebuilder.io/v3 @@ -120,21 +119,21 @@ spec: path: template.spec.sharedparameters version: v1alpha1 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. + ### Introduction + Fence Agents Remediation (FAR) is a Kubernetes operator that uses well-known agents to fence and remediate unhealthy nodes. + The remediation includes rebooting the unhealthy node using a fence agent and then evicting workloads from the unhealthy node. + ### Compatibility 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. + ### Advantages + - Robustness - FAR has direct feedback from the traditional Application Programming Interface (API) call (e.g., IPMI) about the result of the fence action without using the Kubernetes API. + - Speed - FAR is rapid since it can reboot a node and receive an acknowledgment from the API call while other remediators might need to wait a safe time till they can expect the node to be rebooted. + - Diversity - FAR includes several fence agents from a large known set of upstream fencing agents for bare metal servers, virtual machines, cloud platforms, etc. + - Adjustability - FAR allows to set up different parameters for running the API call that remediates the node. displayName: Fence Agents Remediation Operator icon: - base64data: base64EncodedIcon diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index 8dda8aa3..1874c401 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -8,9 +8,8 @@ metadata: containerImage: "" createdAt: "" 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. + and remediate unhealthy nodes. The remediation includes rebooting the unhealthy + node using a fence agent, and then evicting workloads from the unhealthy node. olm.skipRange: '>=0.0.1' repository: https://github.com/medik8s/fence-agents-remediation support: Medik8s @@ -79,21 +78,21 @@ spec: path: template.spec.sharedparameters version: v1alpha1 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. + ### Introduction + Fence Agents Remediation (FAR) is a Kubernetes operator that uses well-known agents to fence and remediate unhealthy nodes. + The remediation includes rebooting the unhealthy node using a fence agent and then evicting workloads from the unhealthy node. + ### Compatibility 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. + ### Advantages + - Robustness - FAR has direct feedback from the traditional Application Programming Interface (API) call (e.g., IPMI) about the result of the fence action without using the Kubernetes API. + - Speed - FAR is rapid since it can reboot a node and receive an acknowledgment from the API call while other remediators might need to wait a safe time till they can expect the node to be rebooted. + - Diversity - FAR includes several fence agents from a large known set of upstream fencing agents for bare metal servers, virtual machines, cloud platforms, etc. + - Adjustability - FAR allows to set up different parameters for running the API call that remediates the node. displayName: Fence Agents Remediation Operator icon: - base64data: base64EncodedIcon From 88b1135f5981c27bb13d2ff6a9c831b747f88a94 Mon Sep 17 00:00:00 2001 From: oraz Date: Sun, 28 Jan 2024 18:31:29 +0200 Subject: [PATCH 8/8] Typo fix s/automate/automating --- .../fence-agents-remediation.clusterserviceversion.yaml | 2 +- .../bases/fence-agents-remediation.clusterserviceversion.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml index 3facd792..76954d4d 100644 --- a/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml +++ b/bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml @@ -127,7 +127,7 @@ spec: 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. + It is recommended to use FAR with NHC for an easier and smoother experience by fully automating the remediation process, but it can be used as a standalone remediator for the more experienced user. ### Advantages - Robustness - FAR has direct feedback from the traditional Application Programming Interface (API) call (e.g., IPMI) about the result of the fence action without using the Kubernetes API. diff --git a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml index 1874c401..e133ae30 100644 --- a/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml +++ b/config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml @@ -86,7 +86,7 @@ spec: 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. + It is recommended to use FAR with NHC for an easier and smoother experience by fully automating the remediation process, but it can be used as a standalone remediator for the more experienced user. ### Advantages - Robustness - FAR has direct feedback from the traditional Application Programming Interface (API) call (e.g., IPMI) about the result of the fence action without using the Kubernetes API.