🌱 Add automated machine management section to docs tasks #6421
Conversation
This file contains hidden or 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
enxebre
force-pushed
the
automated-machine-management-docs
branch
4 times, most recently
from
57b275b to
acfbabe
Compare
docs/book/src/SUMMARY.md
Outdated
| - [Automated worker Machine management](./tasks/automated-worker-machine-management/index.md) | ||
| - [Scaling](./tasks/automated-worker-machine-management/scaling.md) | ||
| - [Auto scaling](./tasks/automated-worker-machine-management/auto-scaling.md) | ||
| - [Health checking](./tasks/automated-worker-machine-management/healthchecking.md) |
There was a problem hiding this comment.
Health checking is both for control plane and worker nodes...
What about calling this new section "Automated machine management" and explicitly calling out when a paragraph applies only to a subset of machines
chrischdi
reviewed
Apr 20, 2022
|
|
||
| Machines can be owned by scalable resources i.e. MachineSet and MachineDeployments. | ||
|
|
||
| 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`. |
There was a problem hiding this comment.
Suggested change
| 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`. | |
| 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`. |
Formatting to follow the other book entries/markdowns
| 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`. | ||
|
|
||
| When you delete a Machine directly or by scaling down, the same process takes place in the same order: | ||
| - 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. |
There was a problem hiding this comment.
Suggested change
| - 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. | |
| - 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.` |
Formatting to follow the other book entries/markdowns
|
|
||
| When you delete a Machine directly or by scaling down, the same process takes place in the same order: | ||
| - 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. | ||
| - 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. |
There was a problem hiding this comment.
Suggested change
| - 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. | |
| - 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. |
Formatting to follow the other book entries/markdowns
| - 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. | ||
| - 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. | ||
| - The infrastructure backing that Node will try to be deleted indefinitely. | ||
| - Only when the infrastructure is gone, the Node will try to be deleted indefinitely unless you specify spec.nodeDeletionTimeout. |
There was a problem hiding this comment.
Suggested change
| - Only when the infrastructure is gone, the Node will try to be deleted indefinitely unless you specify spec.nodeDeletionTimeout. | |
| - Only when the infrastructure is gone, the Node will try to be deleted indefinitely unless you specify `.spec.nodeDeletionTimeout`. |
| @@ -0,0 +1,13 @@ | |||
| # Scaling Nodes | |||
|
|
|||
| You can add or remove compute capacity for your cluster workloads by creating or removing Machines. A Machine express intent to have a Node with a defined form factor. | |||
There was a problem hiding this comment.
Suggested change
| You can add or remove compute capacity for your cluster workloads by creating or removing Machines. A Machine express intent to have a Node with a defined form factor. | |
| 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. |
enxebre
force-pushed
the
automated-machine-management-docs
branch
from
acfbabe to
be84108
Compare
|
Addressed all comments PTAL @fabriziopandini @furkatgofurov7 @chrischdi. |
enxebre
force-pushed
the
automated-machine-management-docs
branch
from
be84108 to
f35d524
Compare
enxebre
changed the title
|
/retest |
|
|
||
| Machines can be owned by scalable resources i.e. MachineSet and MachineDeployments. | ||
|
|
||
| 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`. |
There was a problem hiding this comment.
Suggested change
| 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`. | |
| 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`. |
enxebre
force-pushed
the
automated-machine-management-docs
branch
from
f35d524 to
b253ea8
Compare
|
/retest |
enxebre
force-pushed
the
automated-machine-management-docs
branch
from
b253ea8 to
f067caa
Compare
rebased to pick #6436 |
|
Nice improvement, thx!! |
1 similar comment
|
Nice improvement, thx!! |
k8s-ci-robot
added
the
lgtm
| - 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`. | ||
| - 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. | ||
| - The infrastructure backing that Node will try to be deleted indefinitely. | ||
| - Only when the infrastructure is gone, the Node will try to be deleted indefinitely unless you specify `.spec.nodeDeletionTimeout`. |
There was a problem hiding this comment.
Maybe add a note saying this won't work with a Topology managed Cluster with a ref to the ClusterClass doc?
There was a problem hiding this comment.
We are slowly adding all the flags to topology managed clusters, let's aim for feature parity
There was a problem hiding this comment.
I think it's fine if we don't have a note here if it's supported with ClusterClass or not. (especially given that Nabarun will implement #6450 (talked to him last week about it))
enxebre
force-pushed
the
automated-machine-management-docs
branch
from
f067caa to
1f8321f
Compare
k8s-ci-robot
removed
the
lgtm
k8s-ci-robot
added
size/M
enxebre
force-pushed
the
automated-machine-management-docs
branch
from
1f8321f to
f9546b8
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
Thank you! /lgtm |
|
[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.
What this PR does / why we need it:
Add automated worker machine management section to docs tasks
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #