Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
first attempt to support deploymentConfig (#15)
without proper tests and without checking the docs for correct defaults
- Loading branch information
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
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 |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| package calc | ||
|
|
||
| import ( | ||
| "fmt" | ||
| openshiftAppsV1 "github.com/openshift/api/apps/v1" | ||
| "k8s.io/apimachinery/pkg/api/resource" | ||
| "k8s.io/apimachinery/pkg/util/intstr" | ||
| "math" | ||
| ) | ||
|
|
||
| // calculates the cpu/memory resources a single deployment needs. Replicas and the deployment | ||
| // strategy are taken into account. | ||
| func deploymentConfig(deploymentConfig openshiftAppsV1.DeploymentConfig) (*ResourceUsage, error) { | ||
| var ( | ||
| resourceOverhead float64 // max overhead compute resources (percent) | ||
| podOverhead int32 // max overhead pods during deploymentConfig | ||
| ) | ||
|
|
||
| replicas := deploymentConfig.Spec.Replicas | ||
| strategy := deploymentConfig.Spec.Strategy | ||
|
|
||
| if replicas == 0 { | ||
| return &ResourceUsage{ | ||
| CPUMin: new(resource.Quantity), | ||
| CPUMax: new(resource.Quantity), | ||
| MemoryMin: new(resource.Quantity), | ||
| MemoryMax: new(resource.Quantity), | ||
| Details: Details{ | ||
| Version: deploymentConfig.APIVersion, | ||
| Kind: deploymentConfig.Kind, | ||
| Name: deploymentConfig.Name, | ||
| Replicas: replicas, | ||
| MaxReplicas: replicas, | ||
| Strategy: string(strategy.Type), | ||
| }, | ||
| }, nil | ||
| } | ||
| // TODO lookup default values, these are copied from kubernetes Deployment | ||
| switch strategy.Type { | ||
| case openshiftAppsV1.DeploymentStrategyTypeRecreate: | ||
| // no overhead on recreate | ||
| resourceOverhead = 1 | ||
| podOverhead = 0 | ||
| case "": | ||
| // Rolling is the default and can be an empty string. If so, set the defaults | ||
| // (https://pkg.go.dev/k8s.io/api/apps/v1?tab=doc#RollingUpdateDeployment) and continue calculation. | ||
| defaults := intstr.FromString("25%") | ||
| strategy = openshiftAppsV1.DeploymentStrategy{ | ||
| Type: openshiftAppsV1.DeploymentStrategyTypeRolling, | ||
| RollingParams: &openshiftAppsV1.RollingDeploymentStrategyParams{ | ||
| MaxUnavailable: &defaults, | ||
| MaxSurge: &defaults, | ||
| }, | ||
| } | ||
|
|
||
| fallthrough | ||
| case openshiftAppsV1.DeploymentStrategyTypeRolling: | ||
| // Documentation: https://pkg.go.dev/k8s.io/api/apps/v1?tab=doc#RollingUpdateDeployment | ||
| // all default values are set as stated in the docs | ||
| var ( | ||
| maxUnavailableValue intstr.IntOrString | ||
| maxSurgeValue intstr.IntOrString | ||
| ) | ||
|
|
||
| // can be nil, if so apply default value | ||
| if strategy.RollingParams == nil { | ||
| maxUnavailableValue = intstr.FromString("25%") | ||
| maxSurgeValue = intstr.FromString("25%") | ||
| } else { | ||
| maxUnavailableValue = *strategy.RollingParams.MaxUnavailable | ||
| maxSurgeValue = *strategy.RollingParams.MaxSurge | ||
| } | ||
|
|
||
| // docs say, that the absolute number is calculated by rounding down. | ||
| maxUnavailable, err := intstr.GetScaledValueFromIntOrPercent(&maxUnavailableValue, int(replicas), false) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // docs say, absolute number is calculated by rounding up. | ||
| maxSurge, err := intstr.GetScaledValueFromIntOrPercent(&maxSurgeValue, int(replicas), true) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // podOverhead is the number of pods which can run more during a deployment | ||
| podOverheadInt := maxSurge - maxUnavailable | ||
| if podOverheadInt > math.MaxInt32 || podOverheadInt < math.MinInt32 { | ||
| return nil, fmt.Errorf("deploymentConfig: %s maxSurge - maxUnavailable (%d-%d) was out of bounds for int32", deploymentConfig.Name, maxSurge, maxUnavailable) | ||
| } | ||
| podOverhead = int32(podOverheadInt) //nolint:gosec,wsl // gosec doesn't understand that the int conversion is already guarded, wsl wants to group the assignment with the next block | ||
|
|
||
| resourceOverhead = (float64(podOverhead) / float64(replicas)) + 1 | ||
| default: | ||
| return nil, fmt.Errorf("deploymentConfig: %s deploymentConfig strategy %q is unknown", deploymentConfig.Name, strategy.Type) | ||
| } | ||
|
|
||
| cpuMin, cpuMax, memoryMin, memoryMax := podResources(&deploymentConfig.Spec.Template.Spec) | ||
| strategyResources := &deploymentConfig.Spec.Strategy.Resources | ||
|
|
||
| memMin := float64(memoryMin.Value())*float64(replicas)*resourceOverhead + float64(strategyResources.Requests.Memory().Value()) | ||
| memoryMin.Set(int64(math.Round(memMin))) | ||
|
|
||
| memMax := float64(memoryMax.Value())*float64(replicas)*resourceOverhead + float64(strategyResources.Limits.Memory().Value()) | ||
| memoryMax.Set(int64(math.Round(memMax))) | ||
|
|
||
| cpuMin.SetMilli(int64(math.Round(float64(cpuMin.MilliValue())*float64(replicas)*resourceOverhead)) + strategyResources.Requests.Cpu().MilliValue()) | ||
|
|
||
| cpuMax.SetMilli(int64(math.Round(float64(cpuMax.MilliValue())*float64(replicas)*resourceOverhead)) + strategyResources.Limits.Cpu().MilliValue()) | ||
|
|
||
| resourceUsage := ResourceUsage{ | ||
| CPUMin: cpuMin, | ||
| CPUMax: cpuMax, | ||
| MemoryMin: memoryMin, | ||
| MemoryMax: memoryMax, | ||
| Details: Details{ | ||
| Version: deploymentConfig.APIVersion, | ||
| Kind: deploymentConfig.Kind, | ||
| Name: deploymentConfig.Name, | ||
| Replicas: replicas, | ||
| Strategy: string(strategy.Type), | ||
| MaxReplicas: replicas + podOverhead, | ||
| }, | ||
| } | ||
|
|
||
| return &resourceUsage, nil | ||
| } |
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,54 @@ | ||
| package calc | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| openshiftAppsV1 "github.com/openshift/api/apps/v1" | ||
| "github.com/stretchr/testify/require" | ||
| "k8s.io/apimachinery/pkg/api/resource" | ||
| ) | ||
|
|
||
| func TestDeploymentConfig(t *testing.T) { | ||
| var tests = []struct { | ||
| name string | ||
| deploymentConfig string | ||
| cpuMin resource.Quantity | ||
| cpuMax resource.Quantity | ||
| memoryMin resource.Quantity | ||
| memoryMax resource.Quantity | ||
| replicas int32 | ||
| maxReplicas int32 | ||
| strategy openshiftAppsV1.DeploymentStrategyType | ||
| }{ | ||
| { | ||
| name: "normal deploymentConfig", | ||
| deploymentConfig: normalDeploymentConfig, | ||
| cpuMin: resource.MustParse("2750m"), | ||
| cpuMax: resource.MustParse("5500m"), | ||
| memoryMin: resource.MustParse("22Gi"), | ||
| memoryMax: resource.MustParse("44Gi"), | ||
| replicas: 10, | ||
| maxReplicas: 11, | ||
| strategy: openshiftAppsV1.DeploymentStrategyTypeRolling, | ||
| }, | ||
| //TODO add more tests | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| r := require.New(t) | ||
|
|
||
| usage, err := ResourceQuotaFromYaml([]byte(test.deploymentConfig)) | ||
| r.NoError(err) | ||
| r.NotEmpty(usage) | ||
|
|
||
| AssertEqualQuantities(r, test.cpuMin, *usage.CPUMin, "cpu request value") | ||
| AssertEqualQuantities(r, test.cpuMax, *usage.CPUMax, "cpu limit value") | ||
| AssertEqualQuantities(r, test.memoryMin, *usage.MemoryMin, "memory request value") | ||
| AssertEqualQuantities(r, test.memoryMax, *usage.MemoryMax, "memory limit value") | ||
| r.Equal(test.replicas, usage.Details.Replicas, "replicas") | ||
| r.Equal(string(test.strategy), usage.Details.Strategy, "strategy") | ||
| r.Equal(test.maxReplicas, usage.Details.MaxReplicas, "maxReplicas") | ||
| }) | ||
| } | ||
| } |