Skip to content

Conversation

@haircommander
Copy link
Contributor

Description

Issue

Closes: #

@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 Feb 25, 2025
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 25, 2025
@netlify
Copy link

netlify bot commented Feb 25, 2025

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

Name Link
🔨 Latest commit f9ff985
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/67f3f6b5a3f15a00082e310e

@netlify
Copy link

netlify bot commented Feb 25, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit f9ff985
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67f3f6b56692c400084fcc3a
😎 Deploy Preview https://deploy-preview-49895--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.

@rayandas
Copy link
Member

Hello @haircommander 👋 please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday 25th March 2025 18:00 PDT. Thank you!

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 25, 2025
@roycaihw
Copy link
Member

Hi @rayandas, I've updated the PR with the documentation content. This PR is ready for review. PTAL. @haircommander Could you update the state of the PR from Draft to Ready for review?

@haircommander haircommander marked this pull request as ready for review March 26, 2025 20:04
@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 Mar 26, 2025
@haircommander haircommander changed the title draft 4205 doc update KEP-4205: update for alpha release in 1.33 Mar 26, 2025
@haircommander
Copy link
Contributor Author

LGTM!

@Urvashi0109
Copy link
Contributor

Urvashi0109 commented Apr 3, 2025

Hello @roycaihw 👋! I'm reaching out from the Docs team. Just checking in as we approach Docs Freeze on 8th April, 2025 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!


{{< feature-state for_k8s_version="v1.33" state="alpha" >}}

As an alpha feature, Kubernetes lets you configure Kubelet to collect Linux kernel [Pressure Stall Information](https://docs.kernel.org/accounting/psi.html)
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 any requirements on kernel for this?

Copy link
Member

Choose a reason for hiding this comment

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

Good point! I added kernel version requirement to the docs.

@kannon92
Copy link
Contributor

kannon92 commented Apr 3, 2025

/lgtm

One nit but it is not blocking.

https://github.com/kubernetes/website/pull/49895/files#r2027079949

Technical review is complete on this @Urvashi0109!

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

LGTM label has been added.

DetailsGit tree hash: 28ea715784c8a3c0b231281ecebe0b27b028def8

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 3, 2025
@k8s-ci-robot k8s-ci-robot requested a review from kannon92 April 3, 2025 21:01
@roycaihw
Copy link
Member

roycaihw commented Apr 3, 2025

@Princesso @RainbowMango Could you help review this PR? Thank you!

Comment on lines 184 to 185
As an alpha feature, Kubernetes lets you configure Kubelet to collect Linux kernel [Pressure Stall Information](https://docs.kernel.org/accounting/psi.html)
(PSI) for CPU, memory and IO usage. The information is collected at node, pod and container level. The metrics are exposed at the `/metrics/cadvisor` endpoint with the following names:
Copy link
Contributor

Choose a reason for hiding this comment

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

Please wrap these long lines as we do for other paragraphs.
See sembr.org for the suggested line breaking style.

Suggested change
As an alpha feature, Kubernetes lets you configure Kubelet to collect Linux kernel [Pressure Stall Information](https://docs.kernel.org/accounting/psi.html)
(PSI) for CPU, memory and IO usage. The information is collected at node, pod and container level. The metrics are exposed at the `/metrics/cadvisor` endpoint with the following names:
As an alpha feature, Kubernetes lets you configure Kubelet to collect Linux kernel
[Pressure Stall Information](https://docs.kernel.org/accounting/psi.html)(PSI)
for CPU, memory and I/O usage.
The information is collected at node, pod and container level.
The metrics are exposed at the `/metrics/cadvisor` endpoint with the following names:

container_pressure_io_waiting_seconds_total
```

You must enable the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) to use this feature. The information is also exposed in the [Summary API](/docs/reference/instrumentation/node-metrics#psi).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You must enable the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) to use this feature. The information is also exposed in the [Summary API](/docs/reference/instrumentation/node-metrics#psi).
You must enable the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
to use this feature. The information is also exposed in the
[Summary API](/docs/reference/instrumentation/node-metrics#psi).

defaultValue: false
fromVersion: "1.33"
---
Enable Kubelet to surface Pressure Stall Information (PSI) metrics in the Summary API and Prometheus metrics.
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't write "Kubelet", we write "kubelet".


{{< feature-state for_k8s_version="v1.33" state="alpha" >}}

As an alpha feature, Kubernetes lets you configure Kubelet to collect Linux kernel [Pressure Stall Information](https://docs.kernel.org/accounting/psi.html) (PSI) for CPU, memory and IO usage. The information is collected at node, pod and container level. See [Summary API](https://github.com/kubernetes/kubernetes/blob/ef838fcc3fa3b43c2e67b4e43d71b6720fc61898/staging/src/k8s.io/kubelet/pkg/apis/stats/v1alpha1/types.go#L281-L300) for detailed schema. You must enable the `KubeletPSI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) to use this feature. The information is also exposed in [Prometheus metrics](/docs/concepts/cluster-administration/system-metrics#psi-metrics).
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Break the long "lines".
  2. Avoid pointing users to the Go source code for the Summary API. We can add a config API reference for this.

Copy link
Member

Choose a reason for hiding this comment

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

Done. I switched the Go source code link with https://pkg.go.dev/k8s.io/kubelet/pkg/apis/stats/v1alpha1. PTAL

Copy link
Contributor

Choose a reason for hiding this comment

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

Add this: #50394

Copy link
Member

Choose a reason for hiding this comment

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

Thank you! Done.

@rayandas
Copy link
Member

rayandas commented Apr 8, 2025

@kannon92 Could you pleas give another lgtm? The previous one was removed because of a new commit.
@tengqm The suggested changes were address. This could use another review. Thanks!

@tengqm
Copy link
Contributor

tengqm commented Apr 8, 2025

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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 8, 2025
@rayandas
Copy link
Member

rayandas commented Apr 8, 2025

Giving an lgtm as we're near to the Docs Freeze deadline. It was lgtm-ed before however it was removed because of a commit which addressed the Docs review suggestions.
/lgtm

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

LGTM label has been added.

DetailsGit tree hash: 606c3d968671cc530395cdfea208967f3812b331

@k8s-ci-robot k8s-ci-robot merged commit dd4c0a0 into kubernetes:dev-1.33 Apr 8, 2025
6 checks passed
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. 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.

7 participants