VPA - Update docs a little #7494
Open
+103
−78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mostly markdown linting things, but some small fixes (I found some unnessesary whitespace). I made one wording change to try put emphasis on the fact that the VPA's primary purpose is resource requests and not limits
k8s-ci-robot
added
kind/cleanup
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: adrianmoisey 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 |
k8s-ci-robot
added
the
size/L
omerap12
reviewed
Nov 13, 2024
vertical-pod-autoscaler/README.md
Outdated
| kubectl get customresourcedefinition | grep verticalpodautoscalers | ||
| ``` | ||
|
|
||
| ### Components of VPA | ||
|
|
||
| The project consists of 3 components: | ||
|
|
||
| * [Recommender](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/recommender/README.md) - it monitors the current and past resource consumption and, based on it, | ||
| - [Recommender](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/recommender/README.md) - it monitors the current and past resource consumption and, based on it, |
There was a problem hiding this comment.
Can we do:
Recommender - monitors the current and past resource consumption and, based on it,
There was a problem hiding this comment.
Good idea, fixed in 586813c
omerap12
reviewed
Nov 13, 2024
vertical-pod-autoscaler/README.md
Outdated
| provides recommended values for the containers' cpu and memory requests. | ||
|
|
||
| * [Updater](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/updater/README.md) - it checks which of the managed pods have correct resources set and, if not, | ||
| - [Updater](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/updater/README.md) - it checks which of the managed pods have correct resources set and, if not, |
omerap12
reviewed
Nov 13, 2024
vertical-pod-autoscaler/README.md
Outdated
| kills them so that they can be recreated by their controllers with the updated requests. | ||
|
|
||
| * [Admission Plugin](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/admission-controller/README.md) - it sets the correct resource requests on new pods (either just created | ||
| - [Admission Plugin](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/pkg/admission-controller/README.md) - it sets the correct resource requests on new pods (either just created |
omerap12
reviewed
Nov 13, 2024
|
/lgtm |
k8s-ci-robot
added
the
lgtm
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly markdown linting things, but some small fixes (I found some unnessesary whitespace).
I made one wording change to try put emphasis on the fact that the VPA's primary purpose is resource requests and not limits
What type of PR is this?
/kind cleanup
/kind documentation
What this PR does / why we need it:
The docs for the VPA need to be cleaned up a bunch, I gave it a once over to try make things neater, and ended up mostly on small lifting type issues.
I also tried to make the intro paragraph focus on requests, as many users seem to think the VPA controls limits.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: