Update CSV description #79

razo7 · 2023-08-23T13:58:27Z

Improve FAR CSV description to include how FAR works, why it is needed, what makes it a good remediator, and a recommendation to use it with NHC.

openshift-ci · 2023-08-23T13:58:31Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

razo7 · 2023-09-19T11:58:58Z

/test 4.13-openshift-e2e
/test 4.14-openshift-e2e

Improve FAR CSV short description to include that it provide HA and it is done automatically

razo7 · 2023-09-19T14:07:24Z

/test 4.13-openshift-e2e
/test 4.14-openshift-e2e

razo7 · 2023-09-20T06:41:36Z

/test 4.13-openshift-e2e
/test 4.14-openshift-e2e

Improve FAR CSV description better introduction to FAR, other remediatiors and NHC usability, and some pros for using FAR

Use FAR TBA link rather than general medik8s.io

mshitrit · 2023-09-20T11:19:04Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

@@ -352,7 +360,7 @@ spec:
  - baremetal
  links:
  - name: Fence Agents Remediation
-    url: https://medik8s.io
+    url: https://medik8s.io/fence-agents-remediation/fence-agents-remediation


Since this is broken I'd probably wait to merge docs PR first
medik8s/docs#63

mshitrit · 2023-09-20T11:23:50Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

+
+    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.


I think that external remediator in the context of NHC is confusing.
IIRC it is relevant for MHC who both have an "internal" remediation mechanism and can also use different "external" remediators.
Since NHC is not a remediator by itself it would probably be best not to use this terminology here.

I changed it a little bit, let me know if it looks better.

mshitrit · 2023-09-20T11:28:57Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

+    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.


Nit: I think the main role of NHC in this context is giving the user a fully automated remediation process

Correcting code review comments

razo7 · 2023-09-29T06:08:52Z

/test 4.13-openshift-e2e
/test 4.14-openshift-e2e

razo7 · 2023-09-29T08:53:23Z

/test 4.14-openshift-e2e

hack/auotomate_far_cr.sh

Replace 'availability of workloads' with 'workload availability'

razo7 · 2023-10-04T14:08:56Z

/test 4.13-openshift-e2e
/test 4.14-openshift-e2e

razo7 · 2023-10-05T14:30:00Z

/test 4.14-openshift-e2e

clobrano · 2024-01-24T14:43:38Z

config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml

+    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.


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

clobrano · 2024-01-24T14:45:24Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

-    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.


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

clobrano · 2024-01-24T14:46:23Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

-    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,


typo: either runs or uses

clobrano · 2024-01-24T14:46:52Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

+  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.


typo: delets -> deletes

clobrano · 2024-01-24T14:49:27Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

+    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.


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..."?

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.

clobrano · 2024-01-24T14:52:30Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

+
+    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,


Not sure what you mean by "traditional API" 🤔

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

slintes · 2024-01-24T15:43:07Z

what about using what we already have here: https://www.medik8s.io/remediation/fence-agents-remediation/fence-agents-remediation/ ? That one went through review and discussion already 🙂

razo7 · 2024-01-25T10:01:34Z

what about using what we already have here: medik8s.io/remediation/fence-agents-remediation/fence-agents-remediation ? That one went through review and discussion already 🙂

Yes, I will use most of it with the addition of Compatability section for awareness of other Medik8s operators and a recommendation for using FAR with NHC

clobrano

/lgtm

clobrano · 2024-01-25T14:27:10Z

/hold

give time to close other discussions

razo7 · 2024-01-25T15:18:51Z

The other discussions are old or by you, so I removing the draft for now, and waiting for more comments until all the tests are green (and the PR is still on hold).

slintes · 2024-01-25T18:25:58Z

bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml

+    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.


s/automate/automating

razo7 · 2024-01-28T17:32:38Z

/test all

razo7 · 2024-01-29T04:20:42Z

/retest

razo7 · 2024-01-29T09:14:10Z

/retest

slintes

/hold cancel

openshift-ci · 2024-01-29T11:57:42Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: clobrano, razo7, slintes

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [clobrano,razo7,slintes]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

razo7 · 2024-01-30T06:12:53Z

/retest

openshift-ci bot added the do-not-merge/work-in-progress label Aug 23, 2023

openshift-ci bot added the approved label Aug 23, 2023

razo7 changed the title ~~[WIP] Update CSV description~~ Update CSV description Sep 19, 2023

razo7 force-pushed the csv-description branch from 6e1f9e2 to d6b5cec Compare September 19, 2023 11:57

Update CSV short description

77b06e6

Improve FAR CSV short description to include that it provide HA and it is done automatically

razo7 force-pushed the csv-description branch 2 times, most recently from 22ee7f4 to 2e587ae Compare September 19, 2023 12:55

razo7 added 2 commits September 20, 2023 12:59

Update CSV description

f92bf19

Improve FAR CSV description better introduction to FAR, other remediatiors and NHC usability, and some pros for using FAR

Update CSV URL

6272d9c

Use FAR TBA link rather than general medik8s.io

razo7 force-pushed the csv-description branch from 2e587ae to 6272d9c Compare September 20, 2023 09:59

mshitrit reviewed Sep 20, 2023

View reviewed changes

Correct FAR remediation resolution as not automatic and not providing HA

79a4891

Correcting code review comments

slintes reviewed Oct 4, 2023

View reviewed changes

hack/auotomate_far_cr.sh Outdated Show resolved Hide resolved

Better phrasing for workload availability

6b56bb9

Replace 'availability of workloads' with 'workload availability'

razo7 force-pushed the csv-description branch from 530a812 to 6b56bb9 Compare October 4, 2023 14:08

Reconstruct FAR description and fix links

7d46860

clobrano requested changes Jan 24, 2024

View reviewed changes

openshift-ci bot assigned clobrano Jan 24, 2024

Use medik8s.io description plus Compatability section and fix tyops

ac4ed81

clobrano approved these changes Jan 25, 2024

View reviewed changes

openshift-ci bot added the lgtm label Jan 25, 2024

openshift-ci bot added the do-not-merge/hold label Jan 25, 2024

razo7 marked this pull request as ready for review January 25, 2024 15:18

openshift-ci bot removed the do-not-merge/work-in-progress label Jan 25, 2024

openshift-ci bot requested review from beekhof and mshitrit January 25, 2024 15:19

slintes reviewed Jan 25, 2024

View reviewed changes

Typo fix

88b1135

s/automate/automating

openshift-ci bot removed the lgtm label Jan 28, 2024

slintes approved these changes Jan 29, 2024

View reviewed changes

openshift-ci bot assigned slintes Jan 29, 2024

openshift-ci bot added lgtm and removed do-not-merge/hold labels Jan 29, 2024

openshift-merge-bot bot merged commit 2a1d3bd into medik8s:main Jan 30, 2024
18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update CSV description #79

Update CSV description #79

razo7 commented Aug 23, 2023 •

edited

Loading

openshift-ci bot commented Aug 23, 2023

razo7 commented Sep 19, 2023

razo7 commented Sep 19, 2023

razo7 commented Sep 20, 2023

mshitrit Sep 20, 2023

mshitrit Sep 20, 2023

razo7 Sep 26, 2023

mshitrit Sep 20, 2023

razo7 commented Sep 29, 2023

razo7 commented Sep 29, 2023

razo7 commented Oct 4, 2023

razo7 commented Oct 5, 2023

clobrano Jan 24, 2024

clobrano Jan 24, 2024

clobrano Jan 24, 2024

clobrano Jan 24, 2024

clobrano Jan 24, 2024 •

edited

Loading

razo7 Jan 25, 2024

clobrano Jan 24, 2024 •

edited

Loading

razo7 Jan 25, 2024

slintes commented Jan 24, 2024

razo7 commented Jan 25, 2024

clobrano left a comment

clobrano commented Jan 25, 2024

razo7 commented Jan 25, 2024

slintes Jan 25, 2024

razo7 commented Jan 28, 2024

razo7 commented Jan 29, 2024

razo7 commented Jan 29, 2024

slintes left a comment

openshift-ci bot commented Jan 29, 2024

razo7 commented Jan 30, 2024

Update CSV description #79

Update CSV description #79

Conversation

razo7 commented Aug 23, 2023 • edited Loading

openshift-ci bot commented Aug 23, 2023

razo7 commented Sep 19, 2023

razo7 commented Sep 19, 2023

razo7 commented Sep 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

razo7 commented Sep 29, 2023

razo7 commented Sep 29, 2023

razo7 commented Oct 4, 2023

razo7 commented Oct 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clobrano Jan 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clobrano Jan 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

slintes commented Jan 24, 2024

razo7 commented Jan 25, 2024

clobrano left a comment

Choose a reason for hiding this comment

clobrano commented Jan 25, 2024

razo7 commented Jan 25, 2024

Choose a reason for hiding this comment

razo7 commented Jan 28, 2024

razo7 commented Jan 29, 2024

razo7 commented Jan 29, 2024

slintes left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Jan 29, 2024

razo7 commented Jan 30, 2024

razo7 commented Aug 23, 2023 •

edited

Loading

clobrano Jan 24, 2024 •

edited

Loading

clobrano Jan 24, 2024 •

edited

Loading