Skip to content

🌱 Update implicit skipping remediation for Cluster/MD pause #10827

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.

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

Closed
Changes from all commits
Commits
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
21 changes: 15 additions & 6 deletions docs/book/src/tasks/automated-machine-management/healthchecking.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,12 +209,21 @@ This is useful for dynamically scaling clusters where the number of machines kee

## Skipping Remediation

There are scenarios where remediation for a machine may be undesirable (eg. during cluster migration using `clusterctl move`). For such cases, MachineHealthCheck provides 2 mechanisms to skip machines for remediation.

Implicit skipping when the resource is paused (using `cluster.x-k8s.io/paused` annotation):
- When a cluster is paused, none of the machines in that cluster are considered for remediation.
- When a machine is paused, only that machine is not considered for remediation.
- A cluster or a machine is usually paused automatically by Cluster API when it detects a migration.
There are scenarios where remediation for a machine may be undesirable (eg.
during cluster migration using `clusterctl move`). For such cases,
MachineHealthCheck provides the following mechanisms to skip remediation.

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

Note: the last option (pausing the Cluster) is the one used by `clusterctl move`.

Explicit skipping using `cluster.x-k8s.io/skip-remediation` annotation:
- Users can also skip any machine for remediation by setting the `cluster.x-k8s.io/skip-remediation` for that machine.
Expand Down
Loading