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.

Sign up for GitHub

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

Jump to bottom

Migrating from dockershim documentation #25787

Merged
merged 1 commit into from
Jan 27, 2021
Merged

Migrating from dockershim documentation #25787

merged 1 commit into from
Jan 27, 2021

Conversation

SergeyKanzhelev
Copy link
Member

@SergeyKanzhelev SergeyKanzhelev commented Dec 23, 2020 •
edited
Loading

/sig node

Fixes: #25768

This is the first iteration of a migration from dockershim instructions. PR is marked as WIP to collect initial feedback on a structure and content.

KEP: kubernetes/enhancements#2221

@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. sig/node Categorizes an issue or PR as relevant to SIG Node. 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 Dec 23, 2020
@k8s-ci-robot 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 Dec 23, 2020
@SergeyKanzhelev SergeyKanzhelev mentioned this pull request Dec 23, 2020
Closed
@netlify
Copy link

netlify bot commented Dec 23, 2020 •
edited
Loading

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

🔨 Explore the source changes: b10decb

🔍 Inspect the deploy logs: https://app.netlify.com/sites/kubernetes-io-master-staging/deploys/60078a4af9a411000861a069

😎 Browse the preview: https://deploy-preview-25787--kubernetes-io-master-staging.netlify.app

@sftim
Copy link
Contributor

sftim commented Dec 23, 2020

ℹ️ Watch out - you've a space in a path.

sftim
sftim reviewed Dec 23, 2020
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks @SergeyKanzhelev

I've added in a bunch of feedback. I appreciate that this is all WIP so please treat these as hints and not as instructions that you must follow.

...sks/administer-cluster/migrating-from-dockershim/ migrating-telemetry-and-security-agents.md Outdated Show resolved Hide resolved
...sks/administer-cluster/migrating-from-dockershim/ migrating-telemetry-and-security-agents.md Outdated Show resolved Hide resolved
...sks/administer-cluster/migrating-from-dockershim/ migrating-telemetry-and-security-agents.md Outdated Show resolved Hide resolved
...sks/administer-cluster/migrating-from-dockershim/ migrating-telemetry-and-security-agents.md Outdated Show resolved Hide resolved
...sks/administer-cluster/migrating-from-dockershim/ migrating-telemetry-and-security-agents.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/migrating-from-dockershim/find-if-you-affected.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/migrating-from-dockershim/find-if-you-affected.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/migrating-from-dockershim/_index.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/migrating-from-dockershim/_index.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/migrating-from-dockershim/_index.md Outdated Show resolved Hide resolved
@SergeyKanzhelev
Copy link
Member Author

I addressed most of the feedback. I will add more content that I want to have in a first iteration and ping you again. Likely on Monday.

Thank you for your thoughtful review!

@SergeyKanzhelev SergeyKanzhelev changed the title [WIP] Migrating from dockershim documentation Migrating from dockershim documentation Dec 28, 2020
@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 Dec 28, 2020
@SergeyKanzhelev
Copy link
Member Author

Thank you @tengqm and @sftim . I think we can merge it as it is now and I will be working on other pages I wanted later. Can you please make a final review for this part.

Ideas for other tasks in this section:

  • migrating Windows workloads from Dockershim
  • work around the known issues of non-dockershim runtimes
  • transition from docker CLI to crictl
  • building images on kubernetes without Dockershim

@SergeyKanzhelev SergeyKanzhelev mentioned this pull request Dec 29, 2020
Merged
neolit123
neolit123 reviewed Dec 30, 2020
View reviewed changes
Copy link
Member

@neolit123 neolit123 left a comment

Choose a reason for hiding this comment

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

thanks for the write up @SergeyKanzhelev
as i mentioned on the original PR that did the deprecation, i think something important that we need to document is how the users can actually do an in-place swap of the container runtime on node.

@SergeyKanzhelev
Copy link
Member Author

as i mentioned on the original PR that did the deprecation, i think something important that we need to document is how the users can actually do an in-place swap of the container runtime on node.

In-place may be one of the strategies. And vendors/admins would need to configure nodes to enable this. Simple node recreation and drain may be sufficient enough for many users. Similar to how regular upgrade to another k8s version works.

That's said, this PR creates a good place for this task description.

@neolit123
Copy link
Member

In-place may be one of the strategies. And vendors/admins would need to configure nodes to enable this. Simple node recreation and drain may be sufficient enough for many users. Similar to how regular upgrade to another k8s version works.

re-place upgrades are what most hosted vendor solutions are doing.
as part of that process, the vendors could introduce new nodes that have a CR different than Docker.

but bare metal, self-hosted hardware users do in-place upgrades, by draining and upgrading node kubelets.
similar steps would apply if they wish to replace the container runtime.
these users don't have the option to introduce new nodes and ideally we should document the in-place steps for them.

That's said, this PR creates a good place for this task description.

do you have plans to document this as part of this PR?

@SergeyKanzhelev
Copy link
Member Author

do you have plans to document this as part of this PR?

Not in this PR. I have more topics to cover as mentioned in previous comment as well:

  • migrating Windows workloads from Dockershim
  • work around the known issues of non-dockershim runtimes
  • transition from docker CLI to crictl
  • building images on kubernetes without Dockershim

Also I'm not super familiar with how the bare metal in-place upgrades typically work. Do you have any example documentation that I can use for reference? Or maybe we can find somebody knowing these scenarios well to document them.

I cannot tell whether this document is critically important. But if it is, maybe you can send a update for KEP to make it a Step 2 graduation criteria?

@k8s-ci-robot k8s-ci-robot removed the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 13, 2021
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 13, 2021
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 15, 2021
@SergeyKanzhelev SergeyKanzhelev force-pushed the migrateFromDockershim branch 2 times, most recently from 491f015 to 17e1d84 Compare January 19, 2021 23:47
@SergeyKanzhelev
Copy link
Member Author

/assign @ehashman

@sftim @kbhawkey thank you for review. I think I addressed all the feedback. Can we move forward with it?

@sftim sftim dismissed their stale review January 20, 2021 00:10

Superseded

sftim
sftim reviewed Jan 20, 2021
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

@kubernetes/sig-node-pr-reviews how does this look for technical accuracy?

Inline feedback is mainly minor details.

content/en/docs/tasks/administer-cluster/migrating-from-dockershim/_index.md Outdated Show resolved Hide resolved
.../administer-cluster/migrating-from-dockershim/check-if-dockershim-deprecation-affects-you.md Outdated

<!-- overview -->

{{< feature-state for_k8s_version="v1.20" state="deprecated" >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't use the shortcode here.

...asks/administer-cluster/migrating-from-dockershim/migrating-telemetry-and-security-agents.md Outdated Show resolved Hide resolved
...asks/administer-cluster/migrating-from-dockershim/migrating-telemetry-and-security-agents.md Show resolved Hide resolved
@derekwaynecarr
Copy link
Member

this looks good for sig-node technical accuracy.

/lgtm
/approve

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

LGTM label has been added.

Git tree hash: 14133f11c54675f301399cefc9b94e5ec4d7c6b0

@dims
Copy link
Member

dims commented Jan 20, 2021

/lgtm
/approve

@sftim
Copy link
Contributor

sftim commented Jan 20, 2021

/unhold

Content guide concerns are addressed.

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 20, 2021
@sftim
Copy link
Contributor

sftim commented Jan 20, 2021

My concern in https://github.com/kubernetes/website/pull/25787/files#r560586158 is about attracting vandalism. I don't know if that's much of a risk.

@SergeyKanzhelev
Copy link
Member Author

My concern in https://github.com/kubernetes/website/pull/25787/files#r560586158 is about attracting vandalism. I don't know if that's much of a risk.

Google docs keeps history. I will go ahead and create a names snapshot of the doc and will keep them making snapshot for easy recovery from vandalism. I hope this addresses the concern.

@SergeyKanzhelev
Copy link
Member Author

@sftim this is ready to be merged.

@SergeyKanzhelev
Copy link
Member Author

Kindly ping @kbhawkey and @sftim

@tengqm
Copy link
Contributor

tengqm commented Jan 27, 2021

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: derekwaynecarr, dims, tengqm

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 Jan 27, 2021
@k8s-ci-robot k8s-ci-robot merged commit 4f244bc into kubernetes:master Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@neolit123 neolit123 neolit123 left review comments

@kbhawkey kbhawkey kbhawkey left review comments

@tengqm tengqm tengqm left review comments

@sftim sftim sftim left review comments

@onlydole onlydole Awaiting requested review from onlydole

Assignees

@dims dims

@ehashman ehashman

@derekwaynecarr derekwaynecarr

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. sig/node Categorizes an issue or PR as relevant to SIG Node. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Move away from dockershim instructions: create a new section under Tasks
9 participants
@SergeyKanzhelev @sftim @neolit123 @kbhawkey @k8s-ci-robot @derekwaynecarr @dims @tengqm @ehashman