Document Metrics API in observability concepts - #56956
Conversation
Signed-off-by: ChengHao Yang <17496418+tico88612@users.noreply.github.com>
👷 Deploy Preview for kubernetes-io-vnext-staging processing.
|
kubernetes-prow
Bot
added
the
language/en
kubernetes-prow
Bot
added
cncf-cla: yes
|
/cc @lmktfy |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
cc @kernel-kun |
lmktfy
left a comment
lmktfy
left a comment
There was a problem hiding this comment.
Thanks for this. I actually recommend a slight simplification – see inline feedback.
|
|
||
| ### Metrics API | ||
|
|
||
| {{< feature-state for_k8s_version="v1.37" state="stable" >}} |
There was a problem hiding this comment.
This is only kind of true, I think. Could you install the v1 API into a v1.36 cluster? I think you could.
There was a problem hiding this comment.
Although metrics.k8s.io/v1 was introduced with Kubernetes v1.37, an independent aggregated API provider could technically serve it on an older cluster.
I removed the feature-state notice to avoid implying that v1.37 is a hard minimum cluster version.
| and [VerticalPodAutoscaler](/docs/concepts/workloads/autoscaling/vertical-pod-autoscale/) | ||
| use this API. | ||
|
|
||
| `kubectl top` supports both `metrics.k8s.io/v1` and `metrics.k8s.io/v1beta1`. It prefers `v1` |
There was a problem hiding this comment.
For simplicity, just skip this paragraph (for now). Easier to get a stub merged than a more detailed page / section perfect.
There was a problem hiding this comment.
Done. I removed this paragraph to keep the initial Metrics API section simple and focused on the concept.
| metrics needed for autoscaling and basic inspection; it is not a replacement for a full monitoring | ||
| pipeline. | ||
|
|
||
| To learn about the API, its implementations, and the data flow from kubelets to its clients, see the |
There was a problem hiding this comment.
This feedback is more than a nit, but given how close we are to the v1.37 release day, I don't want this feedback to block a merge.
This hyperlinking isn't quite right. If the current task page has some conceptual explanation, either move it here or copy it.
We shouldn't refer people to a task page as part of undertaking a concept; the audience for a task page is people who are moderately familiar with the concept already, and want to be walked through what to do.
(there is a separate idea of a tutorial page, but I doubt there is time to get one written)
There was a problem hiding this comment.
Thanks, agreed. I added a concise explanation here that Metrics Server collects resource metrics from kubelets and makes them available through the Metrics API.
I also removed the task-page link so that this concept section is self-contained without significantly expanding the stub.
|
/hold We are well past the Docs Freeze deadline. This will require a Docs Freeze exception to proceed. |
kubernetes-prow
Bot
added
the
do-not-merge/hold
lmktfy
left a comment
lmktfy
left a comment
There was a problem hiding this comment.
On the basis that
- overall, this change would improve the docs
- the PR is (correctly) held at the moment
/lgtm
kubernetes-prow
Bot
added
the
lgtm
|
LGTM label has been added. DetailsGit tree hash: fde673647e44496fd501e07f912b23b6e0b24dbc |
Signed-off-by: ChengHao Yang <17496418+tico88612@users.noreply.github.com>
kubernetes-prow
Bot
removed
the
lgtm
|
New changes are detected. LGTM label has been removed. |
kubernetes-prow
Bot
added
size/S
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
3 participants
Description
Add the Metrics API documentation to the concepts page.
#56349 has been merged and marked as Tracked for Docs Freeze, but the SIG Docs reviewers would like to add more to the concept section, so I've opened this PR.
Please let me know if I need to attach a Docs Freeze Exception or follow any other procedures.
Some content uses AI assistance. But I did a preliminary check.
Issue
Related #56895