Pass the whole VPA into cappingRecommendationProcessor.Apply() #7527
+88
−55
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
The current log message for when no container is found is very misleading and can cause confusion. This passes the entire VPA object into that function, in order for it to create a log file with the relevant VPA name in it. It kinda feels like surgery with a scalpel, any alternative approaches would be appreciated.
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 23, 2024
| pod *apiv1.Pod) (*vpa_types.RecommendedPodResources, ContainerToAnnotationsMap, error) { | ||
| // TODO: Annotate if request enforced by maintaining proportion with limit and allowed limit range is in conflict with policy. | ||
|
|
||
| policy := vpa.Spec.ResourcePolicy.DeepCopy() |
There was a problem hiding this comment.
Can we check for some edge cases ( just to avoid panic )?
if vpa == nil {
return nil, nil, fmt.Errorf("cannot process nil vpa")
}
if pod == nil {
return nil, nil, fmt.Errorf("cannot process nil pod")
}
if vpa.Status.Recommendation == nil {
return nil, nil, nil // This matches existing behavior for no recommendation
}
omerap12
reviewed
Nov 23, 2024
| pod *v1.Pod) (*vpa_types.RecommendedPodResources, ContainerToAnnotationsMap, error) { | ||
| recommendation := podRecommendation | ||
|
|
There was a problem hiding this comment.
Same for here ( not sure if needed but just my opinion ):
if vpa == nil {
return nil, nil, fmt.Errorf("cannot process nil vpa")
}
if vpa.Status.Recommendation == nil {
return nil, nil, nil
}
omerap12
reviewed
Nov 23, 2024
There was a problem hiding this comment.
If my comments make sense to you, we could add more unit tests to cover those edge cases. For example:
func TestApplyWithNilVPA(t *testing.T) {
pod := test.Pod().WithName("pod1").AddContainer(test.Container().WithName("ctr-name").Get()).Get()
processor := NewCappingRecommendationProcessor(&fakeLimitRangeCalculator{})
res, annotations, err := processor.Apply(nil, pod)
assert.Error(t, err)
assert.Nil(t, res)
assert.Nil(t, annotations)
}
func TestApplyWithNilPod(t *testing.T) {
vpa := test.VerticalPodAutoscaler().WithContainer("container").Get()
processor := NewCappingRecommendationProcessor(&fakeLimitRangeCalculator{})
res, annotations, err := processor.Apply(vpa, nil)
assert.Error(t, err)
assert.Nil(t, res)
assert.Nil(t, annotations)
}
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.
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
The current log message for when no container is found is very misleading and can cause confusion.
This passes the entire VPA object into that function, in order for it to create a log file with the relevant VPA name in it.
It kinda feels like surgery with a scalpel, any alternative approaches would be appreciated.
Take a look at #7491 to see the confusion it can cause.
Which issue(s) this PR fixes:
Fixes #7491
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: