Skip to content

Commit

Permalink
Add link to KCP remediation guidelines
Browse files Browse the repository at this point in the history
Update the limitation and caveats section with a link to the KCP remediation guidelines for more detail

Signed-off-by: Scott Lowe <[email protected]>
  • Loading branch information
scottslowe committed Feb 24, 2021
1 parent e1b08b3 commit 1a51d4b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/book/src/tasks/healthcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ There are scenarios where remediation for a machine may be undesirable (eg. duri
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.
- A cluster or a machine is usually paused automatically by Cluster API when it detects a migration.

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 All @@ -141,6 +141,7 @@ Explicit skipping using `cluster.x-k8s.io/skip-remediation` annotation:
Before deploying a MachineHealthCheck, please familiarise yourself with the following limitations and caveats:

- Only Machines owned by a MachineSet or a KubeadmControlPlane can be remediated by a MachineHealthCheck (since a MachineDeployment uses a MachineSet, then this includes Machines that are part of a MachineDeployment)
- Machines managed by a KubeadmControlPlane are remediated according to [the delete-and-recreate guidelines described in the KubeadmControlPlane proposal](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20191017-kubeadm-based-control-plane.md#remediation-using-delete-and-recreate)
- If the Node for a Machine is removed from the cluster, a MachineHealthCheck will consider this Machine unhealthy and remediate it immediately
- If no Node joins the cluster for a Machine after the `NodeStartupTimeout`, the Machine will be remediated
- If a Machine fails for any reason (if the FailureReason is set), the Machine will be remediated immediately
Expand Down

0 comments on commit 1a51d4b

Please sign in to comment.