Skip to content
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

Add sidecar containers to resource requests computation #2099

Merged
merged 9 commits into from
May 7, 2024
Merged

Add sidecar containers to resource requests computation #2099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
912356a
Add sidecar containers to resource requests computation
IrvingMg Apr 29, 2024
4c147e5
Refactor init containers resource computation
IrvingMg May 2, 2024
e338535
Refactor tests cases using Container wrapper
IrvingMg May 2, 2024
471e39c
Update test cases
IrvingMg May 2, 2024
7ba8d95
Refactor sidecar condition
IrvingMg May 2, 2024
b216698
Update tests
IrvingMg May 2, 2024
48490a6
Update formula to compute resource requests
IrvingMg May 6, 2024
e44dbca
Make init containers resource computation linear
IrvingMg May 7, 2024
053c150
Update init containers resource computation
IrvingMg May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 47 additions & 10 deletions pkg/util/limitrange/limitrange.go
View file
Open in desktop
IrvingMg marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -81,25 +81,62 @@ func (s Summary) validatePodSpecContainers(containers []corev1.Container, path *
}

// TotalRequests computes the total resource requests of a pod.
// total = sum(max(sum(.containers[].requests), initContainers[].requests), overhead)
//
// total = Max( Max(each InitContainerUse) , Sum(SidecarContainers) + Sum(Containers) ) + pod overhead
//
// where:
//
// InitContainerUse(i) = Sum(SidecarContainers with index < i) + InitContainer(i)
func TotalRequests(ps *corev1.PodSpec) corev1.ResourceList {
total := corev1.ResourceList{}
sumContainers := calculateMainContainersResources(ps.Containers)
maxInitContainers := calculateInitContainersResources(ps.InitContainers)
sumSidecarContainers := calculateSidecarContainersResources(ps.InitContainers)

total := resource.MergeResourceListKeepMax(
maxInitContainers,
resource.MergeResourceListKeepSum(sumSidecarContainers, sumContainers),
)
// add the overhead
total = resource.MergeResourceListKeepSum(total, ps.Overhead)
return total
}

// add the resource from the main containers
for i := range ps.Containers {
total = resource.MergeResourceListKeepSum(total, ps.Containers[i].Resources.Requests)
func calculateMainContainersResources(containers []corev1.Container) corev1.ResourceList {
total := corev1.ResourceList{}
for i := range containers {
total = resource.MergeResourceListKeepSum(total, containers[i].Resources.Requests)
}
return total
}

// take into account the maximum of any init containers
for i := range ps.InitContainers {
total = resource.MergeResourceListKeepMax(total, ps.InitContainers[i].Resources.Requests)
func calculateInitContainersResources(initContainers []corev1.Container) corev1.ResourceList {
maxInitContainerUsage := corev1.ResourceList{}
sidecarRunningUsage := corev1.ResourceList{}
for i := range initContainers {
if isSidecarContainer(initContainers[i]) {
sidecarRunningUsage = resource.MergeResourceListKeepSum(sidecarRunningUsage, initContainers[i].Resources.Requests)
} else {
initContainerUse := resource.MergeResourceListKeepSum(initContainers[i].Resources.Requests, sidecarRunningUsage)
maxInitContainerUsage = resource.MergeResourceListKeepMax(maxInitContainerUsage, initContainerUse)
}
}
return maxInitContainerUsage
}

// add the overhead
total = resource.MergeResourceListKeepSum(total, ps.Overhead)
func calculateSidecarContainersResources(initContainers []corev1.Container) corev1.ResourceList {
total := corev1.ResourceList{}
for i := range initContainers {
if isSidecarContainer(initContainers[i]) {
total = resource.MergeResourceListKeepSum(total, initContainers[i].Resources.Requests)
}
}
return total
}

func isSidecarContainer(container corev1.Container) bool {
return container.RestartPolicy != nil && *container.RestartPolicy == corev1.ContainerRestartPolicyAlways
}

// ValidatePodSpec verifies if the provided podSpec (ps) first into the boundaries of the summary (s).
func (s Summary) ValidatePodSpec(ps *corev1.PodSpec, path *field.Path) []string {
reasons := []string{}
Expand Down
257 changes: 178 additions & 79 deletions pkg/util/limitrange/limitrange_test.go
View file
Open in desktop
IrvingMg marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -160,79 +160,194 @@ func TestSummarize(t *testing.T) {
}

func TestTotalRequest(t *testing.T) {
containers := []corev1.Container{
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
cases := map[string]struct {
podSpec *corev1.PodSpec
want corev1.ResourceList
}{
"pod without init containers. request sum(containers)": {
podSpec: &corev1.PodSpec{
Containers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
Obj(),
},
},
},
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1500m"),
"example.com/gpu": resource.MustParse("2"),
},
want: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("2.5"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
"example.com/gpu": resource.MustParse("2"),
},
},
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("4"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
"pod only with regular init containers. request max( max(each initContainerUse), sum(containers) )": {
podSpec: &corev1.PodSpec{
InitContainers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "4").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
Obj(),
},
Containers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
Obj(),
},
},
want: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("4"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
"example.com/gpu": resource.MustParse("2"),
},
},
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1500m"),
"example.com/gpu": resource.MustParse("2"),
"pod only with sidecar containers. request max( max(each initContainerUse), sum(sidecarContainers) + sum(containers) )": {
podSpec: &corev1.PodSpec{
InitContainers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "4").
WithResourceReq(corev1.ResourceMemory, "2Gi").
AsSidecar().
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
AsSidecar().
Obj(),
},
Containers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
Obj(),
},
},
want: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("8"),
corev1.ResourceMemory: resource.MustParse("4Gi"),
"example.com/gpu": resource.MustParse("4"),
},
},
}
cases := map[string]struct {
podSpec *corev1.PodSpec
want corev1.ResourceList
}{
"sum up main containers": {
"pod only with regular init and sidecar containers. request max( max(each InitContainerUse), sum(sidecarContainers) )": {
podSpec: &corev1.PodSpec{
Containers: containers[:2],
InitContainers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "1Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "2").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "3").
WithResourceReq(corev1.ResourceMemory, "3Gi").
AsSidecar().
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "4").
WithResourceReq(corev1.ResourceMemory, "4Gi").
AsSidecar().
Obj(),
},
},
want: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("2500m"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
"example.com/gpu": resource.MustParse("2"),
corev1.ResourceCPU: resource.MustParse("7"),
corev1.ResourceMemory: resource.MustParse("7Gi"),
},
},
"one init wants more": {
"pod with regular init and sidecar containers. request max( max(each InitContainer), sum(sidecarContainers) + sum(containers) )": {
podSpec: &corev1.PodSpec{
InitContainers: containers[2:],
Containers: containers[:2],
InitContainers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "1Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "2").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "3").
WithResourceReq(corev1.ResourceMemory, "3Gi").
AsSidecar().
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "4").
WithResourceReq(corev1.ResourceMemory, "4Gi").
AsSidecar().
Obj(),
},
Containers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "2").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "4").
WithResourceReq("example.com/gpu", "4").
Obj(),
},
},
want: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("4000m"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
"example.com/gpu": resource.MustParse("2"),
corev1.ResourceCPU: resource.MustParse("13"),
corev1.ResourceMemory: resource.MustParse("9Gi"),
"example.com/gpu": resource.MustParse("4"),
},
},
"adds overhead": {
"adds overhead. request max( max(each InitContainer), sum(sidecarContainers) + sum(containers) ) + overhead": {
podSpec: &corev1.PodSpec{
InitContainers: containers[2:],
Containers: containers[:2],
InitContainers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "4").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "2Gi").
WithResourceReq("example.com/gpu", "2").
AsSidecar().
Obj(),
},
Containers: []corev1.Container{
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
Obj(),
},
Overhead: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1"),
corev1.ResourceMemory: resource.MustParse("1Gi"),
"example.com/gpu": resource.MustParse("1"),
},
},
want: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("5000m"),
corev1.ResourceMemory: resource.MustParse("3Gi"),
"example.com/gpu": resource.MustParse("3"),
corev1.ResourceCPU: resource.MustParse("5"),
corev1.ResourceMemory: resource.MustParse("5Gi"),
"example.com/gpu": resource.MustParse("5"),
},
},
}
Expand All @@ -249,42 +364,26 @@ func TestTotalRequest(t *testing.T) {
func TestValidatePodSpec(t *testing.T) {
podSpec := &corev1.PodSpec{
Containers: []corev1.Container{
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
"example.com/mainContainerGpu": resource.MustParse("2"),
},
},
},
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1500m"),
"example.com/gpu": resource.MustParse("2"),
},
},
},
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1").
WithResourceReq(corev1.ResourceMemory, "2Gi").
WithResourceReq("example.com/mainContainerGpu", "2").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
Obj(),
},
InitContainers: []corev1.Container{
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("4"),
corev1.ResourceMemory: resource.MustParse("2Gi"),
},
},
},
{
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1500m"),
"example.com/gpu": resource.MustParse("2"),
"example.com/initContainerGpu": resource.MustParse("2"),
},
},
},
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "4").
WithResourceReq(corev1.ResourceMemory, "2Gi").
Obj(),
*testingutil.MakeContainer().
WithResourceReq(corev1.ResourceCPU, "1.5").
WithResourceReq("example.com/gpu", "2").
WithResourceReq("example.com/initContainerGpu", "2").
Obj(),
},
Overhead: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("1"),
Expand Down