Docs to change Container runtime #30141

Debanitrkl · 2021-10-19T12:48:32Z

This adds the detailed instructions to help change container runtime to containerd.
related to kubernetes/kubernetes#104878
/assign @adisky

netlify · 2021-10-19T13:02:49Z

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: c38dc24

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/620527a340fe330008c06208

😎 Browse the preview: https://deploy-preview-30141--kubernetes-io-main-staging.netlify.app

Debanitrkl · 2021-10-19T13:16:51Z

Also related to #25879

adisky · 2021-10-20T06:40:30Z

@Debanitrkl I am not able find the new doc added with deployment preview https://deploy-preview-30141--kubernetes-io-main-staging.netlify.app/docs/tasks/administer-cluster/migrating-from-dockershim/

adisky · 2021-10-20T06:43:54Z

you need to add contents in the format used here https://github.com/kubernetes/website/pull/25787/files

Debanitrkl · 2021-10-20T08:09:12Z

@Debanitrkl I am not able find the new doc added with deployment preview https://deploy-preview-30141--kubernetes-io-main-staging.netlify.app/docs/tasks/administer-cluster/migrating-from-dockershim/

I guess this is because it's still a WIP

adisky · 2021-10-20T09:07:21Z

@Debanitrkl I am not able find the new doc added with deployment preview https://deploy-preview-30141--kubernetes-io-main-staging.netlify.app/docs/tasks/administer-cluster/migrating-from-dockershim/

I guess this is because it's still a WIP

I think it is because of content format, update the content format

adisky

Overall if we can add more description on the steps and little better formatting

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

adisky · 2021-10-20T12:48:12Z

/cc @MadhavJivrajani

MadhavJivrajani

Thanks for doing this!
Deployment preview can be found here: https://deploy-preview-30141--kubernetes-io-main-staging.netlify.app/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime/

I don't have a lot of experience with docs but I have a few suggestions:

Since this page is going to be important during 1.24 release and post that, it would really help providing context on dockershim in general; this can be done through linking the other two documents that are under the migrating-from-dockershim section.
There needs to be information provided for why the said commands are necessary to be run.
This is just a small nit but for the sake of consistency with the other files present, file name of change-runtime over Change-runtime might be better.

/cc @RinkiyaKeDad
for further feedback from a docs perspective.

MadhavJivrajani · 2021-10-21T05:45:21Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+- finally if everything goes well remove docker
+```
+apt purge docker-ce docker-ce-cli
+OR
+yum remove docker-ce docker-ce-cli
+```


Is this still under Windows Powershell?

Not sure if the OR here is the right way to go about it. Maybe a separate code section?

I didn't try this myself took it from the reference here https://kruyt.org/migrate-docker-containerd-kubernetes/. Also, I guess given the formatting style of this doc a separate code section would be better

MadhavJivrajani · 2021-10-21T05:49:13Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+   ```powershell
+   Copy-Item -Path ".\bin\" -Destination "$Env:ProgramFiles\containerd" -Recurse -Force
+   cd $Env:ProgramFiles\containerd\
+   .\containerd.exe config default | Out-File config.toml -Encoding ascii
+
+   # Review the configuration. Depending on setup you may want to adjust:
+   # - the sandbox_image (Kubernetes pause image)
+   # - cni bin_dir and conf_dir locations
+   Get-Content config.toml
+
+   # (Optional - but highly recommended) Exclude containerd from Windows Defender Scans
+   Add-MpPreference -ExclusionProcess "$Env:ProgramFiles\containerd\containerd.exe"
+   ```


I usually prefer each command to typically be its own code section (unless relevant commands can be grouped in order for the text description to explain things more effectively) with a description above it and the comments can be put as text and not as comments.

Please use this for reference.

# (Optional - but highly recommended) Exclude containerd from Windows Defender Scans: Please describe why this is recommended.

This piece of code block has also been taken from the documentation here https://github.com/kubernetes/website/blob/main/content/en/docs/setup/production-environment/container-runtimes.md#container-runtimes, but yes I will add more descriptions to make this more clear and if required separately group them.

MadhavJivrajani · 2021-10-21T05:52:38Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+- restart kubelet
+`systemctl start kubelet`
+
+- verify pods are running 
+Run `kubectl get nodes -o wide` and containerd appears as the runtime for the node we just changed.


- configure kubelet to use containerd Edit the file `/var/lib/kubelet/kubeadm-flags.env` and add the containerd runtime to the flags. `--container-runtime=remote` and `--container-runtimeendpoint=unix:///run/containerd/containerd.sock"`

This is not rendered on separate lines if that was your original intent. And same for the ones below and above it as well.

RinkiyaKeDad · 2021-10-21T11:39:02Z

Thanks for working on this! Will take a look from Docs side once the PR is ready to go and not WIP 😄

reylejano · 2021-11-12T01:31:35Z

There is an existing page on how to use containerd
https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd

Debanitrkl · 2021-11-12T03:07:32Z

There is an existing page on how to use containerd https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd

@reylejano this docs has steps for users to shift from dockershim to containerd. The link you provided has the steps to run only containerd, it doesn't specify how to stop and drain node and then change the runtime.

reylejano · 2021-11-12T04:04:01Z

There is an existing page on how to use containerd https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd

@reylejano this docs has steps for users to shift from dockershim to containerd. The link you provided has the steps to run only containerd, it doesn't specify how to stop and drain node and then change the runtime.

@Debanitrkl thank you, looking forward to this PR when it's ready to review

sftim

Hi. Here's some early feedback that I hope helps you make progress.

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

sftim · 2021-11-20T18:05:03Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+- finally if everything goes well remove docker
+```
+apt purge docker-ce docker-ce-cli
+OR
+yum remove docker-ce docker-ce-cli
+```


I would use https://kubernetes.io/docs/contribute/style/hugo-shortcodes/#tabs and have a tab for Debian-heritage systems and another for RedHat-heritage systems.

sftim · 2021-11-20T18:05:50Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+   ```shell
+   sudo systemctl restart containerd
+   ```
+### For windows powershell


Consider splitting this into two task pages, one for Linux nodes and one for Windows nodes.

sftim · 2021-11-20T18:07:49Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+Instructions for setting up the Docker repository for your respective Linux distribution and 
+installing the `containerd.io` package can be found at 
+[Install Docker Engine](https://docs.docker.com/engine/install/#server).


Suggested change

Instructions for setting up the Docker repository for your respective Linux distribution and

installing the `containerd.io` package can be found at

[Install Docker Engine](https://docs.docker.com/engine/install/#server).

You can find instructions for installing `containerd` at

[Starting Containerd](https://containerd.io/docs/getting-started/#starting-containerd).

sftim · 2021-11-20T18:09:29Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+
+Install containerd:
+
+1. Install the `containerd.io` package from the official Docker repositories. 


Why use the Docker repository for this? I would recommend that people fetch it from their
OS distribution or, failing that, from source and build it.

I suspect that telling people to get containerd from Docker is liable to add to the confusion.

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

neolit123

added a few comments that feel like blocking in the current draft and we should resolve them.
but thanks for working on this!

neolit123 · 2021-11-23T15:38:59Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

@@ -0,0 +1,115 @@
+---
+title: "Migrating Container runtime from dockershim to containerd"


this seems to be an opinionated suggestion for transition.
what if the user wishes to use cri-o instead of containerd?

in the CR popularity survey we did before docker was first, followed by containerd and then cri-o.
so if containerd wins here by being second, it makes sense, but cri-o might not be very happy about this.

cc @saschagrunert for feedback on CRI-O.

Thanks for reaching out! I think the whole guide is opinionated to a particular setup, which is probably fine. Mentioning CRI-O as alternative container runtime to containerd would make us very happy, though. 🙃

ok, i think it's worth denoting with a sentence near the top of the guide that this covers an example scenario for migrating from dockershim to containerd and that alternative container runtime such as cri-o can be picked from the https://kubernetes.io/docs/setup/production-environment/container-runtimes/ page.

That sounds like a good way to head off issues around https://kubernetes.io/docs/contribute/style/content-guide/#third-party-content

We make an exception for container runtimes - these are necessary out-of-project packages that you must have to make a working Kubernetes cluster - but we don't like to be in the business of picking favorites.

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

neolit123 · 2021-11-23T15:58:58Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md

+### For linux systems
+Use the following commands to install Containerd on your system:
+
+Install and configure prerequisites:


the guide seems to be duplicating steps that already existing the in the "installing a container runtime" page:
https://kubernetes.io/docs/setup/production-environment/container-runtimes/
instead we can cross-link.

the steps can be generalized as:

drain node

stop kubelet

uninstall old CR

install new CR (CR of your chose, not picking a preference in this page, cross-link to the main CR page)

update kubelet config and kubeadm bits (optional)

restart kubelet

uncordon node

check if the node / pods work

i know that it works and i've seen users already do it, but before we merge such a guide for hotswap SIG node must tell us if this is even supported and if something unpredictable can happen. cgroup (drivers)? proper cleanup after uninstalling the old CR - logs, container state, etc?

cc @SergeyKanzhelev

I think we do want a “dummies guide to” here, because the Docker deprecation is already worrying quite a few people.

sftim

BTW please make the filename lowercase (change content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md to content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime.md)

or, much better (it leaves room for alternatives):
content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md

Debanitrkl · 2022-02-04T13:24:17Z

I have updated with some final changes and also have started a hackmd file here for ease of reviewing.

sftim

Hi @Debanitrkl

This PR is going to need some work before we can merge it. I've added suggestions and feedback inline.

if you have questions about what to write, please feel free to ask them.

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md

Previous review was stale

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md

tengqm · 2022-02-09T03:58:11Z

/label tide/merge-method-squash

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md

tengqm · 2022-02-11T04:07:47Z

/lgtm

k8s-ci-robot · 2022-02-11T04:08:05Z

LGTM label has been added.

Git tree hash: b196437c02cd1647d921d13f735357270cf3bd0d

sftim

/approve

sftim · 2022-02-11T12:34:05Z

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md

+
+## Remove Docker Engine
+
+{{% thirdparty-content %}}


nit: not needed as the page already has this disclaimer

k8s-ci-robot · 2022-02-11T12:37:09Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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~~ [sftim]

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

Debanitrkl · 2022-02-11T13:03:31Z

@sftim just a small doubt I haven't added the author and reviewer names and the dates wasn't that required

shannonxtreme · 2022-02-11T13:11:26Z

Pretty sure those are for blog posts and not technical docs 🙂

…

On Fri., Feb. 11, 2022, 08:03 Debabrata Panigrahi, ***@***.***> wrote: @sftim <https://github.com/sftim> just a small doubt I haven't added the author and reviewer names and the dates wasn't that required — Reply to this email directly, view it on GitHub <#30141 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHH4EFWFRPJDEJG5Q4I4PF3U2UCLDANCNFSM5GJB74XQ> . You are receiving this because you commented.Message ID: ***@***.***>

Docs to change Container runtime

1ad36f6

k8s-ci-robot assigned adisky Oct 19, 2021

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. 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 Oct 19, 2021

k8s-ci-robot requested review from kbhawkey and tengqm October 19, 2021 12:49

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 Oct 19, 2021

Updated header

1a5066b

adisky reviewed Oct 20, 2021

View reviewed changes

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/Change-runtime.md Outdated Show resolved Hide resolved

k8s-ci-robot requested a review from MadhavJivrajani October 20, 2021 12:48

Updated header

63f34ed

MadhavJivrajani reviewed Oct 21, 2021

View reviewed changes

k8s-ci-robot requested a review from RinkiyaKeDad October 21, 2021 05:55

sftim reviewed Nov 20, 2021

View reviewed changes

neolit123 reviewed Nov 23, 2021

View reviewed changes

neolit123 mentioned this pull request Nov 23, 2021

decide how to handle the breakout of the dockershim from the kubelet. kubernetes/kubeadm#1412

Closed

sftim previously requested changes Nov 23, 2021

View reviewed changes

sftim reviewed Feb 4, 2022

View reviewed changes

Added instructions to remove docker engine

36ad07c

tengqm reviewed Feb 7, 2022

View reviewed changes

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md Outdated Show resolved Hide resolved

tengqm reviewed Feb 7, 2022

View reviewed changes

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md Outdated Show resolved Hide resolved

Debanitrkl added 2 commits February 7, 2022 11:11

Minor changes

704bf04

Minor updates on heading

ec48473

tengqm reviewed Feb 7, 2022

View reviewed changes

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md Outdated Show resolved Hide resolved

tengqm reviewed Feb 7, 2022

View reviewed changes

Minor updates on lists

8b73923

tengqm reviewed Feb 9, 2022

View reviewed changes

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md Outdated Show resolved Hide resolved

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Feb 9, 2022

Minor updates on line 106

7dc0d47

tengqm reviewed Feb 10, 2022

View reviewed changes

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md Outdated Show resolved Hide resolved

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/change-runtime-containerd.md Outdated Show resolved Hide resolved

Minor updates on line 106

c38dc24

k8s-ci-robot assigned tengqm Feb 11, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 11, 2022

sftim reviewed Feb 11, 2022

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 11, 2022

k8s-ci-robot merged commit b03dfa8 into kubernetes:main Feb 11, 2022

Debanitrkl deleted the deba_dockershim branch February 11, 2022 14:00

afbjorklund mentioned this pull request Mar 9, 2022

Dockershim removal feedback & issues kubernetes/kubernetes#106917

Closed


		Install containerd:

		1. Install the `containerd.io` package from the official Docker repositories.

		@@ -0,0 +1,115 @@
		---
		title: "Migrating Container runtime from dockershim to containerd"

Docs to change Container runtime #30141

Docs to change Container runtime #30141

Conversation

Debanitrkl commented Oct 19, 2021

netlify bot commented Oct 19, 2021 • edited Loading

Debanitrkl commented Oct 19, 2021

adisky commented Oct 20, 2021

adisky commented Oct 20, 2021

Debanitrkl commented Oct 20, 2021

adisky commented Oct 20, 2021

adisky left a comment

Choose a reason for hiding this comment

adisky commented Oct 20, 2021

MadhavJivrajani left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MadhavJivrajani Oct 21, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MadhavJivrajani Oct 21, 2021 • edited Loading

Choose a reason for hiding this comment

RinkiyaKeDad commented Oct 21, 2021

reylejano commented Nov 12, 2021

Debanitrkl commented Nov 12, 2021

reylejano commented Nov 12, 2021

sftim left a 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

Choose a reason for hiding this comment

neolit123 left a comment

Choose a reason for hiding this comment

neolit123 Nov 23, 2021 • edited Loading

Choose a reason for hiding this comment

saschagrunert Nov 23, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 Nov 23, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

Debanitrkl commented Feb 4, 2022

sftim left a comment

Choose a reason for hiding this comment

tengqm commented Feb 9, 2022

tengqm commented Feb 11, 2022

k8s-ci-robot commented Feb 11, 2022

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 11, 2022

Debanitrkl commented Feb 11, 2022

shannonxtreme commented Feb 11, 2022 via email

netlify bot commented Oct 19, 2021 •

edited

Loading

MadhavJivrajani left a comment •

edited

Loading

MadhavJivrajani Oct 21, 2021 •

edited

Loading

MadhavJivrajani Oct 21, 2021 •

edited

Loading

neolit123 Nov 23, 2021 •

edited

Loading

saschagrunert Nov 23, 2021 •

edited

Loading

neolit123 Nov 23, 2021 •

edited

Loading