♻️ add min seconds

modified:   README.md; modified:   charts/kube-reqsizer/Chart.yaml; modified:   controllers/pod_controller.go; modified:   controllers/pod_controller_functions.go; modified:   controllers/pod_controller_types.go; modified:   main.go

Author: amitai-devops

README.md

@@ -8,24 +8,33 @@
 Kube-reqsizer has two primary custom flags:
 
 ```
--annotation-filter bool
+--annotation-filter bool
     
     Enable a annotation filter for pod scraping. 
     Enabling this will ensure that the controller 
     only sets requests of controllers of which pods have the annotation. 
-    (auto.request.operator/optimize=true)
 
--sample-size int
+    auto.request.operator/optimize=true
 
-    The sample size to create an average from when reconciling. (default 1)
+--sample-size int (default 1)
+
+    The sample size to create an average from when reconciling.
+
+--min-seconds int (default 1)
+
+    Minimum seconds between pod restart.
+	This ensures the controller will not restart a pod if the minimum time
+    has not passed since it has started sampling it.
 ```
 
-Sample size is the amount of data-points the controller will store in cache before constructing an average for the pod. After a requests resizing, the cache will clean itself and a new average will be calculated based on the sample size.
+Disclaimer: 
+
+`sample-size` is the amount of data-points the controller will store in cache before constructing an average for the pod. After a requests resizing, the cache will clean itself and a new average will be calculated based on the sample size. If `min-seconds` has not yet passed since the pod has last been supposed to be sample-reconciled, the controller will keep sampling the pod until `min-seconds` have been reached and only then zero the sample and restart from cache.
 
 ## Deploy - Helm
 
 ```bash
-helm install https://github.com/jatalocks/kube-reqsizer/releases/download/kube-reqsizer-0.1.0/kube-reqsizer-0.1.0.tgz
+helm install https://github.com/jatalocks/kube-reqsizer/releases/download/kube-reqsizer-0.2.0/kube-reqsizer-0.2.0.tgz
 ```
 # Development
 ## Getting Started

charts/kube-reqsizer/Chart.yaml

@@ -13,9 +13,9 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.2.0
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.1.0"
+appVersion: "0.2.0"

controllers/pod_controller.go

@@ -92,12 +92,16 @@ func (r *PodReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R
 		LatestPodRequest, err := fetchFromCache(cacheStore, pod.Name)
 		if err != nil {
 			SumPodRequest.Sample = 0
+			SumPodRequest.TimeSinceFirstSample = 0
+			SumPodRequest.Timestamp = time.Now()
 			addToCache(cacheStore, SumPodRequest)
 		} else {
 			if err != nil {
 				log.Error(err, err.Error())
 			} else {
 				SumPodRequest.Sample = LatestPodRequest.Sample + 1
+				SumPodRequest.TimeSinceFirstSample = int(time.Since(LatestPodRequest.Timestamp).Seconds())
+				SumPodRequest.Timestamp = time.Now()
 				for _, sumC := range SumPodRequest.ContainerRequests {
 					for _, latestC := range LatestPodRequest.ContainerRequests {
 						if latestC.Name == sumC.Name {
@@ -118,7 +122,7 @@ func (r *PodReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R
 			}
 		}
 
-		if SumPodRequest.Sample == r.SampleSize {
+		if (SumPodRequest.Sample >= r.SampleSize) && (SumPodRequest.TimeSinceFirstSample >= r.MinSecondsBetweenPodRestart) {
 			PodChange := false
 			Requests := []NewContainerRequests{}
 			log.Info(fmt.Sprint(SumPodRequest))
@@ -133,18 +137,18 @@ func (r *PodReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R
 								log.Info(c.Name)
 								log.Info(fmt.Sprint("Comparing CPU: ", fmt.Sprintf("%dm", AverageUsageCPU), " < ", fmt.Sprintf("%dm", currentC.CPU)))
 								log.Info(fmt.Sprint("Comparing Memory: ", fmt.Sprintf("%dMi", AverageUsageMemory), " < ", fmt.Sprintf("%dMi", currentC.Memory)))
-								if AverageUsageCPU < currentC.CPU {
-									if AverageUsageCPU > 0 {
-										pod.Spec.Containers[i].Resources.Requests[v1.ResourceCPU] = resource.MustParse(fmt.Sprintf("%dm", AverageUsageCPU))
-										PodChange = true
-									}
+								// if AverageUsageCPU < currentC.CPU {
+								if AverageUsageCPU > 0 {
+									pod.Spec.Containers[i].Resources.Requests[v1.ResourceCPU] = resource.MustParse(fmt.Sprintf("%dm", AverageUsageCPU))
+									PodChange = true
 								}
-								if AverageUsageMemory < currentC.Memory {
-									if AverageUsageMemory > 0 {
-										pod.Spec.Containers[i].Resources.Requests[v1.ResourceMemory] = resource.MustParse(fmt.Sprintf("%dMi", AverageUsageMemory))
-										PodChange = true
-									}
+								// }
+								// if AverageUsageMemory < currentC.Memory {
+								if AverageUsageMemory > 0 {
+									pod.Spec.Containers[i].Resources.Requests[v1.ResourceMemory] = resource.MustParse(fmt.Sprintf("%dMi", AverageUsageMemory))
+									PodChange = true
 								}
+								// }
 								Requests = append(Requests, NewContainerRequests{Name: c.Name, Requests: pod.Spec.Containers[i].Resources})
 							}
 						}

controllers/pod_controller_functions.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"strconv"
 	"strings"
+	"time"
 	"unicode/utf8"
 
 	"github.com/labstack/gommon/log"
@@ -119,7 +120,7 @@ func GetPodRequests(pod corev1.Pod) PodRequests {
 		}
 		containerData = append(containerData, ContainerRequests{Name: c.Name, CPU: int64(nanoCores), Memory: int64(miMemory)})
 	}
-	return PodRequests{pod.Name, containerData, 0}
+	return PodRequests{pod.Name, containerData, 0, 0, time.Now()}
 }
 
 func addToCache(cacheStore cache.Store, object PodRequests) error {
@@ -159,5 +160,5 @@ func GeneratePodRequestsObjectFromRestData(restData []byte) PodRequests {
 		kiMemory, _ := strconv.Atoi(strings.ReplaceAll(c.Usage.Memory, "Ki", ""))
 		containerData = append(containerData, ContainerRequests{Name: c.Name, CPU: int64(nanoCores / 1000000), Memory: int64(kiMemory / 1000)})
 	}
-	return PodRequests{data.Metadata.Name, containerData, 0}
+	return PodRequests{data.Metadata.Name, containerData, 0, 0, time.Now()}
 }

controllers/pod_controller_types.go

@@ -14,17 +14,20 @@ import (
 // PodReconciler reconciles a Pod object
 type PodReconciler struct {
 	client.Client
-	Log              logr.Logger
-	Scheme           *runtime.Scheme
-	ClientSet        *kubernetes.Clientset
-	SampleSize       int
-	EnableAnnotation bool
+	Log                         logr.Logger
+	Scheme                      *runtime.Scheme
+	ClientSet                   *kubernetes.Clientset
+	SampleSize                  int
+	EnableAnnotation            bool
+	MinSecondsBetweenPodRestart int
 }
 
 type PodRequests struct {
-	Name              string
-	ContainerRequests []ContainerRequests
-	Sample            int
+	Name                 string
+	ContainerRequests    []ContainerRequests
+	Sample               int
+	TimeSinceFirstSample int
+	Timestamp            time.Time
 }
 
 type ContainerRequests struct {

main.go

@@ -55,9 +55,12 @@ func main() {
 	var enableAnnotation bool
 	var probeAddr string
 	var sampleSize int
+	var minSecondsBetweenPodRestart int
 	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
 	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
 	flag.IntVar(&sampleSize, "sample-size", 1, "The sample size to create an average from when reconciling.")
+	flag.IntVar(&sampleSize, "min-seconds", 1, "Minimum seconds between pod restart. "+
+		"This ensures the controller will not restart a pod if the minimum time has not passed since it has started sampling it.")
 	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
 		"Enable leader election for controller manager. "+
 			"Enabling this will ensure there is only one active controller manager.")
@@ -103,12 +106,13 @@ func main() {
 	}
 
 	if err = (&controllers.PodReconciler{
-		Client:           mgr.GetClient(),
-		Log:              ctrl.Log.WithName("controllers").WithName("Pod"),
-		Scheme:           mgr.GetScheme(),
-		ClientSet:        clientset,
-		SampleSize:       sampleSize,
-		EnableAnnotation: enableAnnotation,
+		Client:                      mgr.GetClient(),
+		Log:                         ctrl.Log.WithName("controllers").WithName("Pod"),
+		Scheme:                      mgr.GetScheme(),
+		ClientSet:                   clientset,
+		SampleSize:                  sampleSize,
+		EnableAnnotation:            enableAnnotation,
+		MinSecondsBetweenPodRestart: minSecondsBetweenPodRestart,
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "Pod")
 		log.Error(err, err.Error())