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

cgroup v1 maintenance mode #46801

Closed
wants to merge 1 commit into from
Closed

Conversation

harche
Copy link
Contributor

@harche harche commented Jun 12, 2024

Documentation for transitioning cgroup v1 in maintenance mode.

@k8s-ci-robot k8s-ci-robot added this to the 1.31 milestone Jun 12, 2024
@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. labels Jun 12, 2024
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jun 12, 2024
Copy link

netlify bot commented Jun 12, 2024

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit 0f9497e
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6696964b7f4b1f0008fb2c74

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jun 12, 2024
@k8s-ci-robot k8s-ci-robot requested review from reylejano and tengqm June 12, 2024 15:59
Copy link

netlify bot commented Jun 12, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 186bdf9
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/669693c612a70800087d32a0
😎 Deploy Preview https://deploy-preview-46801--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 configuration.

@hacktivist123
Copy link
Contributor

Hello @harche 👋 please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday, July 16th, 2024 18:00 PST. Thank you!

@Princesso
Copy link
Contributor

Hi @harche, a gentle reminder that tomorrow is the deadline for having your Docs PR ready for review. Please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before tomorrow, Tuesday, July 16th, 2024 18:00 PST.

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/blog Issues or PRs related to the Kubernetes Blog subproject area/localization General issues or PRs related to localization language/bn Issues or PRs related to Bengali language language/en Issues or PRs related to English language language/es Issues or PRs related to Spanish language language/ja Issues or PRs related to Japanese language language/zh Issues or PRs related to Chinese language and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 16, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign salaxander for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 16, 2024
@harche
Copy link
Contributor Author

harche commented Jul 16, 2024

/hold till kubernetes/kubernetes#126031 merges.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 16, 2024
Signed-off-by: Harshal Patil <harpatil@redhat.com>
@harche
Copy link
Contributor Author

harche commented Jul 16, 2024

@Princesso @hacktivist123 this PR is ready for review. Thanks.

<!-- steps -->


## Why switch to cgroup v2?
Copy link
Contributor

Choose a reason for hiding this comment

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

You may want to link something to what cgroups are before diving into the details. I'm sure there's content on the website already, but a quick link will give the audience the background needed quickly

@tengqm
Copy link
Contributor

tengqm commented Jul 17, 2024

My feeling is that this content is more suitable to be a blog post. It is not a concept explanation and it is not a task showing users how to do this switching.

@harche
Copy link
Contributor Author

harche commented Jul 17, 2024

@tengqm in the section ## Failing on cgroup v1 Nodes at the bottom I tried to explain how to use newly added kubelet flag.

@harche
Copy link
Contributor Author

harche commented Jul 17, 2024

Also the section ## How to Determine the cgroup Version Used by Your Nodes explains how to use newly added kubelet metric.

@tengqm
Copy link
Contributor

tengqm commented Jul 18, 2024

@harche There are two options for this piece of information as I see it. You can create a blog page introducing the work behind this cgroup v1->v2 change. For example, what does cgroups mean, why v1 is put into maintenance mode, why v2 is better than v1, so on and so forth. You can provide suggestions how to check the version used and how to make the change in the blog.

Another option is to add a task page. The task is about switch from cgroup v1 to v2, period. The task is not about putting v1 into maintenance mode. In a task page, you are talking to the users, not the developers. You can still provide some simple English explanation about the background, but you may want to skip the developer's story.

@hacktivist123
Copy link
Contributor

@harche There are two options for this piece of information as I see it. You can create a blog page introducing the work behind this cgroup v1->v2 change. For example, what does cgroups mean, why v1 is put into maintenance mode, why v2 is better than v1, so on and so forth. You can provide suggestions how to check the version used and how to make the change in the blog.

Another option is to add a task page. The task is about switch from cgroup v1 to v2, period. The task is not about putting v1 into maintenance mode. In a task page, you are talking to the users, not the developers. You can still provide some simple English explanation about the background, but you may want to skip the developer's story.

I agree with this @harche, thanks for your insight @tengqm! I'd say we stick to option one.

However @tengqm do you think it would make sense to have the proposed blog post linked somewhere in the docs?

@Princesso
Copy link
Contributor

Hi @harche, I see this PR is already being reviewed. Can you move it out of Drafts? Thank you!

@tengqm
Copy link
Contributor

tengqm commented Jul 18, 2024

However @tengqm do you think it would make sense to have the proposed blog post linked somewhere in the docs?

It is totally fine to have docs linked to blogs and vice versa.

@harche harche marked this pull request as ready for review July 18, 2024 13:45
@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 Jul 18, 2024
@sftim
Copy link
Contributor

sftim commented Jul 18, 2024

@harche I notice that:

  • the PR doesn't build
  • there's no PR description

You should fix both of these details; it will help reviewers if you do.

Comment on lines +1 to +2
--- title: Moving cgroup v1 support into maintenance mode
min-kubernetes-server-version: 1.31 content_type: task weight: 90 ---
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
--- title: Moving cgroup v1 support into maintenance mode
min-kubernetes-server-version: 1.31 content_type: task weight: 90 ---
---
title: Moving cgroup v1 support into maintenance mode
min-kubernetes-server-version: 1.31
content_type: task
weight: 90
---

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for that pointer.

@harche
Copy link
Contributor Author

harche commented Jul 19, 2024

@harche There are two options for this piece of information as I see it. You can create a blog page introducing the work behind this cgroup v1->v2 change. For example, what does cgroups mean, why v1 is put into maintenance mode, why v2 is better than v1, so on and so forth. You can provide suggestions how to check the version used and how to make the change in the blog.

Another option is to add a task page. The task is about switch from cgroup v1 to v2, period. The task is not about putting v1 into maintenance mode. In a task page, you are talking to the users, not the developers. You can still provide some simple English explanation about the background, but you may want to skip the developer's story.

@tengqm Switching from cgroup v1 to v2 is beyond the scope of Kubernetes itself; it’s something that OS administrators need to handle.

We haven't added any cgroup version-specific features; instead, we've put cgroup v1 into maintenance mode to encourage users to transition to cgroup v2.

Given the feedback I've received so far, would it be acceptable to close this PR and move all its content to a blog post (as part of this PR)?

@tengqm
Copy link
Contributor

tengqm commented Jul 19, 2024

My suggestion would be drafting a blog post for this.

@hacktivist123
Copy link
Contributor

Hello @harche 👋! I'm reaching out from the Docs team. Just checking in as we approach Docs Freeze on Tuesday, July 30th 18:00 PDT. This documentation appears to still be under review. To meet the Docs Freeze, this PR must have a technical review as well as lgtm and approve labels applied, without any unaddressed comments or concerns from SIG Docs. The status of this enhancement is marked as at risk for docs freeze. Thank you

## How to Determine the cgroup Version Used by Your Nodes

To find out which version of cgroup your cluster nodes are using, refer to
the `kubelet_cgroup_version` metric. For nodes running Linux, this metric
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we mention another way to determine cgroup? We introduce this metric in 1.31 so it may be misleading since this metric isn't in every supported version of kubernetes.

@harche
Copy link
Contributor Author

harche commented Jul 24, 2024

My suggestion would be drafting a blog post for this.

Alright, based on the feedback so far I am closing this PR and would rather focus on a blog post PR - #47069

/close

@k8s-ci-robot
Copy link
Contributor

@harche: Closed this PR.

In response to this:

My suggestion would be drafting a blog post for this.

Alright, based on the feedback so far I am closing this PR and would rather focus on a blog post PR - #47069

/close

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-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/blog Issues or PRs related to the Kubernetes Blog subproject area/localization General issues or PRs related to localization cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/bn Issues or PRs related to Bengali language language/en Issues or PRs related to English language language/es Issues or PRs related to Spanish language language/ja Issues or PRs related to Japanese language language/zh Issues or PRs related to Chinese language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants