kubeadm: add separate page for configuring / migrating cgroup driver #26786

neolit123 · 2021-03-01T22:22:16Z

Add the new page "Configuring a cgroup driver"
The page includes details on how to configure the cgroup driver
using kubeadm. It also includes a migration guide for users to
move to the "systemd" driver.
Link to the new page from install-kubeadm.md and container-runtimes.md

xref
kubernetes/kubeadm#2376
kubernetes/kubernetes#99471
xref #22916

note: this is targeting the 1.21 release

netlify · 2021-03-01T22:33:29Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 987e065

https://deploy-preview-26786--kubernetes-io-master-staging.netlify.app

k8sio-netlify-preview-bot · 2021-03-01T22:35:06Z

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

Building with commit 2355094

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6041616fcd3a3b0008b4d609

neolit123 · 2021-03-01T22:36:18Z

/sig cluster-lifecycle

neolit123 · 2021-03-01T22:37:59Z

/cc @fabriziopandini @SataQiu @pacoxu

neolit123 · 2021-03-01T22:40:25Z

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md

+{{< note >}}
+If the user is not setting the `cgroupDriver` field under `KubeletConfiguration`,
+`kubeadm init` will default it to `systemd`.
+{{< /note >}}


this is new to kubeadm 1.21

Let's add "starting for v1.21" and "for older releases, the user should executed following steps manually"

i think the point of the versioned docs (this PR is targeting dev-1.21) is that all details apply to the target release - i.e. 1.21.

maybe we can use some sort of version tag for this.
will defer to sig-docs for this question.

added: {{< feature-state for_k8s_version="v1.21" state="stable" >}} inside the note.
not sure if that is the preferred way.

neolit123 · 2021-03-01T22:42:53Z

new page preview:
https://deploy-preview-26786--kubernetes-io-master-staging.netlify.app/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver/

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md

fabriziopandini · 2021-03-02T09:24:37Z

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md

+{{< note >}}
+If the user is not setting the `cgroupDriver` field under `KubeletConfiguration`,
+`kubeadm init` will default it to `systemd`.
+{{< /note >}}


Let's add "starting for v1.21" and "for older releases, the user should executed following steps manually"

reylejano · 2021-03-02T16:54:01Z

/assign
/milestone 1.21

reylejano · 2021-03-02T17:07:34Z

/hold until kubernetes/kubernetes#99471 merges

onlydole

LGTM! Thank you, @neolit123!

pacoxu · 2021-03-03T02:32:21Z

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md

+
+- Drain the node using `kubectl drain <node-name> --ignore-daemonsets`
+- Stop the kubelet using `systemctl stop kubelet`
+- Stop the container runtime


Sometimes, we need to clean up the container runtime dir.
Not sure if this is needed.

from my tests this was not needed.
we can update the guide after this PR merges if we find gaps.

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md

pacoxu · 2021-03-03T02:38:26Z

LGTM

content/en/docs/setup/production-environment/container-runtimes.md

binchenX

some nit.

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md

- Add the new page "Configuring a cgroup driver" The page includes details on how to configure the cgroup driver using kubeadm. It also includes a migration guide for users to move to the "systemd" driver. - Link to the new page from install-kubeadm.md and container-runtimes.md

neolit123 · 2021-03-04T22:38:58Z

updated the PR.

binchenX

lgtm

rdxmb · 2021-03-24T10:03:09Z

can we please remove

fixes #22916

because of #22916 (comment)

rdxmb · 2021-03-24T11:16:35Z

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md

+---
+kind: KubeletConfiguration
+apiVersion: kubelet.config.k8s.io/v1beta1
+cgroupDriver: systemd


https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2?utm_source=godoc uses

apiVersion: kubeadm.k8s.io/v1beta2 kind: InitConfiguration nodeRegistration: kubeletExtraArgs: cgroup-driver: "cgroupfs"

to define the cgroupfs.

Confusing...

don't use kubeletExtraArgs, because the cgroup-driver flag is deprecated.
this new page has the right config example.

I understand. However, this is very confusing, so where is an actual full reference for the kubeadm-kubelet-config-file to configure everything in one file?

there are also the support forums and #kubeadm on the k8s slack for users that need help:
https://github.com/kubernetes/kubernetes/blob/master/SUPPORT.md

i will send a PR to remove the kubeletExtraArgs examples in https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2?utm_source=godoc

there are also the support forums and #kubeadm on the k8s slack for users that need help:
https://github.com/kubernetes/kubernetes/blob/master/SUPPORT.md

I know. But the docs should be the first place to search, shouldn't it?

i will send a PR to remove the kubeletExtraArgs examples in https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2?utm_source=godoc

👍

neolit123 · 2021-03-24T14:11:18Z

can we please remove

fixes #22916

because of #22916 (comment)

yes, we can.

rdxmb · 2021-03-24T16:28:07Z

yes, we can.

thanks!

reylejano · 2021-03-30T15:38:21Z

/hold cancel
kubernetes/kubernetes#99471 has merged

reylejano · 2021-03-30T15:39:52Z

/approve

k8s-ci-robot · 2021-03-30T15:40:14Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: binchenX, onlydole, reylejano

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~~ [onlydole,reylejano]

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

irvifa

/lgtm

k8s-ci-robot · 2021-03-30T16:21:18Z

LGTM label has been added.

Git tree hash: 630c4c5b6529d926dd8822d7581032fd826dd520

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 1, 2021

neolit123 mentioned this pull request Mar 1, 2021

default the "cgroupDriver" setting of the kubelet to "systemd" kubernetes/kubeadm#2376

Closed

4 tasks

k8s-ci-robot requested review from bart0sh and onlydole March 1, 2021 22:22

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 Mar 1, 2021

neolit123 changed the base branch from master to dev-1.21 March 1, 2021 22:23

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 1, 2021

neolit123 force-pushed the 1.21-cgroup-drivers-new-page branch from 987e065 to 206051a Compare March 1, 2021 22:35

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 1, 2021

k8s-ci-robot added the sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. label Mar 1, 2021

k8s-ci-robot requested review from fabriziopandini, pacoxu and SataQiu March 1, 2021 22:38

neolit123 commented Mar 1, 2021

View reviewed changes

neolit123 force-pushed the 1.21-cgroup-drivers-new-page branch 2 times, most recently from f562dea to d3a2e15 Compare March 1, 2021 22:45

fabriziopandini reviewed Mar 2, 2021

View reviewed changes

neolit123 mentioned this pull request Mar 2, 2021

kubeadm: set the kubelet cgroup driver to "systemd" during "init" kubernetes/kubernetes#99471

Merged

k8s-ci-robot assigned reylejano Mar 2, 2021

k8s-ci-robot added this to the 1.21 milestone Mar 2, 2021

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

onlydole approved these changes Mar 2, 2021

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 2, 2021

pacoxu reviewed Mar 3, 2021

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md Outdated Show resolved Hide resolved

binchenX reviewed Mar 3, 2021

View reviewed changes

content/en/docs/setup/production-environment/container-runtimes.md Outdated Show resolved Hide resolved

binchenX reviewed Mar 3, 2021

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md Show resolved Hide resolved

content/en/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver.md Show resolved Hide resolved

fabriziopandini reviewed Mar 4, 2021

View reviewed changes

neolit123 force-pushed the 1.21-cgroup-drivers-new-page branch from d3a2e15 to 2355094 Compare March 4, 2021 22:38

binchenX approved these changes Mar 4, 2021

View reviewed changes

This was referenced Mar 9, 2021

Installing kubeadm should mention about kubeadm config file #22916

Closed

Clear warning required for containerd documentation #27017

Closed

rdxmb reviewed Mar 24, 2021

View reviewed changes

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

irvifa reviewed Mar 30, 2021

View reviewed changes

k8s-ci-robot assigned irvifa Mar 30, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 30, 2021

k8s-ci-robot merged commit e7a3482 into kubernetes:dev-1.21 Mar 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kubeadm: add separate page for configuring / migrating cgroup driver #26786

kubeadm: add separate page for configuring / migrating cgroup driver #26786

neolit123 commented Mar 1, 2021 •

edited

Loading

netlify bot commented Mar 1, 2021

k8sio-netlify-preview-bot commented Mar 1, 2021 •

edited

Loading

neolit123 commented Mar 1, 2021

neolit123 commented Mar 1, 2021

neolit123 Mar 1, 2021

fabriziopandini Mar 2, 2021

neolit123 Mar 2, 2021

neolit123 Mar 4, 2021

neolit123 commented Mar 1, 2021

fabriziopandini Mar 2, 2021

reylejano commented Mar 2, 2021

reylejano commented Mar 2, 2021

onlydole left a comment

pacoxu Mar 3, 2021

neolit123 Mar 4, 2021

pacoxu commented Mar 3, 2021

binchenX left a comment

neolit123 commented Mar 4, 2021

binchenX left a comment

rdxmb commented Mar 24, 2021

rdxmb Mar 24, 2021

neolit123 Mar 24, 2021

rdxmb Mar 24, 2021

neolit123 Mar 24, 2021

rdxmb Mar 24, 2021

neolit123 commented Mar 24, 2021

rdxmb commented Mar 24, 2021

reylejano commented Mar 30, 2021

reylejano commented Mar 30, 2021

k8s-ci-robot commented Mar 30, 2021

irvifa left a comment

k8s-ci-robot commented Mar 30, 2021

kubeadm: add separate page for configuring / migrating cgroup driver #26786

kubeadm: add separate page for configuring / migrating cgroup driver #26786

Conversation

neolit123 commented Mar 1, 2021 • edited Loading

netlify bot commented Mar 1, 2021

k8sio-netlify-preview-bot commented Mar 1, 2021 • edited Loading

neolit123 commented Mar 1, 2021

neolit123 commented Mar 1, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 commented Mar 1, 2021

Choose a reason for hiding this comment

reylejano commented Mar 2, 2021

reylejano commented Mar 2, 2021

onlydole left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pacoxu commented Mar 3, 2021

binchenX left a comment

Choose a reason for hiding this comment

neolit123 commented Mar 4, 2021

binchenX left a comment

Choose a reason for hiding this comment

rdxmb commented Mar 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 commented Mar 24, 2021

rdxmb commented Mar 24, 2021

reylejano commented Mar 30, 2021

reylejano commented Mar 30, 2021

k8s-ci-robot commented Mar 30, 2021

irvifa left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Mar 30, 2021

neolit123 commented Mar 1, 2021 •

edited

Loading

k8sio-netlify-preview-bot commented Mar 1, 2021 •

edited

Loading