Graceful node shutdown (alpha 1.20 feature) docs [KEP: 2000] #24918

bobbypage · 2020-11-06T01:36:07Z

Add docs for graceful node shutdown alpha 1.20 feature.

PRs:
kubernetes/kubernetes#96129

KEP:
KEP 2000 (Graceful Node Shutdown).

Issues:
Enhancement issue: kubernetes/enhancements#2000

k8sio-netlify-preview-bot · 2020-11-06T01:36:11Z

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 13cc09f

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5fb76dfab93ea200079433d1

bobbypage · 2020-11-06T01:36:39Z

/sig node
/milestone 1.20

k8s-ci-robot · 2020-11-06T01:36:40Z

@bobbypage: You must be a member of the kubernetes/website-milestone-maintainers GitHub team to set the milestone. If you believe you should be able to issue the /milestone command, please contact your Website milestone maintainers and have them propose you as an additional delegate for this responsibility.

In response to this:

/sig node
/milestone 1.20

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

annajung · 2020-11-06T01:53:35Z

/milestone 1.20
/assign
/hold pending merge kubernetes/kubernetes#96129

annajung · 2020-11-11T01:30:55Z

Hi @bobbypage

Friendly reminder that docs ready for review deadline is coming up on Nov 23rd, right after Kubecon NA. We would appreciate it if you could provide most of the doc content for this feature early so that it can be reviewed by Sig Docs before Kubecon and other events happening in November.

When it's ready to be reviewed, please don't forget to remove the word placeholder from the title. thank you!

annajung · 2020-11-12T23:48:48Z

/hold cancel
k/k pr merged

content/en/docs/reference/command-line-tools-reference/feature-gates.md

irvifa · 2020-11-14T09:57:57Z

@bobbypage LGTM I think this one good to go after you address Anna’s feedback

irvifa

/lgtm

sftim · 2020-11-19T12:49:13Z

The feature gate also needs a description.

/lgtm cancel

bobbypage · 2020-11-19T19:46:01Z

I have updated with a description of the feature gate, PTAL again.

sftim · 2020-11-19T20:10:38Z

This is placeholder for graceful node shutdown docs.

Please update PR description to confirm this is ready for review.

content/en/docs/reference/command-line-tools-reference/feature-gates.md

bobbypage · 2020-11-20T07:20:33Z

Done, updated, PTAL again.

sftim

Aside: I might blog about this, mentioning the sample output of systemd-inhibit during node shutdown.

Markdown LGTM. I think this is OK without tech review from a SIG Node member, too.
/lgtm

sftim · 2020-11-20T10:06:55Z

content/en/docs/concepts/architecture/nodes.md

+If you have enabled the `GracefulNodeShutdown` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), then the kubelet attempts to detect the node system shutdown and terminates pods running on the node.
+Kubelet ensures that pods follow the normal [pod termination process](/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination) during the node shutdown.
+
+When the `GracefulNodeShutdown` feature gate is enabled, kubelet uses [systemd inhibitor locks](https://www.freedesktop.org/wiki/Software/systemd/inhibit/) to delay the node shutdown with a given duration. During a shutdown kubelet terminates pods in two phases:


Does this rely on the node running systemd?

Yes, since this is using the systemd inhibitor locks. Do you think it makes sense to call out that this depends explicitly on node running systemd or is it implied with the sentence regarding systemd inhibitor locks?

I added issue #25171 to track adding more documentation about graceful node shutdown.

There are style conventions for how to explain prerequisites, so the place to explain in detail what's required is there.

k8s-ci-robot · 2020-11-20T10:09:19Z

LGTM label has been added.

Git tree hash: 4866b10d5abc214d627c2e10c1f3e898371fc7fa

Superseded

bobbypage · 2020-11-20T22:20:57Z

Thanks for taking a look @sftim. Would be happy to work with you on a blog if you're interested, feel free to ping me.

Also one more question -- do you think this is the best place for this content? I added it under content/en/docs/concepts/architecture/nodes.md, but maybe there's a better place to add the info. Let me know if you have some thoughts here.

sftim · 2020-11-20T22:26:25Z

Also one more question -- do you think this is the best place for this content? I added it under content/en/docs/concepts/architecture/nodes.md, but maybe there's a better place to add the info. Let me know if you have some thoughts here.

There might be a better place for this content; however with KubeCon still running and the release burn down imminent, I am wary of recommending a reorganization. Let's get this merged and then reflect on alternative homes for these details.

bobbypage · 2020-11-20T22:37:25Z

Sounds good, this should be good go, let's merge it and then will reevaluate after as you mentioned.

irvifa · 2020-11-20T22:38:52Z

/approve

k8s-ci-robot · 2020-11-20T22:39:38Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irvifa

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:

~~content/en/OWNERS~~ [irvifa]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sftim · 2020-11-22T19:40:01Z

content/en/docs/concepts/architecture/nodes.md

+If you have enabled the `GracefulNodeShutdown` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), then the kubelet attempts to detect the node system shutdown and terminates pods running on the node.
+Kubelet ensures that pods follow the normal [pod termination process](/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination) during the node shutdown.
+
+When the `GracefulNodeShutdown` feature gate is enabled, kubelet uses [systemd inhibitor locks](https://www.freedesktop.org/wiki/Software/systemd/inhibit/) to delay the node shutdown with a given duration. During a shutdown kubelet terminates pods in two phases:


I added issue #25171 to track adding more documentation about graceful node shutdown.

There are style conventions for how to explain prerequisites, so the place to explain in detail what's required is there.

sftim · 2020-11-22T19:41:51Z

content/en/docs/concepts/architecture/nodes.md

+
+{{< feature-state state="alpha" for_k8s_version="v1.20" >}}
+
+If you have enabled the `GracefulNodeShutdown` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), then the kubelet attempts to detect the node system shutdown and terminates pods running on the node.


Is this better:

Suggested change

If you have enabled the `GracefulNodeShutdown` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), then the kubelet attempts to detect the node system shutdown and terminates pods running on the node.

If you have enabled the `GracefulNodeShutdown` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), and the node is using [systemd](https://www.freedesktop.org/wiki/Software/systemd/) as its init process, then the kubelet attempts to detect the node system shutdown. Once node shutdown is detected the kubelet terminates local pods and informs the cluster's API server.

?

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 6, 2020

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 6, 2020

k8s-ci-robot requested review from tengqm and zparnold November 6, 2020 01:36

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 6, 2020

k8s-ci-robot added the sig/node Categorizes an issue or PR as relevant to SIG Node. label Nov 6, 2020

bobbypage mentioned this pull request Nov 6, 2020

Graceful node shutdown kubernetes/enhancements#2000

Open

k8s-ci-robot assigned annajung Nov 6, 2020

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 6, 2020

k8s-ci-robot added this to the 1.20 milestone Nov 6, 2020

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 12, 2020

annajung reviewed Nov 13, 2020

View reviewed changes

content/en/docs/reference/command-line-tools-reference/feature-gates.md Show resolved Hide resolved

irvifa reviewed Nov 14, 2020

View reviewed changes

k8s-ci-robot assigned irvifa Nov 14, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2020

k8s-ci-robot assigned sftim Nov 19, 2020

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 19, 2020

sftim mentioned this pull request Nov 19, 2020

Implement Graceful Node Shutdown in Kubelet kubernetes/kubernetes#96129

Merged

bobbypage force-pushed the graceful-node-shutdown-docs branch 2 times, most recently from 2472506 to 2e89a4d Compare November 19, 2020 19:45

bobbypage changed the title ~~Placeholder: Graceful node shutdown docs [KEP: 2000]~~ Graceful node shutdown (alpha 1.20 feature) docs [KEP: 2000] Nov 19, 2020

sftim previously requested changes Nov 19, 2020

View reviewed changes

content/en/docs/reference/command-line-tools-reference/feature-gates.md Outdated Show resolved Hide resolved

bobbypage force-pushed the graceful-node-shutdown-docs branch from 2e89a4d to ace5ef1 Compare November 20, 2020 06:47

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 20, 2020

bobbypage force-pushed the graceful-node-shutdown-docs branch from ace5ef1 to 9727caa Compare November 20, 2020 07:10

Add graceful node shutdown feature gate

13cc09f

bobbypage force-pushed the graceful-node-shutdown-docs branch from 9727caa to 13cc09f Compare November 20, 2020 07:19

sftim reviewed Nov 20, 2020

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 20, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 20, 2020

k8s-ci-robot merged commit e3076ed into kubernetes:dev-1.20 Nov 20, 2020

sftim reviewed Nov 22, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Graceful node shutdown (alpha 1.20 feature) docs [KEP: 2000] #24918

Graceful node shutdown (alpha 1.20 feature) docs [KEP: 2000] #24918

bobbypage commented Nov 6, 2020 •

edited

k8sio-netlify-preview-bot commented Nov 6, 2020 •

edited

bobbypage commented Nov 6, 2020

k8s-ci-robot commented Nov 6, 2020

annajung commented Nov 6, 2020

annajung commented Nov 11, 2020

annajung commented Nov 12, 2020

irvifa commented Nov 14, 2020

irvifa left a comment

sftim commented Nov 19, 2020

bobbypage commented Nov 19, 2020

sftim commented Nov 19, 2020

bobbypage commented Nov 20, 2020

sftim left a comment

sftim Nov 20, 2020

bobbypage Nov 20, 2020

sftim Nov 22, 2020

k8s-ci-robot commented Nov 20, 2020

bobbypage commented Nov 20, 2020

sftim commented Nov 20, 2020

bobbypage commented Nov 20, 2020

irvifa commented Nov 20, 2020

k8s-ci-robot commented Nov 20, 2020

sftim Nov 22, 2020

sftim Nov 22, 2020


		{{< feature-state state="alpha" for_k8s_version="v1.20" >}}

		If you have enabled the `GracefulNodeShutdown` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), then the kubelet attempts to detect the node system shutdown and terminates pods running on the node.

Graceful node shutdown (alpha 1.20 feature) docs [KEP: 2000] #24918

Graceful node shutdown (alpha 1.20 feature) docs [KEP: 2000] #24918

Conversation

bobbypage commented Nov 6, 2020 • edited

k8sio-netlify-preview-bot commented Nov 6, 2020 • edited

bobbypage commented Nov 6, 2020

k8s-ci-robot commented Nov 6, 2020

annajung commented Nov 6, 2020

annajung commented Nov 11, 2020

annajung commented Nov 12, 2020

irvifa commented Nov 14, 2020

irvifa left a comment

Choose a reason for hiding this comment

sftim commented Nov 19, 2020

bobbypage commented Nov 19, 2020

sftim commented Nov 19, 2020

bobbypage commented Nov 20, 2020

sftim left a comment

Choose a reason for hiding this comment

sftim Nov 20, 2020

Choose a reason for hiding this comment

bobbypage Nov 20, 2020

Choose a reason for hiding this comment

sftim Nov 22, 2020

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 20, 2020

bobbypage commented Nov 20, 2020

sftim commented Nov 20, 2020

bobbypage commented Nov 20, 2020

irvifa commented Nov 20, 2020

k8s-ci-robot commented Nov 20, 2020

sftim Nov 22, 2020

Choose a reason for hiding this comment

sftim Nov 22, 2020

Choose a reason for hiding this comment

bobbypage commented Nov 6, 2020 •

edited

k8sio-netlify-preview-bot commented Nov 6, 2020 •

edited