Add docs for metrics.k8s.io graduation to stable by tico88612 · Pull Request #56349 · kubernetes/website

tico88612 · 2026-07-01T15:39:08Z

Docs PR for kubernetes/enhancements#5207

netlify · 2026-07-01T15:39:13Z

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

Name	Link
🔨 Latest commit	`1e6f856`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-io-vnext-staging/deploys/6a70ac3024b4e000086e6728

kernel-kun · 2026-07-01T15:41:23Z

Thanks for opening the placeholder PR @tico88612, we've updated the tracking on our end!

netlify · 2026-07-01T15:41:41Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`1e6f856`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a70ac30855188000802023c
😎 Deploy Preview	https://deploy-preview-56349--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.

lmktfy · 2026-07-11T19:22:37Z

As it's marked WIP already:
/retitle [WIP] Add docs for metrics.k8s.io graduation to stable

jmickey · 2026-07-22T09:58:59Z

Hi @tico88612 👋! v1.37 Docs team here

We noticed that this Pull Request is currently in the Draft state.
If you haven't already, please go ahead and add the required documentation changes and move this PR from a Draft to Open state.

Important

Upcoming Docs Deadlines:

PR Ready for Review: Tuesday 28th July 2026
Docs Freeze: Wednesday 5th August 2026 (AoE) / Thursday 6th August 2026, 12:00 UTC

Thanks!

tico88612 · 2026-07-23T02:50:39Z

cc @richabanker @rexagod @dgrisonnet as SIG Instrumentation Lead

lmktfy

Should we also update:

lmktfy · 2026-07-23T08:24:15Z

 by the core project:

+* [Metrics API (v1)](/docs/reference/external-api/metrics.v1/)
 * [Metrics API (v1beta1)](/docs/reference/external-api/metrics.v1beta1/)


I presume that this one will become deprecated, but still be accepted for some time. Is that right?

It will likely never be deprecated. v1beta1 was the latest version of the feature for a decade so users relied on it as if it was stable

Yes, there are no plans for deprecation at the moment.

Ok. I have raised that with SIG Architecture - it doesn't sound right.

Even if users relied on it as if it was stable we can deprecate.

"Deprecate" means we recommend that where people can stop using it, they do so. I don't know why we wouldn't do that.

lmktfy · 2026-07-23T08:24:16Z

 These are the APIs defined by the Kubernetes project, but are not implemented
 by the core project:

+* [Metrics API (v1)](/docs/reference/external-api/metrics.v1/)


This hyperlink doesn't actually work

A tricky one; we should check that there is a plan to update / add that page

Do I need to add it to this PR? or how to update this? (It looks like it hasn't been updated for 2 years.)

Ask in Slack (#release-docs) to check that there is at least an issue that covers the work required.

We can ship v1.37 even if there is no
https://k8s.io/docs/reference/external-api/metrics.v1/ page – but it shouldn't stay missing long.

Already asked

ref: https://kubernetes.slack.com/archives/C0156PJ62RE/p1785663275611279

lmktfy · 2026-07-23T08:25:51Z

Should we also update https://kubernetes.io/docs/reference/instrumentation/?

is it ok to have the page under both sections?

Different pages, but yes.

I checked the instrumentation section: its landing page does not currently contain Metrics API content. The closest related page is node-metrics, which documents the kubelet /metrics/resource endpoint rather than the aggregated metrics.k8s.io API.

Could you clarify what update you would like to see in this PR? Should I add a new Metrics API entry/page under the instrumentation section, or update node-metrics with a cross-link to the resource metrics pipeline documentation?

SergeyKanzhelev · 2026-07-30T06:57:56Z

/sig instrumentation

dgrisonnet · 2026-07-30T07:14:58Z

For the technical side
/lgtm

kubernetes-prow · 2026-07-30T07:15:06Z

LGTM label has been added.

Details

Git tree hash: d090ee88b2f0075c8b125b814fc033773b63c69d

tico88612 · 2026-08-02T07:28:33Z

https://kubernetes.io/docs/concepts/workloads/autoscaling/horizontal-pod-autoscale/#support-for-metrics-apis

HPA doesn't support the metrics.k8s.io/v1 API yet (it's being worked on and needs to be reviewed by SIG Autoscaling), so there's no need to update this part for now.

lmktfy · 2026-08-02T09:23:07Z

https://kubernetes.io/docs/concepts/workloads/autoscaling/horizontal-pod-autoscale/#support-for-metrics-apis

HPA doesn't support the metrics.k8s.io/v1 API yet (it's being worked on and needs to be reviewed by SIG Autoscaling), so there's no need to update this part for now.

That doesn't sound right.

The update could be to document the limitation: that HPA doesn't support the metrics.k8s.io/v1 API. Readers could end up frustrated if we didn't mention that.

Signed-off-by: ChengHao Yang <17496418+tico88612@users.noreply.github.com>

tico88612 · 2026-08-04T03:16:03Z

The update could be to document the limitation: that HPA doesn't support the metrics.k8s.io/v1 API. Readers could end up frustrated if we didn't mention that.

Added the description.

katcosgrove · 2026-08-04T20:22:20Z

Since this had a previous tech LGTM aside from a small change:

/lgtm
/approve

kubernetes-prow · 2026-08-04T20:22:28Z

LGTM label has been added.

Details

Git tree hash: 7704fe1fd1c8e8e6b0bcbe50d4fde314ddc4c95a

kubernetes-prow · 2026-08-04T20:22:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: katcosgrove

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:

~~content/en/docs/OWNERS~~ [katcosgrove]

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

SergeyKanzhelev · 2026-08-04T20:23:35Z


 ## Metrics API
-{{< feature-state for_k8s_version="1.8" state="beta" >}}
+{{< feature-state for_k8s_version="1.37" state="stable" >}}


use fg name instead of manually change versions here

This didn't have an FG name before; what's the best way to write it?

kubernetes-prow Bot added this to the 1.37 milestone Jul 1, 2026

kubernetes-prow Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 1, 2026

kubernetes-prow Bot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 1, 2026

tico88612 mentioned this pull request Jul 1, 2026

metrics.k8s.io API definition kubernetes/enhancements#5207

Open

4 tasks

tico88612 force-pushed the feat/metrics-k8s-io-v1 branch from c0c47aa to ccb2697 Compare July 9, 2026 01:18

kubernetes-prow Bot added language/en Issues or PRs related to English language size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 9, 2026

kubernetes-prow Bot changed the title ~~[WIP] Placeholder for v1.metrics.k8s.io~~ [WIP] Add docs for metrics.k8s.io graduation to stable Jul 11, 2026

tico88612 marked this pull request as ready for review July 22, 2026 15:40

kubernetes-prow Bot requested review from piosz and reylejano July 22, 2026 15:40

tico88612 changed the title ~~[WIP] Add docs for metrics.k8s.io graduation to stable~~ Add docs for metrics.k8s.io graduation to stable Jul 22, 2026

kubernetes-prow Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 22, 2026

tico88612 force-pushed the feat/metrics-k8s-io-v1 branch from ccb2697 to 0372c90 Compare July 22, 2026 17:17

lmktfy reviewed Jul 23, 2026

View reviewed changes

kubernetes-prow Bot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Jul 30, 2026

kubernetes-prow Bot assigned dgrisonnet Jul 30, 2026

kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 30, 2026

tico88612 added 2 commits August 3, 2026 22:56

Add docs for metrics.k8s.io graduation to stable

60422c8

Signed-off-by: ChengHao Yang <17496418+tico88612@users.noreply.github.com>

Add description about the HPA v1.metrics.k8s.io limitation

1e6f856

Signed-off-by: ChengHao Yang <17496418+tico88612@users.noreply.github.com>

tico88612 force-pushed the feat/metrics-k8s-io-v1 branch from 0372c90 to 1e6f856 Compare August 3, 2026 14:56

kubernetes-prow Bot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 3, 2026

kubernetes-prow Bot requested a review from dgrisonnet August 3, 2026 14:56

kubernetes-prow Bot assigned katcosgrove Aug 4, 2026

kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 4, 2026

kubernetes-prow Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 4, 2026

SergeyKanzhelev reviewed Aug 4, 2026

View reviewed changes

kubernetes-prow Bot merged commit 18ad3d9 into kubernetes:dev-1.37 Aug 4, 2026
6 checks passed

tico88612 deleted the feat/metrics-k8s-io-v1 branch August 7, 2026 16:19

lmktfy mentioned this pull request Aug 9, 2026

(1.37) Metrics API not documented #56895

Open

tico88612 mentioned this pull request Aug 12, 2026

Document Metrics API in observability concepts #56956

Draft

Uh oh!

Conversation

tico88612 commented Jul 1, 2026 • edited by lmktfy Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

kernel-kun commented Jul 1, 2026

Uh oh!

netlify Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Pull request preview available for checking

Uh oh!

lmktfy commented Jul 11, 2026

Uh oh!

jmickey commented Jul 22, 2026

Uh oh!

tico88612 commented Jul 23, 2026

Uh oh!

lmktfy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tico88612 Aug 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SergeyKanzhelev commented Jul 30, 2026

Uh oh!

dgrisonnet commented Jul 30, 2026

Uh oh!

kubernetes-prow Bot commented Jul 30, 2026

Uh oh!

tico88612 commented Aug 2, 2026

Uh oh!

lmktfy commented Aug 2, 2026

Uh oh!

tico88612 commented Aug 4, 2026

Uh oh!

katcosgrove commented Aug 4, 2026

Uh oh!

kubernetes-prow Bot commented Aug 4, 2026

Uh oh!

kubernetes-prow Bot commented Aug 4, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

tico88612 commented Jul 1, 2026 •

edited by lmktfy

Loading

netlify Bot commented Jul 1, 2026 •

edited

Loading

netlify Bot commented Jul 1, 2026 •

edited

Loading

tico88612 Aug 2, 2026 •

edited

Loading