Skip to content
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

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

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Apr 3, 2022

This updates the Container Runtimes page of the website to include information about the dockershim deprecation, so that the users can take an informed decision. This helps with issue #28449 and potentially supersedes PR #30882.

@k8s-ci-robot 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 Apr 3, 2022
@k8s-ci-robot k8s-ci-robot requested a review from bart0sh April 3, 2022 11:34
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Apr 3, 2022
@k8s-ci-robot k8s-ci-robot requested a review from vincepri April 3, 2022 11:34
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Apr 3, 2022
@sftim sftim marked this pull request as ready for review April 3, 2022 11:34
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 3, 2022
@sftim
Copy link
Contributor Author

sftim commented Apr 3, 2022

/milestone 1.24

@k8s-ci-robot k8s-ci-robot added this to the 1.24 milestone Apr 3, 2022

- [containerd](#containerd)
- [CRI-O](#cri-o)
- [Docker Engine](#docker)
- [Mirantis Container Runtime](#mcr)

{{< note >}}
For other operating systems, look for documentation specific to your platform.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original content here at least mentions other operating systems. Where this information is relocated?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean OSs other than Linux or Windows?

My thinking is that, given our docs policy on 3rd party content, the container runtimes' docs should cover installs onto various operating systems. If they don't, folks can propose adding it to those docs, not to Kubernetes.

Comment on lines -188 to -197
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why drop these lines?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://kubernetes.io/docs/contribute/style/content-guide/#what-s-allowed basically. We should aim to link to external docs; I'm also happy to see work done on those external docs (and maybe I will do some of that myself).

@netlify
Copy link

netlify bot commented Apr 3, 2022

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

Name Link
🔨 Latest commit ba81191
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6249e6590e3f5500096e3425
😎 Deploy Preview https://deploy-preview-32738--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Co-authored-by: Qiming Teng <[email protected]>
@kbhawkey
Copy link
Contributor

kbhawkey commented Apr 3, 2022

Page preview:
https://deploy-preview-32738--kubernetes-io-main-staging.netlify.app/docs/setup/production-environment/container-runtimes/#docker

{{< /note >}}


<!-- body -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this comment doing here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SIG Docs uses these comments to mark where the introduction ends and the page body starts.

@@ -120,95 +134,51 @@ using the (deprecated) v1alpha2 API instead.

### containerd

This section contains the necessary steps to use containerd as CRI runtime.
This section outlines the necessary steps to use containerd as CRI runtime.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should it be containerd?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need code style for the tool name (which is containerd).

Copy link
Member

@PI-Victor PI-Victor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small nits, otherwise looks good from my end

@kbhawkey
Copy link
Contributor

@sftim, are the changes part of the Dockershim removal updates?

@sftim
Copy link
Contributor Author

sftim commented Apr 12, 2022

are the changes part of the Dockershim removal updates?

Yes, these changes are related to the dockershim removal.

@kbhawkey
Copy link
Contributor

/lgtm

Possibly move to dev-1.24 branch?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 12, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: e605e45325e60394c40a8c06f58a46637290e07d

@sftim
Copy link
Contributor Author

sftim commented Apr 12, 2022

These changes document the story for v1.23

I expect that the existing v1.24 version of this page would “win” the merge conflict. The changes are important because people are still using v1.23 and may want to move away from dockershim already, even though it is only deprecated.

@reylejano
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 12, 2022
@k8s-ci-robot k8s-ci-robot merged commit 89cf5eb into kubernetes:main Apr 12, 2022
@sftim sftim deleted the 20220401_update_container_runtimes_dockershim_removal branch April 12, 2022 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants