/* Copyright 2015 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. */ // This is a cut down fork of k8s.io/kubernetes/test/e2e/common/autoscaling_utils.go package autoscaling import ( "context" "fmt" "strconv" "sync" "time" v1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime/schema" "k8s.io/apimachinery/pkg/util/intstr" "k8s.io/apimachinery/pkg/util/wait" clientset "k8s.io/client-go/kubernetes" "k8s.io/kubernetes/test/e2e/framework" e2ekubectl "k8s.io/kubernetes/test/e2e/framework/kubectl" e2erc "k8s.io/kubernetes/test/e2e/framework/rc" "k8s.io/kubernetes/test/e2e/framework/resource" e2eservice "k8s.io/kubernetes/test/e2e/framework/service" testutils "k8s.io/kubernetes/test/utils" ginkgo "github.com/onsi/ginkgo/v2" scaleclient "k8s.io/client-go/scale" imageutils "k8s.io/kubernetes/test/utils/image" ) const ( dynamicConsumptionTimeInSeconds = 30 dynamicRequestSizeInMillicores = 20 dynamicRequestSizeInMegabytes = 100 dynamicRequestSizeCustomMetric = 10 port = 80 targetPort = 8080 timeoutRC = 120 * time.Second startServiceTimeout = time.Minute startServiceInterval = 5 * time.Second rcIsNil = "ERROR: replicationController = nil" deploymentIsNil = "ERROR: deployment = nil" rsIsNil = "ERROR: replicaset = nil" invalidKind = "ERROR: invalid workload kind for resource consumer" customMetricName = "QPS" serviceInitializationTimeout = 2 * time.Minute serviceInitializationInterval = 15 * time.Second stressImage = "gcr.io/google-containers/stress:v1" ) var ( resourceConsumerImage = imageutils.GetE2EImage(imageutils.ResourceConsumer) stressCommand = []string{"/stress", "--mem-total", "10000000000", "--logtostderr", "--mem-alloc-size", "50000"} ) var ( // KindRC is the GVK for ReplicationController KindRC = schema.GroupVersionKind{Version: "v1", Kind: "ReplicationController"} // KindDeployment is the GVK for Deployment KindDeployment = schema.GroupVersionKind{Group: "apps", Version: "v1beta2", Kind: "Deployment"} // KindReplicaSet is the GVK for ReplicaSet KindReplicaSet = schema.GroupVersionKind{Group: "apps", Version: "v1beta2", Kind: "ReplicaSet"} ) /* ResourceConsumer is a tool for testing. It helps create specified usage of CPU or memory (Warning: memory not supported) typical use case: rc.ConsumeCPU(600) // ... check your assumption here rc.ConsumeCPU(300) // ... check your assumption here */ type ResourceConsumer struct { name string controllerName string kind schema.GroupVersionKind nsName string clientSet clientset.Interface scaleClient scaleclient.ScalesGetter cpu chan int mem chan int customMetric chan int stopCPU chan int stopMem chan int stopCustomMetric chan int stopWaitGroup sync.WaitGroup consumptionTimeInSeconds int sleepTime time.Duration requestSizeInMillicores int requestSizeInMegabytes int requestSizeCustomMetric int } // NewDynamicResourceConsumer is a wrapper to create a new dynamic ResourceConsumer func NewDynamicResourceConsumer(name, nsName string, kind schema.GroupVersionKind, replicas, initCPUTotal, initMemoryTotal, initCustomMetric int, cpuLimit, memLimit int64, clientset clientset.Interface, scaleClient scaleclient.ScalesGetter) *ResourceConsumer { return newResourceConsumer(name, nsName, kind, replicas, initCPUTotal, initMemoryTotal, initCustomMetric, dynamicConsumptionTimeInSeconds, dynamicRequestSizeInMillicores, dynamicRequestSizeInMegabytes, dynamicRequestSizeCustomMetric, cpuLimit, memLimit, clientset, scaleClient, nil, nil) } /* NewResourceConsumer creates new ResourceConsumer initCPUTotal argument is in millicores initMemoryTotal argument is in megabytes memLimit argument is in megabytes, memLimit is a maximum amount of memory that can be consumed by a single pod cpuLimit argument is in millicores, cpuLimit is a maximum amount of cpu that can be consumed by a single pod */ func newResourceConsumer(name, nsName string, kind schema.GroupVersionKind, replicas, initCPUTotal, initMemoryTotal, initCustomMetric, consumptionTimeInSeconds, requestSizeInMillicores, requestSizeInMegabytes int, requestSizeCustomMetric int, cpuLimit, memLimit int64, clientset clientset.Interface, scaleClient scaleclient.ScalesGetter, podAnnotations, serviceAnnotations map[string]string) *ResourceConsumer { if podAnnotations == nil { podAnnotations = make(map[string]string) } if serviceAnnotations == nil { serviceAnnotations = make(map[string]string) } runServiceAndWorkloadForResourceConsumer(clientset, nsName, name, kind, replicas, cpuLimit, memLimit, podAnnotations, serviceAnnotations) rc := &ResourceConsumer{ name: name, controllerName: name + "-ctrl", kind: kind, nsName: nsName, clientSet: clientset, scaleClient: scaleClient, cpu: make(chan int), mem: make(chan int), customMetric: make(chan int), stopCPU: make(chan int), stopMem: make(chan int), stopCustomMetric: make(chan int), consumptionTimeInSeconds: consumptionTimeInSeconds, sleepTime: time.Duration(consumptionTimeInSeconds) * time.Second, requestSizeInMillicores: requestSizeInMillicores, requestSizeInMegabytes: requestSizeInMegabytes, requestSizeCustomMetric: requestSizeCustomMetric, } go rc.makeConsumeCPURequests() rc.ConsumeCPU(initCPUTotal) go rc.makeConsumeMemRequests() rc.ConsumeMem(initMemoryTotal) go rc.makeConsumeCustomMetric() rc.ConsumeCustomMetric(initCustomMetric) return rc } // ConsumeCPU consumes given number of CPU func (rc *ResourceConsumer) ConsumeCPU(millicores int) { framework.Logf("RC %s: consume %v millicores in total", rc.name, millicores) rc.cpu <- millicores } // ConsumeMem consumes given number of Mem func (rc *ResourceConsumer) ConsumeMem(megabytes int) { framework.Logf("RC %s: consume %v MB in total", rc.name, megabytes) rc.mem <- megabytes } // ConsumeCustomMetric consumes given number of custom metric func (rc *ResourceConsumer) ConsumeCustomMetric(amount int) { framework.Logf("RC %s: consume custom metric %v in total", rc.name, amount) rc.customMetric <- amount } func (rc *ResourceConsumer) makeConsumeCPURequests() { defer ginkgo.GinkgoRecover() rc.stopWaitGroup.Add(1) defer rc.stopWaitGroup.Done() sleepTime := time.Duration(0) millicores := 0 for { select { case millicores = <-rc.cpu: framework.Logf("RC %s: setting consumption to %v millicores in total", rc.name, millicores) case <-time.After(sleepTime): framework.Logf("RC %s: sending request to consume %d millicores", rc.name, millicores) rc.sendConsumeCPURequest(millicores) sleepTime = rc.sleepTime case <-rc.stopCPU: framework.Logf("RC %s: stopping CPU consumer", rc.name) return } } } func (rc *ResourceConsumer) makeConsumeMemRequests() { defer ginkgo.GinkgoRecover() rc.stopWaitGroup.Add(1) defer rc.stopWaitGroup.Done() sleepTime := time.Duration(0) megabytes := 0 for { select { case megabytes = <-rc.mem: framework.Logf("RC %s: setting consumption to %v MB in total", rc.name, megabytes) case <-time.After(sleepTime): framework.Logf("RC %s: sending request to consume %d MB", rc.name, megabytes) rc.sendConsumeMemRequest(megabytes) sleepTime = rc.sleepTime case <-rc.stopMem: framework.Logf("RC %s: stopping mem consumer", rc.name) return } } } func (rc *ResourceConsumer) makeConsumeCustomMetric() { defer ginkgo.GinkgoRecover() rc.stopWaitGroup.Add(1) defer rc.stopWaitGroup.Done() sleepTime := time.Duration(0) delta := 0 for { select { case delta = <-rc.customMetric: framework.Logf("RC %s: setting bump of metric %s to %d in total", rc.name, customMetricName, delta) case <-time.After(sleepTime): framework.Logf("RC %s: sending request to consume %d of custom metric %s", rc.name, delta, customMetricName) rc.sendConsumeCustomMetric(delta) sleepTime = rc.sleepTime case <-rc.stopCustomMetric: framework.Logf("RC %s: stopping metric consumer", rc.name) return } } } func (rc *ResourceConsumer) sendConsumeCPURequest(millicores int) { ctx, cancel := context.WithTimeout(context.Background(), framework.SingleCallTimeout) defer cancel() err := wait.PollImmediate(serviceInitializationInterval, serviceInitializationTimeout, func() (bool, error) { proxyRequest, err := e2eservice.GetServicesProxyRequest(rc.clientSet, rc.clientSet.CoreV1().RESTClient().Post()) framework.ExpectNoError(err) req := proxyRequest.Namespace(rc.nsName). Name(rc.controllerName). Suffix("ConsumeCPU"). Param("millicores", strconv.Itoa(millicores)). Param("durationSec", strconv.Itoa(rc.consumptionTimeInSeconds)). Param("requestSizeMillicores", strconv.Itoa(rc.requestSizeInMillicores)) framework.Logf("ConsumeCPU URL: %v", *req.URL()) _, err = req.DoRaw(ctx) if err != nil { framework.Logf("ConsumeCPU failure: %v", err) return false, nil } return true, nil }) framework.ExpectNoError(err) } // sendConsumeMemRequest sends POST request for memory consumption func (rc *ResourceConsumer) sendConsumeMemRequest(megabytes int) { ctx, cancel := context.WithTimeout(context.Background(), framework.SingleCallTimeout) defer cancel() err := wait.PollImmediate(serviceInitializationInterval, serviceInitializationTimeout, func() (bool, error) { proxyRequest, err := e2eservice.GetServicesProxyRequest(rc.clientSet, rc.clientSet.CoreV1().RESTClient().Post()) framework.ExpectNoError(err) req := proxyRequest.Namespace(rc.nsName). Name(rc.controllerName). Suffix("ConsumeMem"). Param("megabytes", strconv.Itoa(megabytes)). Param("durationSec", strconv.Itoa(rc.consumptionTimeInSeconds)). Param("requestSizeMegabytes", strconv.Itoa(rc.requestSizeInMegabytes)) framework.Logf("ConsumeMem URL: %v", *req.URL()) _, err = req.DoRaw(ctx) if err != nil { framework.Logf("ConsumeMem failure: %v", err) return false, nil } return true, nil }) framework.ExpectNoError(err) } // sendConsumeCustomMetric sends POST request for custom metric consumption func (rc *ResourceConsumer) sendConsumeCustomMetric(delta int) { ctx, cancel := context.WithTimeout(context.Background(), framework.SingleCallTimeout) defer cancel() err := wait.PollImmediate(serviceInitializationInterval, serviceInitializationTimeout, func() (bool, error) { proxyRequest, err := e2eservice.GetServicesProxyRequest(rc.clientSet, rc.clientSet.CoreV1().RESTClient().Post()) framework.ExpectNoError(err) req := proxyRequest.Namespace(rc.nsName). Name(rc.controllerName). Suffix("BumpMetric"). Param("metric", customMetricName). Param("delta", strconv.Itoa(delta)). Param("durationSec", strconv.Itoa(rc.consumptionTimeInSeconds)). Param("requestSizeMetrics", strconv.Itoa(rc.requestSizeCustomMetric)) framework.Logf("ConsumeCustomMetric URL: %v", *req.URL()) _, err = req.DoRaw(ctx) if err != nil { framework.Logf("ConsumeCustomMetric failure: %v", err) return false, nil } return true, nil }) framework.ExpectNoError(err) } // CleanUp clean up the background goroutines responsible for consuming resources. func (rc *ResourceConsumer) CleanUp() { ginkgo.By(fmt.Sprintf("Removing consuming RC %s", rc.name)) close(rc.stopCPU) close(rc.stopMem) close(rc.stopCustomMetric) rc.stopWaitGroup.Wait() // Wait some time to ensure all child goroutines are finished. time.Sleep(10 * time.Second) kind := rc.kind.GroupKind() framework.ExpectNoError(resource.DeleteResourceAndWaitForGC(rc.clientSet, kind, rc.nsName, rc.name)) framework.ExpectNoError(rc.clientSet.CoreV1().Services(rc.nsName).Delete(context.TODO(), rc.name, metav1.DeleteOptions{})) framework.ExpectNoError(resource.DeleteResourceAndWaitForGC(rc.clientSet, schema.GroupKind{Kind: "ReplicationController"}, rc.nsName, rc.controllerName)) framework.ExpectNoError(rc.clientSet.CoreV1().Services(rc.nsName).Delete(context.TODO(), rc.controllerName, metav1.DeleteOptions{})) } func runServiceAndWorkloadForResourceConsumer(c clientset.Interface, ns, name string, kind schema.GroupVersionKind, replicas int, cpuRequestMillis, memRequestMb int64, podAnnotations, serviceAnnotations map[string]string) { ginkgo.By(fmt.Sprintf("Running consuming RC %s via %s with %v replicas", name, kind, replicas)) _, err := c.CoreV1().Services(ns).Create(context.TODO(), &v1.Service{ ObjectMeta: metav1.ObjectMeta{ Name: name, Annotations: serviceAnnotations, }, Spec: v1.ServiceSpec{ Ports: []v1.ServicePort{{ Port: port, TargetPort: intstr.FromInt(targetPort), }}, Selector: map[string]string{ "name": name, }, }, }, metav1.CreateOptions{}) framework.ExpectNoError(err) rcConfig := testutils.RCConfig{ Client: c, Image: resourceConsumerImage, Name: name, Namespace: ns, Timeout: timeoutRC, Replicas: replicas, CpuRequest: cpuRequestMillis, MemRequest: memRequestMb * 1024 * 1024, // MemRequest is in bytes Annotations: podAnnotations, } switch kind { case KindRC: framework.ExpectNoError(e2erc.RunRC(rcConfig)) case KindDeployment: dpConfig := testutils.DeploymentConfig{ RCConfig: rcConfig, } ginkgo.By(fmt.Sprintf("creating deployment %s in namespace %s", dpConfig.Name, dpConfig.Namespace)) dpConfig.NodeDumpFunc = framework.DumpNodeDebugInfo dpConfig.ContainerDumpFunc = e2ekubectl.LogFailedContainers framework.ExpectNoError(testutils.RunDeployment(dpConfig)) case KindReplicaSet: rsConfig := testutils.ReplicaSetConfig{ RCConfig: rcConfig, } ginkgo.By(fmt.Sprintf("creating replicaset %s in namespace %s", rsConfig.Name, rsConfig.Namespace)) framework.ExpectNoError(runReplicaSet(rsConfig)) default: framework.Failf(invalidKind) } ginkgo.By(fmt.Sprintf("Running controller")) controllerName := name + "-ctrl" _, err = c.CoreV1().Services(ns).Create(context.TODO(), &v1.Service{ ObjectMeta: metav1.ObjectMeta{ Name: controllerName, }, Spec: v1.ServiceSpec{ Ports: []v1.ServicePort{{ Port: port, TargetPort: intstr.FromInt(targetPort), }}, Selector: map[string]string{ "name": controllerName, }, }, }, metav1.CreateOptions{}) framework.ExpectNoError(err) dnsClusterFirst := v1.DNSClusterFirst controllerRcConfig := testutils.RCConfig{ Client: c, Image: imageutils.GetE2EImage(imageutils.Agnhost), Name: controllerName, Namespace: ns, Timeout: timeoutRC, Replicas: 1, Command: []string{"/agnhost", "resource-consumer-controller", "--consumer-service-name=" + name, "--consumer-service-namespace=" + ns, "--consumer-port=80"}, DNSPolicy: &dnsClusterFirst, } framework.ExpectNoError(e2erc.RunRC(controllerRcConfig)) // Wait for endpoints to propagate for the controller service. framework.ExpectNoError(framework.WaitForServiceEndpointsNum( c, ns, controllerName, 1, startServiceInterval, startServiceTimeout)) } // runReplicaSet launches (and verifies correctness) of a replicaset. func runReplicaSet(config testutils.ReplicaSetConfig) error { ginkgo.By(fmt.Sprintf("creating replicaset %s in namespace %s", config.Name, config.Namespace)) config.NodeDumpFunc = framework.DumpNodeDebugInfo config.ContainerDumpFunc = e2ekubectl.LogFailedContainers return testutils.RunReplicaSet(config) } func runOomingReplicationController(c clientset.Interface, ns, name string, replicas int) { ginkgo.By(fmt.Sprintf("Running OOMing RC %s with %v replicas", name, replicas)) rcConfig := testutils.RCConfig{ Client: c, Image: stressImage, Command: stressCommand, Name: name, Namespace: ns, Timeout: timeoutRC, Replicas: replicas, Annotations: make(map[string]string), MemRequest: 1024 * 1024 * 300, MemLimit: 1024 * 1024 * 500, } dpConfig := testutils.DeploymentConfig{ RCConfig: rcConfig, } ginkgo.By(fmt.Sprintf("Creating deployment %s in namespace %s", dpConfig.Name, dpConfig.Namespace)) dpConfig.NodeDumpFunc = framework.DumpNodeDebugInfo dpConfig.ContainerDumpFunc = e2ekubectl.LogFailedContainers framework.ExpectNoError(testutils.RunDeployment(dpConfig)) }