Skip to content

docs: updated VPA CustomResourceStateMetrics docs #2193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: updated VPA CustomResourceStateMetrics docs #2193

wants to merge 1 commit into from
+39 −14

Conversation

sherifkayad
Copy link

What this PR does / why we need it:
docs PR to address #2041

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
N.A. .. Just a docs PR

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #2041

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 13, 2023
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Sep 13, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @sherifkayad!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 13, 2023
drisbee
drisbee reviewed Sep 14, 2023
View reviewed changes
@sherifkayad sherifkayad force-pushed the docs-for-vpa-custom-resource branch 2 times, most recently from 6bdf818 to f34ba86 Compare September 14, 2023 07:34
chihshenghuang
chihshenghuang reviewed Sep 14, 2023
View reviewed changes
@dashpole
Copy link
Contributor

/assign @dgrisonnet
/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 21, 2023
@sherifkayad sherifkayad force-pushed the docs-for-vpa-custom-resource branch from f34ba86 to 9fb3bae Compare September 21, 2023 20:13
@sherifkayad
Copy link
Author

Fixed MD linting issues

/test all

@k8s-ci-robot
Copy link
Contributor

@sherifkayad: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

Fixed MD linting issues

/test all

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/test-infra repository.

@sherifkayad
Copy link
Author

@dashpole @dgrisonnet can you please re-trigger the testing pipeline again?

@CatherineF-dev
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Sep 25, 2023
k0nstantinv
k0nstantinv reviewed Oct 30, 2023
View reviewed changes
@sherifkayad sherifkayad force-pushed the docs-for-vpa-custom-resource branch from 9fb3bae to 14a4ad7 Compare November 1, 2023 09:04
k0nstantinv
k0nstantinv reviewed Nov 1, 2023
View reviewed changes
Copy link

@k0nstantinv k0nstantinv left a comment

Choose a reason for hiding this comment

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

looks ok now

@sherifkayad
Copy link
Author

looks ok now

Can you please re-trigger the tests?

@k0nstantinv
Copy link

looks ok now

Can you please re-trigger the tests?

I’m not sure I’m able to do that :)

@k0nstantinv
Copy link

@CatherineF-dev seems like we need re-trigger tests again, the doc was updated

@CatherineF-dev
Copy link
Contributor

/ok-to-test

@korjek
Copy link

korjek commented Nov 28, 2023 •
edited
Loading

guys, let's move on to have this merged! This would save so much time for me (was lucky enough to bump into this PR after spending some time trying to figure out the correct config) and maybe for other folks when it's merged.

@sherifkayad
Copy link
Author

Would be really good to get this one merged soon

@korjek korjek mentioned this pull request Nov 28, 2023
Open
@richabanker richabanker mentioned this pull request Aug 5, 2025
Open
@sherifkayad
Copy link
Author

/reopen

@k8s-ci-robot k8s-ci-robot reopened this Aug 7, 2025
@k8s-ci-robot
Copy link
Contributor

@sherifkayad: Reopened this PR.

In response to this:

/reopen

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.

@sherifkayad
Copy link
Author

I re-opened the PR and will work on the review comments to append a postfix to the metrics

@sherifkayad sherifkayad closed this Aug 7, 2025
@sherifkayad sherifkayad force-pushed the docs-for-vpa-custom-resource branch from 14a4ad7 to 76f42c1 Compare August 7, 2025 08:39
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 7, 2025
@sherifkayad
Copy link
Author

/reopen

@k8s-ci-robot k8s-ci-robot reopened this Aug 7, 2025
@k8s-ci-robot
Copy link
Contributor

@sherifkayad: Reopened this PR.

In response to this:

/reopen

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
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sherifkayad
Once this PR has been reviewed and has the lgtm label, please ask for approval from dgrisonnet. 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:

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 size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 7, 2025
@sherifkayad
docs: updated VPA CustomResourceStateMetrics docs to reflect what nee…
fccf72b 
…ds to be done for recommendations

Signed-off-by: Sherif Ayad <[email protected]>
@sherifkayad sherifkayad force-pushed the docs-for-vpa-custom-resource branch from 24019a6 to fccf72b Compare August 7, 2025 08:52
@github-project-automation github-project-automation bot moved this to Needs Triage in SIG Instrumentation Aug 26, 2025
@rexagod
Copy link
Member

rexagod commented Aug 27, 2025

This doesn't seem to add all of the missing VPA metrics?

@rexagod rexagod moved this from Needs Triage to In Progress in SIG Instrumentation Aug 27, 2025
@rexagod
Copy link
Member

rexagod commented Aug 27, 2025

/assign

@sherifkayad
Copy link
Author

sherifkayad commented Aug 27, 2025 •
edited
Loading

@rexagod These are the recommendtion metrics for cpu and memory .. what else is missing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CatherineF-dev CatherineF-dev Awaiting requested review from CatherineF-dev

@logicalhan logicalhan Awaiting requested review from logicalhan

@mrueg mrueg Awaiting requested review from mrueg

@korjek korjek Awaiting requested review from korjek

@k0nstantinv k0nstantinv Awaiting requested review from k0nstantinv

@chihshenghuang chihshenghuang Awaiting requested review from chihshenghuang

@drisbee drisbee Awaiting requested review from drisbee

Assignees

@dgrisonnet dgrisonnet

@rexagod rexagod

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Instrumentation
Status: In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing replacement config for VPA collector in CRM