docs: add kubelet Summary API documentation and fix broken links #51317

jai · 2025-06-21T01:58:41Z

Summary

This PR fixes issue #51177 by creating proper documentation for the kubelet Summary API and updating the dead links to point to it.

What type of PR is this?

/kind bug
/kind documentation

What this PR does / why we need it

The PR addresses the dead link issue in the node-metrics.md file where links to /docs/reference/config-api/kubelet-stats.v1alpha1/ were pointing to a non-existent page.

Following Option 2 from the issue discussion, this PR:

Creates a new comprehensive documentation page for the kubelet Summary API at /docs/reference/instrumentation/kubelet-summary-api.md
Updates the broken links in node-metrics.md to point to the new documentation

Which issue(s) this PR fixes

Fixes #51177
[Potentially] fixes kubernetes/kubernetes#131986

Special notes for your reviewer

The new documentation page covers:

How to access the Summary API endpoint
The structure of the API response
Available metrics at node, pod, and container levels
Data sources (cAdvisor vs CRI)
Common use cases
Limitations and migration notes

This approach provides users with comprehensive documentation about the kubelet Summary API rather than just removing the link or pointing to external source code.

🤖 Generated with Claude Code

k8s-ci-robot · 2025-06-21T01:58:55Z

[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 katcosgrove for approval. For more information see the 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:

content/en/docs/OWNERS

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

This commit addresses issue 51177 by: - Creating a new documentation page for the kubelet Summary API at /docs/reference/instrumentation/kubelet-summary-api.md - Updating the broken links in node-metrics.md to point to the new page instead of the non-existent /docs/reference/config-api/kubelet-stats.v1alpha1/ The new page provides comprehensive documentation about: - How to access the Summary API - The structure of the API response - Available metrics at node, pod, and container levels - Common use cases and limitations This approach follows Option 2 from the issue discussion, creating proper documentation for the kubelet node stats and pod stats API rather than just removing the link. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

netlify · 2025-06-21T02:07:43Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`e1b557e`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/685611d4aab3d1000840a929
😎 Deploy Preview	https://deploy-preview-51317--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-06-21T02:18:24Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`cd08ca9`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/68564d7d7ce45f0008a352ea
😎 Deploy Preview	https://deploy-preview-51317--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

content/en/docs/reference/instrumentation/kubelet-summary-api.md

jai · 2025-06-21T07:47:53Z

content/en/docs/reference/instrumentation/kubelet-summary-api.md

+
+## Metrics Categories
+
+### Node-Level Metrics


are these section breakdowns too much detail - should we just mention at a high level across all scopes (Node/Pod/Container)?

lmktfy · 2025-06-22T14:39:46Z

/kind feature
(we're adding docs)
/remove-kind bug

lmktfy

I have a concern about the security advice in this PR. I want to ensure we add a warning (not just a note) about turning off trust anchor checks.

That's the only must-fix thing; other details and suggestions I've made are relevant, but we can skip them or fix them after this PR merges.

content/en/docs/reference/instrumentation/kubelet-summary-api.md

lmktfy · 2025-06-22T14:57:59Z

🤖 Generated with Claude Code

Also, we may not be able to accept this. What copyright license applies to the content produced with Claude?

jai · 2025-06-22T15:17:15Z

What copyright license applies to the content produced with Claude?

I believe it's public domain but not sure how to officially prove that.

I can rewrite it if needed of course.

lmktfy · 2025-07-04T08:54:50Z

Any news on the copyright and licence status?

jai · 2025-07-24T04:25:05Z

Any news on the copyright and licence status?

Hey @lmktfy sorry for the radio silence.

Anthropic agrees that Customer (a) retains all rights to its Inputs, and (b) owns its Outputs.
...
Anthropic hereby assigns to Customer its right, title and interest (if any) in and to Outputs.

anthropic commercial terms

They key here is "if any" - it seems US copyright law is not black and white on this and copyright claims are stronger the more a human is involved in the process. Considering I guided most of the implementation and had Claude fill/format, my understanding is that the IP here is vested to me (and from me to the k8s org).

Let me know if this works for us or if I should just re-write/paraphrase all the content manually?

- Convert note to warning box for security concerns about curl --insecure - Add kubectl authorization comment and API server glossary tooltip - Update all section headings per style guide (## Data sources, etc.) - Convert metric lists to Markdown description lists with backticks - Add container structure to JSON example for clarity - Update authorization text to be generic (not RBAC-specific) - Clarify that Summary API returns JSON format only - Add vertical pod autoscaling link - Update data format limitation text to mention OpenMetrics/Prometheus

jai · 2025-07-25T02:25:27Z

Will check why CI is failing

jai · 2025-08-06T04:41:02Z

Will check why CI is failing

Looks like it's a secret detected, unrelated to this change

k8s-ci-robot · 2025-08-29T00:08:35Z

PR needs rebase.

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.

k8s-ci-robot requested review from dipesh-rawat and lmktfy June 21, 2025 01:58

k8s-ci-robot added the language/en Issues or PRs related to English language label Jun 21, 2025

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 21, 2025

jai force-pushed the fix-kubelet-summary-api-dead-link branch from e1b557e to 6c0b2e4 Compare June 21, 2025 02:01

jai changed the title ~~Fix dead link in node-metrics.md by creating kubelet Summary API documentation~~ docs: add kubelet Summary API documentation and fix broken links Jun 21, 2025

jai force-pushed the fix-kubelet-summary-api-dead-link branch from 6c0b2e4 to fba1c3d Compare June 21, 2025 02:02

k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jun 21, 2025

📝 docs: enhance security warning for curl -k flag in kubelet Summary API

cd08ca9

jai commented Jun 21, 2025

View reviewed changes

content/en/docs/reference/instrumentation/kubelet-summary-api.md Show resolved Hide resolved

jai commented Jun 21, 2025

View reviewed changes

jai mentioned this pull request Jun 21, 2025

corrected route for Summary API #51194

Open

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. and removed kind/bug Categorizes issue or PR as related to a bug. labels Jun 22, 2025

lmktfy reviewed Jun 22, 2025

View reviewed changes

jai requested a review from lmktfy July 24, 2025 05:13

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 29, 2025

docs: add kubelet Summary API documentation and fix broken links #51317

Are you sure you want to change the base?

docs: add kubelet Summary API documentation and fix broken links #51317

Uh oh!

Conversation

jai commented Jun 21, 2025 • edited by lmktfy Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What type of PR is this?

What this PR does / why we need it

Which issue(s) this PR fixes

Special notes for your reviewer

Uh oh!

k8s-ci-robot commented Jun 21, 2025

Uh oh!

netlify bot commented Jun 21, 2025

✅ Pull request preview available for checking

Uh oh!

netlify bot commented Jun 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Pull request preview available for checking

Uh oh!

Uh oh!

jai Jun 21, 2025

Choose a reason for hiding this comment

Uh oh!

lmktfy commented Jun 22, 2025

Uh oh!

lmktfy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lmktfy commented Jun 22, 2025

Uh oh!

jai commented Jun 22, 2025

Uh oh!

lmktfy commented Jul 4, 2025

Uh oh!

jai commented Jul 24, 2025

Uh oh!

jai commented Jul 25, 2025

Uh oh!

jai commented Aug 6, 2025

Uh oh!

k8s-ci-robot commented Aug 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jai commented Jun 21, 2025 •

edited by lmktfy

Loading

netlify bot commented Jun 21, 2025 •

edited

Loading