Skip to content

Add config API for kubelet stats v1alpha1#50394

Closed
tengqm wants to merge 1 commit intokubernetes:mainfrom
tengqm:add-kube-stats-api
Closed

Add config API for kubelet stats v1alpha1#50394
tengqm wants to merge 1 commit intokubernetes:mainfrom
tengqm:add-kube-stats-api

Conversation

@tengqm
Copy link
Copy Markdown
Contributor

@tengqm tengqm commented Apr 5, 2025

No description provided.

@k8s-ci-robot
Copy link
Copy Markdown
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 ask for approval from tengqm. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 5, 2025
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 5, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 5, 2025

Pull request preview available for checking

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

[kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
[kubelet configuration (v1)](/docs/reference/config-api/kubelet-config.v1/)
* [kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/)
* [kubelet stats (v1)](/docs/reference/config-api/kubelet-stats.v1/)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

s/v1/v1alpha1

</td>
</tr>
</tbody>
</table>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

PSI fields seem to be missing

@tengqm tengqm force-pushed the add-kube-stats-api branch from e8381a0 to 674ff5b Compare April 9, 2025 13:49
Copy link
Copy Markdown
Member

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

This reference, whilst useful, doesn't look like a reference for a configuration file format.

I think it belongs within https://kubernetes.io/docs/reference/node/ or https://kubernetes.io/docs/reference/instrumentation/
(whichever one we pick, it'd be nice to have both those URLs link to the new reference).

@tengqm, what do you think? Do you agree that this isn't an application programming interface and isn't a configuration file format?

Comment on lines +1 to +2


Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I expected to see front matter here.

@tengqm
Copy link
Copy Markdown
Contributor Author

tengqm commented Apr 14, 2025

@lmktfy No. This is not an API for programming "configuration", but it is an API for parsing the kubelet /stats/summary output, which is a JSON. It depends on how we define "configuration".

@lmktfy
Copy link
Copy Markdown
Member

lmktfy commented Apr 20, 2025

I don't like the idea of calling this an application programming interface. It's an interface but not b really one you invoke from code.

I appreciate that we (Kubernetes) currently use the term "API" in our configuration file formats, but I worry about the risk of confusing readers.

I remember the first time I encountered the Kubernetes docs and, back then, I felt they were so poor that I couldn't make sense of Kubernetes. My concern has that kind of newbie reader and their interests at heart.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 21, 2025
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

PR needs rebase.

Details

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.

@tengqm tengqm closed this May 22, 2025
@tengqm tengqm deleted the add-kube-stats-api branch May 22, 2025 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants