[VPA] check OwnerRef against TargetRef to confirm VPA/Pod association #6460
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,10 +19,14 @@ package vpa | |
| import ( | ||
| "testing" | ||
|
|
||
| appsv1 "k8s.io/api/apps/v1" | ||
| v1 "k8s.io/api/autoscaling/v1" | ||
| core "k8s.io/api/core/v1" | ||
| meta "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/labels" | ||
|
|
||
| vpa_types "k8s.io/autoscaler/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1" | ||
| controllerfetcher "k8s.io/autoscaler/vertical-pod-autoscaler/pkg/target/controller_fetcher" | ||
| target_mock "k8s.io/autoscaler/vertical-pod-autoscaler/pkg/target/mock" | ||
| "k8s.io/autoscaler/vertical-pod-autoscaler/pkg/utils/test" | ||
|
|
||
|
|
@@ -37,8 +41,24 @@ func parseLabelSelector(selector string) labels.Selector { | |
| } | ||
|
|
||
| func TestGetMatchingVpa(t *testing.T) { | ||
| sts := appsv1.StatefulSet{ | ||
| TypeMeta: meta.TypeMeta{ | ||
| Kind: "StatefulSet", | ||
| APIVersion: "apps/v1", | ||
| }, | ||
| ObjectMeta: meta.ObjectMeta{ | ||
| Name: "sts", | ||
| Namespace: "default", | ||
| }, | ||
| } | ||
| targetRef := &v1.CrossVersionObjectReference{ | ||
| Kind: sts.Kind, | ||
| Name: sts.Name, | ||
| APIVersion: sts.APIVersion, | ||
| } | ||
| podBuilderWithoutCreator := test.Pod().WithName("test-pod").WithLabels(map[string]string{"app": "test"}). | ||
| AddContainer(test.Container().WithName("i-am-container").Get()) | ||
| podBuilder := podBuilderWithoutCreator.WithCreator(&sts.ObjectMeta, &sts.TypeMeta) | ||
| vpaBuilder := test.VerticalPodAutoscaler().WithContainer("i-am-container") | ||
| testCases := []struct { | ||
| name string | ||
|
|
@@ -52,33 +72,41 @@ func TestGetMatchingVpa(t *testing.T) { | |
| name: "matching selector", | ||
| pod: podBuilder.Get(), | ||
| vpas: []*vpa_types.VerticalPodAutoscaler{ | ||
| vpaBuilder.WithUpdateMode(vpa_types.UpdateModeAuto).WithName("auto-vpa").WithTargetRef(targetRef).Get(), | ||
|
There was a problem hiding this comment. Please correct me if I am wrong. I thought the target ref of vpa is usually "Deployment" kind. E.g., https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler#example-vpa-configuration Once the code is submitted, does it still work for vpas using Deployment as target reference? There was a problem hiding this comment. The test is using a So for this test, the only important thing is that the reference set in the pod is the same that the one set in the VPA. We are left with 2 options if we stick to deployments, none reflecting really the reality: In fact there is a 3rd option that we can use in the test and the would be more correct compare to reality: we use Statefulset. Here is a commit that does that change: There was a problem hiding this comment. Just to clarify, the functional code does traverse ownerRefs (pod -> replica-set -> deployment)? |
||
| }, | ||
| labelSelector: "app = test", | ||
| expectedFound: true, | ||
| expectedVpaName: "auto-vpa", | ||
| }, { | ||
| name: "matching selector but not match ownerRef (orphan pod)", | ||
| pod: podBuilderWithoutCreator.Get(), | ||
| vpas: []*vpa_types.VerticalPodAutoscaler{ | ||
| vpaBuilder.WithUpdateMode(vpa_types.UpdateModeAuto).WithName("auto-vpa").WithTargetRef(targetRef).Get(), | ||
| }, | ||
| labelSelector: "app = test", | ||
| expectedFound: false, | ||
| }, { | ||
| name: "not matching selector", | ||
| pod: podBuilder.Get(), | ||
| vpas: []*vpa_types.VerticalPodAutoscaler{ | ||
| vpaBuilder.WithUpdateMode(vpa_types.UpdateModeAuto).WithName("auto-vpa").WithTargetRef(targetRef).Get(), | ||
| }, | ||
| labelSelector: "app = differentApp", | ||
| expectedFound: false, | ||
| }, { | ||
| name: "off mode", | ||
| pod: podBuilder.Get(), | ||
| vpas: []*vpa_types.VerticalPodAutoscaler{ | ||
| vpaBuilder.WithUpdateMode(vpa_types.UpdateModeOff).WithName("off-vpa").WithTargetRef(targetRef).Get(), | ||
| }, | ||
| labelSelector: "app = test", | ||
| expectedFound: false, | ||
| }, { | ||
| name: "two vpas one in off mode", | ||
| pod: podBuilder.Get(), | ||
| vpas: []*vpa_types.VerticalPodAutoscaler{ | ||
| vpaBuilder.WithUpdateMode(vpa_types.UpdateModeOff).WithName("off-vpa").WithTargetRef(targetRef).Get(), | ||
| vpaBuilder.WithUpdateMode(vpa_types.UpdateModeAuto).WithName("auto-vpa").WithTargetRef(targetRef).Get(), | ||
| }, | ||
| labelSelector: "app = test", | ||
| expectedFound: true, | ||
|
|
@@ -87,7 +115,7 @@ func TestGetMatchingVpa(t *testing.T) { | |
| name: "initial mode", | ||
| pod: podBuilder.Get(), | ||
| vpas: []*vpa_types.VerticalPodAutoscaler{ | ||
| vpaBuilder.WithUpdateMode(vpa_types.UpdateModeInitial).WithName("initial-vpa").WithTargetRef(targetRef).Get(), | ||
| }, | ||
| labelSelector: "app = test", | ||
| expectedFound: true, | ||
|
|
@@ -114,7 +142,7 @@ func TestGetMatchingVpa(t *testing.T) { | |
| vpaLister.On("VerticalPodAutoscalers", "default").Return(vpaNamespaceLister) | ||
|
|
||
| mockSelectorFetcher.EXPECT().Fetch(gomock.Any()).AnyTimes().Return(parseLabelSelector(tc.labelSelector), nil) | ||
| matcher := NewMatcher(vpaLister, mockSelectorFetcher, controllerfetcher.FakeControllerFetcher{}) | ||
|
|
||
| vpa := matcher.GetMatchingVPA(tc.pod) | ||
| if tc.expectedFound && assert.NotNil(t, vpa) { | ||
|
|
||
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
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
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
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
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
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| Copyright 2019 The Kubernetes Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package controllerfetcher | ||
|
|
||
| // FakeControllerFetcher should be used in test only. It returns exactly the same controllerKey | ||
| type FakeControllerFetcher struct{} | ||
|
|
||
| // FindTopMostWellKnownOrScalable returns the same key for that fake implementation | ||
| func (f FakeControllerFetcher) FindTopMostWellKnownOrScalable(controller *ControllerKeyWithAPIVersion) (*ControllerKeyWithAPIVersion, error) { | ||
| return controller, nil | ||
| } | ||
|
|
||
| var _ ControllerFetcher = &FakeControllerFetcher{} |
File renamed without changes.
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a testing case where VPA does not select a pod when its selector matches but the target ref does not match?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The test was missing, I have added a test where selector match but not the ownerRef, here it is:
a5cae3b