Revise “Container runtimes” page in light of dockershim removal #30882

PranshuSrivastava · 2021-12-12T17:06:12Z

This updates the container-runtimes [page](https://kubernetes.io/docs/setup/production-environment/container-runtimes/ of the website to include information about the Dockershim deprecation and so that the users can take an informed decision. This is in accordance with #28449

PranshuSrivastava · 2021-12-12T17:06:32Z

/cc @sftim

PranshuSrivastava · 2021-12-12T17:08:18Z

@sftim I had to keep the links this way because they were not being rendered properly if I broke them in between.

netlify · 2021-12-12T17:19:10Z

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

🔨 Explore the source changes: ed73666

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

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

k8s-triage-robot · 2021-12-12T19:26:27Z

Unknown CLA label state. Rechecking for CLA labels.

Send feedback to sig-contributor-experience at kubernetes/community.

/check-cla

bradtopol · 2021-12-13T21:41:16Z

Hi @mikebrow Can you serve as the technical reviewer for this PR? Just add a /lgtm if it is technically correct and I'll take care of the rest. Thanks.
/cc @mikebrow
/assign

mikebrow

/lgtm

k8s-ci-robot · 2021-12-13T21:52:06Z

LGTM label has been added.

Git tree hash: 49e6f17f10e2dd176c7911f29803128cf504e333

sftim · 2021-12-13T22:18:26Z

/label tide/merge-method-squash

I'd prefer to omit the whitespace changes, but it's going to be easier I think to merge this and then do fixups.

PranshuSrivastava · 2021-12-14T07:05:15Z

/label tide/merge-method-squash

I'd prefer to omit the whitespace changes, but it's going to be easier I think to merge this and then do fixups.

@sftim those whitespace changes are because of my text editor.

chrisnegus · 2021-12-16T18:39:01Z

/assign @celestehorgan

reylejano · 2021-12-22T00:47:06Z

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

@@ -22,6 +22,17 @@ Kubernetes, on Linux:
 - [CRI-O](#cri-o)
 - [Docker](#docker)

+{{< note >}}
+Docker container runtime (Dockershim) has been [deprecated](


This implies that Docker container runtime is deprecated and that dockershim and Docker container runtime are the same.
I suggest more clarity that dockershim is deprecated

@PranshuSrivastava would you be willing to revise the language here?

@sftim @reylejano sorry I missed this review. I have made the change, PTAL.

k8s-ci-robot · 2022-01-18T10:53:28Z

New changes are detected. LGTM label has been removed.

mikebrow · 2022-01-18T15:41:54Z

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

@@ -22,6 +22,17 @@ Kubernetes, on Linux:
 - [CRI-O](#cri-o)
 - [Docker](#docker)

+{{< note >}}
+Dockershim, the module that allowed Kubernetes to interact with Docker has been [deprecated](


suggest "Dockershim, the portion of code in Kubernetes that provided direct integration with Docker in prior releases, has been removed from Kubernetes version 1.24. This removal was announced as a deprecation in Kubernetes v1.20." Then continue with "For more information, .." below

Rather than “has been”, I recommend “was”. The reason is that “has been” suggests it's a recent removal and we prefer the text of documentation to be more timeless (and easier to maintain).

@mikebrow @sftim done.

mikebrow

LGTM

afbjorklund · 2022-02-13T15:54:41Z

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

-installing the `containerd.io` package can be found at 
-[Install Docker Engine](https://docs.docker.com/engine/install/#server).
+1. Install the `containerd.io` package from the [official containerd website](
+   https://containerd.io/downloads/).Instructions for setting up the Docker


You don't need to set up the Docker package repository, if installing from containerd.io.

So either you install the "containerd.io" package from Docker, or you install the "containerd"
package from your distribution (apt install containerd) or download it directly from containerd.io

If you want to keep both options (docker.com and containerd.io), they need to be clearly separated.

we should remove the docker repository from the containerd steps and leave the user two options:

following the guide in https://containerd.io/downloads/ and https://containerd.io/docs/getting-started/#starting-containerd

use the package manager of the Linux distro

Would it be possible to supply deb packages for containerd and runc, the same way as for "cri-tools" and "kubernetes-cni" ?

From apt.kubernetes.io, that is.

They would still need to be configured, but at least wouldn't have to juggle tarballs (and version and arch)

Or are the system ones OK ?

The package management in k8s needs to be community owned. Currently Google still holds the keys. But also some reorganization of the package repositories might be required for better version flexibility. These efforts are WIP.

The containerd maintainers can open a discussion about that with the k8s SIG Release. In the meantime we should document the best existing options, IMO.

Would it be possible to supply deb packages for containerd and runc, the same way as for "cri-tools" and "kubernetes-cni" ?

That's a decision / discussion to happen outside of tech docs. In k/website, we document existing behavior most of all and rarely look to document or decide on future changes. It's fine to plan to document the next release before it comes out, of course.

@PranshuSrivastava I recommend following the approach outlined in #30882 (comment)

@afbjorklund, I'm keen to keep the focus of this PR on just the set of changes we'd make to this page so that the v1.24 docs make sense after the dockershim component is removed. Once this merges, we can consider follow-up PRs that make further improvements.

As the proverb doesn't quite say, the perfect is the enemy of the merged.

I think changing from docker.com to containerd.io would be enough.

It also saves the extra step of having to wipe the containerd config (that disables the cri plugin which is required)

containerd config default | sudo tee /etc/containerd/config.toml

This is done to remove the disabled_plugins = ["cri"] line, that would otherwise interfere with Kubernetes.

When installing containerd from upstream, then this Docker-specific configuration file is not included anymore...

Can we keep containerd installation instructions as they are as they're not actually related to the purpose of this PR? We can update them in a separate PR I believe.

After we remove the dockershim, the current instructions are too likely to confuse people. I think fixing that does align with the intent of this PR.

reylejano · 2022-02-14T07:33:20Z

/remove-language es id it pt ru uk zh

bart0sh · 2022-02-14T10:16:25Z

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

+/blog/2020/12/08/kubernetes-1-20-release-announcement/#dockershim-deprecation)
+You can check out this [documentation](
+/docs/tasks/administer-cluster/migrating-from-dockershim/check-if-dockershim-deprecation-affects-you/)
+to understand how this deprecation might affect you. For migrating from


"to migrate from dockershim" part looks redundant/tautological to me:

For migrating from dockershim ... to migrate from dockershim.

done @bart0sh

@PranshuSrivastava thanks, looks better now.

nate-double-u · 2022-02-21T19:51:40Z

/milestone 1.24

…eprecation.

PranshuSrivastava · 2022-02-28T10:36:19Z

@vincepri PTAL

sftim

It looks like this needs some more changes - I've added inline feedback.

sftim · 2022-02-28T10:44:26Z

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

+Dockershim, the portion of code in Kubernetes that provided direct
+integration with Docker in prior releases, was removed from Kubernetes
+version 1.24. This removal was announced as a [deprecation in Kubernetes v 1.20](
+/blog/2020/12/08/kubernetes-1-20-release-announcement/#dockershim-deprecation)
+You can check out this [documentation](
+/docs/tasks/administer-cluster/migrating-from-dockershim/check-if-dockershim-deprecation-affects-you/)
+to understand how this deprecation might affect you. To migrate from
+dockershim you can follow [this migration guide](
+/docs/tasks/administer-cluster/migrating-from-dockershim/)
+to migrate from dockershim.


Suggested change

Dockershim, the portion of code in Kubernetes that provided direct

integration with Docker in prior releases, was removed from Kubernetes

version 1.24. This removal was announced as a [deprecation in Kubernetes v 1.20](

/blog/2020/12/08/kubernetes-1-20-release-announcement/#dockershim-deprecation)

You can check out this [documentation](

/docs/tasks/administer-cluster/migrating-from-dockershim/check-if-dockershim-deprecation-affects-you/)

to understand how this deprecation might affect you. To migrate from

dockershim you can follow [this migration guide](

/docs/tasks/administer-cluster/migrating-from-dockershim/)

to migrate from dockershim.

Kubernetes releases before v1.24 included a direct integration with Docker Engine,

using a component named _dockershim_. That special direct integration is no longer

part of Kubernetes (this removal was

[announced](/blog/2020/12/08/kubernetes-1-20-release-announcement/#dockershim-deprecation)

as part of the v1.20 release).

You can read

[Check whether Dockershim deprecation affects you](/docs/tasks/administer-cluster/migrating-from-dockershim/check-if-dockershim-deprecation-affects-you/) to understand how this removal might

affect you. To learn about migrating from using dockershim, see

[Migrating from dockershim](/docs/tasks/administer-cluster/migrating-from-dockershim/).

sftim · 2022-02-28T10:49:53Z

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

-The following CRI adaptors are designed to work with Docker Engine:
+{{< note >}}
+`overlay2` is the preferred storage driver for systems running Linux kernel version 4.0 or higher,
+or RHEL or CentOS using version 3.10.0-514 and above.
+{{< /note >}}

 - [`cri-dockerd`](https://github.com/Mirantis/cri-dockerd) from Mirantis


Suggested change

The following CRI adaptors are designed to work with Docker Engine:

{{< note >}}

`overlay2` is the preferred storage driver for systems running Linux kernel version 4.0 or higher,

or RHEL or CentOS using version 3.10.0-514 and above.

{{< /note >}}

- [`cri-dockerd`](https://github.com/Mirantis/cri-dockerd) from Mirantis

You can also find third-party adapters that let you use Docker Engine with Kubernetes

through the supported {{< glossary_tooltip term_id="cri" text="Container Runtime Interface">}}

(CRI).

The following CRI adapters are designed to integrate Docker Engine with CRI clients (such

as Kubernetes v{{< skew currentVersion >}}):

- [`cri-dockerd`](https://github.com/Mirantis/cri-dockerd) from Mirantis

{{< note >}}

If you use Docker Engine on a node that is running Linux kernel version 4.0 or higher, or that

runs RHEL or CentOS and uses the Linux kernel version 3.10.0-514 and above,

the Kubernetes project suggests using the `overlay2` storage driver.

{{< /note >}}

sftim · 2022-03-02T12:37:36Z

/retitle Revise “Container runtimes” page in light of dockershim removal

bradtopol · 2022-03-17T21:32:31Z

Assigning @sftim as the reviewer since he is the one doing the in depth review here.
/unassign
/assign @sftim

sftim · 2022-03-24T17:30:12Z

@PranshuSrivastava would you have time to revise this further?

Another option that we have is to take your existing work and build upon it, merging a different PR that is based on what's here.

reylejano · 2022-03-25T22:02:20Z

@PranshuSrivastava , are you able to continue to review the comments and make revisions to progress this PR?

If not, I agree with @sftim 's comment

PranshuSrivastava · 2022-03-26T14:30:30Z

@reylejano @sftim Yes I have time to work further on this PR. I have addressed all the comments so far and will continue to work on the reviews provided in the following days.

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 12, 2021

k8s-ci-robot requested review from bart0sh and vincepri December 12, 2021 17:06

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Dec 12, 2021

k8s-ci-robot requested a review from sftim December 12, 2021 17:06

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 12, 2021

k8s-ci-robot assigned bradtopol Dec 13, 2021

k8s-ci-robot requested a review from mikebrow December 13, 2021 21:41

mikebrow approved these changes Dec 13, 2021

View reviewed changes

k8s-ci-robot assigned mikebrow Dec 13, 2021

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

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

k8s-ci-robot assigned celestehorgan Dec 16, 2021

reylejano reviewed Dec 22, 2021

View reviewed changes

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 18, 2022

mikebrow reviewed Jan 18, 2022

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 19, 2022

PranshuSrivastava force-pushed the dockershim_deprecation branch from 1f13167 to a339423 Compare January 20, 2022 17:13

mikebrow approved these changes Jan 21, 2022

View reviewed changes

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 23, 2022

afbjorklund reviewed Feb 13, 2022

View reviewed changes

bart0sh reviewed Feb 14, 2022

View reviewed changes

k8s-ci-robot added this to the 1.24 milestone Feb 21, 2022

updated the container-runtime page to include info about dockershim d…

8b1b8a4

…eprecation.

PranshuSrivastava force-pushed the dockershim_deprecation branch from e3d239c to 8b1b8a4 Compare February 22, 2022 06:51

sftim requested changes Feb 28, 2022

View reviewed changes

PranshuSrivastava force-pushed the dockershim_deprecation branch from f4a9699 to 8b1b8a4 Compare February 28, 2022 20:45

k8s-ci-robot changed the title ~~Updated Container-Runtime.md~~ Revise “Container runtimes” page in light of dockershim removal Mar 2, 2022

k8s-ci-robot assigned sftim and unassigned bradtopol Mar 17, 2022

neolit123 mentioned this pull request Mar 23, 2022

Dockershim removal feedback & issues kubernetes/kubernetes#106917

Closed

sftim mentioned this pull request Apr 3, 2022

Revise “Container runtimes” page in light of dockershim removal #32738

Merged

Babapool mentioned this pull request Apr 20, 2022

REQUEST: New membership for Babapool kubernetes/org#3384

Closed

9 tasks

k8s-ci-robot merged commit 8b1b8a4 into kubernetes:dev-1.24 Apr 20, 2022

Revise “Container runtimes” page in light of dockershim removal #30882

Revise “Container runtimes” page in light of dockershim removal #30882

Conversation

PranshuSrivastava commented Dec 12, 2021

PranshuSrivastava commented Dec 12, 2021

PranshuSrivastava commented Dec 12, 2021

netlify bot commented Dec 12, 2021 • edited Loading

k8s-triage-robot commented Dec 12, 2021

bradtopol commented Dec 13, 2021

mikebrow left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 13, 2021

sftim commented Dec 13, 2021

PranshuSrivastava commented Dec 14, 2021

chrisnegus commented Dec 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 18, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikebrow left a comment

Choose a reason for hiding this comment

afbjorklund Feb 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afbjorklund Mar 1, 2022 • edited Loading

Choose a reason for hiding this comment

neolit123 Mar 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afbjorklund Mar 1, 2022 • edited Loading

Choose a reason for hiding this comment

bart0sh Mar 2, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reylejano commented Feb 14, 2022

bart0sh Feb 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nate-double-u commented Feb 21, 2022

PranshuSrivastava commented Feb 28, 2022

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

sftim commented Mar 2, 2022

bradtopol commented Mar 17, 2022

sftim commented Mar 24, 2022

reylejano commented Mar 25, 2022

PranshuSrivastava commented Mar 26, 2022

netlify bot commented Dec 12, 2021 •

edited

Loading

afbjorklund Feb 13, 2022 •

edited

Loading

afbjorklund Mar 1, 2022 •

edited

Loading

neolit123 Mar 1, 2022 •

edited

Loading

afbjorklund Mar 1, 2022 •

edited

Loading

bart0sh Mar 2, 2022 •

edited

Loading

bart0sh Feb 14, 2022 •

edited

Loading