🐛 Clarify cluster paused and skipping remediation steps #10817
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
cncf-cla: yes
chrischdi
reviewed
Jul 1, 2024
| - A cluster or a machine is usually paused automatically by Cluster API when it detects a migration. | ||
| - Users can skip remediation for a specific machine by setting the `cluster.x-k8s.io/skip-remediation` annotation on it. | ||
| - Paused Machines (Machines with the `cluster.x-k8s.io/paused` annotation) are not considered for remediation. | ||
| - If a specific MHC resource is paused (using `cluster.x-k8s.io/paused` annotation), it will stop to remediate the corresponding target machines. |
There was a problem hiding this comment.
Suggested change
| - If a specific MHC resource is paused (using `cluster.x-k8s.io/paused` annotation), it will stop to remediate the corresponding target machines. | |
| - If a specific MachineHealthCheck resource is paused (using `cluster.x-k8s.io/paused` annotation), it will stop to remediate the corresponding target machines. |
| - Users can skip remediation for a specific machine by setting the `cluster.x-k8s.io/skip-remediation` annotation on it. | ||
| - Paused Machines (Machines with the `cluster.x-k8s.io/paused` annotation) are not considered for remediation. | ||
| - If a specific MHC resource is paused (using `cluster.x-k8s.io/paused` annotation), it will stop to remediate the corresponding target machines. | ||
| - If the Cluster is paused (using the `cluster.x-k8s.io/paused` annotation or by setting `cluster.spec.paused` to true), all the MHC resources belonging to the Cluster will be implicitly paused, and thus stop remediating target machines. |
There was a problem hiding this comment.
Suggested change
| - If the Cluster is paused (using the `cluster.x-k8s.io/paused` annotation or by setting `cluster.spec.paused` to true), all the MHC resources belonging to the Cluster will be implicitly paused, and thus stop remediating target machines. | |
| - If the Cluster is paused (using the `cluster.x-k8s.io/paused` annotation or by setting `cluster.spec.paused` to `true`), all the MachineHealthCheck resources belonging to the Cluster will be implicitly paused, and thus stop remediating target machines. |
SD-13
force-pushed
the
clarity_pause_skip_remediation
branch
from
b1b1dda to
a350b75
Compare
|
@chrischdi Added your suggested changes, let me know if you have any other suggestions. Thanks! |
sbueringer
reviewed
Jul 2, 2024
| @@ -209,15 +209,14 @@ This is useful for dynamically scaling clusters where the number of machines kee | |||
|
|
|||
| ## Skipping Remediation | |||
|
|
|||
There was a problem hiding this comment.
I would suggest to further simplify this to
There are scenarios where remediation for a machine may be undesirable (eg. during cluster migration using `clusterctl move`). For such cases, MachineHealthCheck skips marking a Machine for remediation if:
- the Machine has the `cluster.x-k8s.io/skip-remediation` annotation
- the Machine has the `cluster.x-k8s.io/paused` annotation
- the MachineHealthCheck has the `cluster.x-k8s.io/paused` annotation
- the Cluster has `.spec.paused` set to `true`
Just a lot easier to parse in my opinion
(I didn't find any evidence of handling of the cluster.x-k8s.io/paused annotation on clusters, please let me know if I missed it. I think the same was written in the issue: #9026 (comment))
There was a problem hiding this comment.
@sbueringer I agree, this is more readable.
I think cluster.x-k8s.io/paused is being handled similar to other annotation.
SD-13
force-pushed
the
clarity_pause_skip_remediation
branch
from
a350b75 to
335d46f
Compare
|
lgtm |
|
Thank you!! /lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 969b0b13b8599d51acab3190fb0fec9f1dbd6e4b
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sbueringer 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:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #9026