-
Notifications
You must be signed in to change notification settings - Fork 14.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
kubeadm: adapt docs for 1.24 and dockershim removal #31309
kubeadm: adapt docs for 1.24 and dockershim removal #31309
Conversation
/sig cluster-lifecycle |
83c9408
to
06e6d2c
Compare
👷 Deploy Preview for kubernetes-io-vnext-staging processing. 🔨 Explore the source changes: 3184c22 🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/61f026fa64c005000873e1e9 |
/sig windows |
✔️ Deploy Preview for kubernetes-io-main-staging ready! 🔨 Explore the source changes: 83c9408 🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/61df04191c0650000769094a 😎 Browse the preview: https://deploy-preview-31309--kubernetes-io-main-staging.netlify.app |
content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md
Outdated
Show resolved
Hide resolved
content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md
Outdated
Show resolved
Hide resolved
06e6d2c
to
65e25c8
Compare
content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md
Outdated
Show resolved
Hide resolved
content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md
Outdated
Show resolved
Hide resolved
65e25c8
to
2323b19
Compare
content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md
Outdated
Show resolved
Hide resolved
62317d8
to
f125a24
Compare
pushed updates:
|
f125a24
to
01cee23
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
A couple of concerns about changes not linked to the dockershim removal. Just in case we need to revert this change, I'd prefer to have those changes in their own commit. Ideally: a different PR, that targets the appropriate branch (possible main).
content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md
Outdated
Show resolved
Hide resolved
content/en/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm.md
Outdated
Show resolved
Hide resolved
content/en/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm.md
Outdated
Show resolved
Hide resolved
4be8f85
to
078051e
Compare
Docker Engine does not implement the [CRI](/docs/concepts/architecture/cri/) | ||
which is a requirement for a container runtime to work with Kubernetes. | ||
For that reason, an additional service [cri-dockerd](https://github.com/Mirantis/cri-dockerd) | ||
has to be installed. cri-dockerd is a new project based on the legacy built-in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: avoid calling things “new” (it creates a follow-up task to reword for the next release).
Maybe “If you're using Kubernetes v1.24 or newer, ”
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reworded to:
{{< note >}}
Docker Engine does not implement the [CRI](/docs/concepts/architecture/cri/)
which is a requirement for a container runtime to work with Kubernetes.
For that reason, an additional service [cri-dockerd](https://github.com/Mirantis/cri-dockerd)
has to be installed. cri-dockerd is a project based on the legacy built-in
Docker Engine support that was [removed](/dockershim) from the kubelet in version 1.24.
{{< /note >}}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
I'm not confident about signing off the Windows-specific changes; the other parts look good.
content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md
Outdated
Show resolved
Hide resolved
Touch the following files: - Implementation details: remove docker specifics, which is changing in 1.24 - Create cluster: small language cleanup, remove note about 1.24 - Install kubeadm: Include two up-to-date tables for Linux / Windows with known endpoints. Include cri-dockerd. - Kubelet integration: (side cleanup) use "container runtime" instead of "CRI runtime" (which is incorrect). Mention that only updating "--container-runtime-endpoint=.." is required if the user wishes to override the CR on a certain host. Dockershim->CR-foo migration guides would make the "--container-runtime=remote" flag explicit and we want to remove it at some point. - Troubleshooting kubeadm: Remove some instances of Docker troubleshooting that imply docker as default CR, or talk about old Docker versions. Be more generic about container runtimes. - Adding Windows nodes: move the containerd tab before the Docker tab, as containerd is now the default. Remove note about being explicit about --cri-socket. Add note that crictl is required for both Docker and containerd. Add note that cri-dockerd is required if the user wants to use Docker EE on Windows.
078051e
to
3184c22
Compare
/lgtm |
LGTM label has been added. Git tree hash: 36c334d65f901c54dda03eaee5703cf2b0baf9b8
|
``` | ||
|
||
Install Docker | ||
Instructions to do so are available at [Install Docker Engine - Enterprise on Windows Servers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment?tabs=Windows-Server#install-docker). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW, this links to a page stating that
Customers who want to install a container runtime on Windows server are encouraged to transition to either containerd, Moby, or the Mirantis Container Runtime.
Not sure what we should cover. Maybe we should advise readers to install one of those 3 things and then continue? We can cite those as Microsoft's suggested runtimes for Windows servers.
I think cri-dockerd
will work with Moby (Docker Engine without the trademarks) but I'm not sure - I don't actually use Docker very much.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'm not familiar with the Mirantis product line.
follow ups related to Windows nodes can be tracked in:
#31395
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's merge this. It makes the pages much better, even if there's room for more improvement. |
[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:
Approvers can indicate their approval by writing |
Touch the following files:
in 1.24
with known endpoints. Include cri-dockerd.
"CRI runtime" (which is incorrect). Mention that only updating
"--container-runtime-endpoint=.." is required if the user wishes
to override the CR on a certain host. Dockershim->CR-foo migration
guides would make the "--container-runtime=remote" flag explicit
and we want to remove it at some point.
that imply docker as default CR, or talk about old Docker versions.
tab, as containerd is now the default. Remove note about being explicit
about --cri-socket. Add note that crictl is required for both
Docker and containerd. Add note that cri-dockerd is required if
the user wants to use Docker EE on Windows.
xref kubernetes/kubeadm#2626