Skip to content

Commit be84108

Browse files
committed
Add automated worker machine management section to docs tasks
1 parent 514e2aa commit be84108

File tree

5 files changed

+22
-4
lines changed

5 files changed

+22
-4
lines changed

docs/book/src/SUMMARY.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@
1111
- [Kubeadm based bootstrap](./tasks/kubeadm-bootstrap.md)
1212
- [Upgrading management and workload clusters](./tasks/upgrading-clusters.md)
1313
- [Upgrading Cluster API components](./tasks/upgrading-cluster-api-versions.md)
14-
- [Configure a MachineHealthCheck](./tasks/healthcheck.md)
1514
- [Kubeadm based control plane management](./tasks/kubeadm-control-plane.md)
1615
- [Updating Machine Infrastructure and Bootstrap Templates](tasks/updating-machine-templates.md)
17-
- [Using the Cluster Autoscaler](./tasks/cluster-autoscaler.md)
16+
- [Automated Machine management](./tasks/automated-machine-management/index.md)
17+
- [Scaling](./tasks/automated-machine-management/scaling.md)
18+
- [Auto scaling](./tasks/automated-machine-management/auto-scaling.md)
19+
- [Health checking](./tasks/automated-machine-management/healthchecking.md)
1820
- [Experimental Features](./tasks/experimental-features/experimental-features.md)
1921
- [MachinePools](./tasks/experimental-features/machine-pools.md)
2022
- [ClusterResourceSet](./tasks/experimental-features/cluster-resource-set.md)

docs/book/src/tasks/cluster-autoscaler.md renamed to docs/book/src/tasks/automated-machine-management/auto-scaling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Using the Cluster Autoscaler
22

3-
Cluster Autoscaler is a tool that automatically adjusts the size of the Kubernetes cluster based
3+
This section applies only to worker Machines. Cluster Autoscaler is a tool that automatically adjusts the size of the Kubernetes cluster based
44
on the utilization of Pods and Nodes in your cluster. For more general information about the
55
Cluster Autoscaler, please see the
66
[project documentation](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler).

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,4 +179,4 @@ Before deploying a MachineHealthCheck, please familiarise yourself with the foll
179179
- If a Machine fails for any reason (if the FailureReason is set), the Machine will be remediated immediately
180180

181181
<!-- links -->
182-
[management cluster]: ../reference/glossary.md#management-cluster
182+
[management cluster]: ../../reference/glossary.md#management-cluster
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Automated Machine management
2+
3+
This section details some tasks related to automated Machine management.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Scaling Nodes
2+
3+
This section applies only to worker Machines. You can add or remove compute capacity for your cluster workloads by creating or removing Machines. A Machine expresses intent to have a Node with a defined form factor.
4+
5+
Machines can be owned by scalable resources i.e. MachineSet and MachineDeployments.
6+
7+
You can scale MachineSets and MachineDeployments in or out by expressing intent via `.spec.replicas or updating the scale subresource e.g `kubectl scale machinedeployment foo --replicas=5`.
8+
9+
When you delete a Machine directly or by scaling down, the same process takes place in the same order:
10+
- The Node backed by that Machine will try to be drained indefinitely and will wait for any volume to be detached from the Node unless you specify a `.spec.nodeDrainTimeout`.
11+
- CAPI uses default [kubectl draining implementation](https://kubernetes.io/docs/tasks/administer-cluster/safely-drain-node/) with `-–ignore-daemonsets=true`. If you needed to ensure DaemonSets eviction you'd need to do so manually by also adding proper taints to avoid rescheduling.
12+
- The infrastructure backing that Node will try to be deleted indefinitely.
13+
- Only when the infrastructure is gone, the Node will try to be deleted indefinitely unless you specify `.spec.nodeDeletionTimeout`.

0 commit comments

Comments
 (0)