Skip to content

Commit 7a53f93

Browse files
authored
Merge pull request kubernetes-sigs#10817 from SD-13/clarity_pause_skip_remediation
🐛 Clarify cluster paused and skipping remediation steps
2 parents ffb86c5 + 335d46f commit 7a53f93

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

docs/book/src/tasks/automated-machine-management/healthchecking.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -209,15 +209,12 @@ This is useful for dynamically scaling clusters where the number of machines kee
209209

210210
## Skipping Remediation
211211

212-
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.
212+
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:
213213

214-
Implicit skipping when the resource is paused (using `cluster.x-k8s.io/paused` annotation):
215-
- When a cluster is paused, none of the machines in that cluster are considered for remediation.
216-
- When a machine is paused, only that machine is not considered for remediation.
217-
- A cluster or a machine is usually paused automatically by Cluster API when it detects a migration.
218-
219-
Explicit skipping using `cluster.x-k8s.io/skip-remediation` annotation:
220-
- Users can also skip any machine for remediation by setting the `cluster.x-k8s.io/skip-remediation` for that machine.
214+
- the Machine has the `cluster.x-k8s.io/skip-remediation` annotation
215+
- the Machine has the `cluster.x-k8s.io/paused` annotation
216+
- the MachineHealthCheck has the `cluster.x-k8s.io/paused` annotation
217+
- the Cluster has `.spec.paused` set to `true`
221218

222219
## Limitations and Caveats of a MachineHealthCheck
223220

0 commit comments

Comments
 (0)