added parametric margin time

Author: MarcoRiki

operators/cmd/instance-automation/main.go

@@ -95,6 +95,8 @@ func main() {
 	instanceInactiveTerminationNotificationInterval := flag.Duration("instance-inactive-termination-notification-interval", 24*time.Hour, "It represent how long before the instance is deleted the notification email should be sent to the user.")
 	expirationNotificationInterval := flag.Duration("expiration-notification-interval", 24*time.Hour, "It represent how long before the instance is deleted the notification email should be sent to the user.")
 
+	marginTime := flag.Duration("margin-time", 1*time.Minute, "The margin time to add to operations involving time comparisons to avoid edge cases due to delays")
+
 	flag.StringVar(&containerEnvOpts.ImagesTag, "container-env-sidecars-tag", "latest", "The tag for service containers (such as gui sidecar containers)")
 	flag.StringVar(&containerEnvOpts.ContentUploaderImg, "container-env-content-uploader-img", "latest", "The image name for the job to compress and upload instance content from a persistent instance.")
 
@@ -200,6 +202,7 @@ func main() {
 			MailClient:                    mailClient,
 			Prometheus:                    prometheus,
 			NotificationInterval:          *instanceInactiveTerminationNotificationInterval,
+			MarginTime:                    *marginTime,
 		}).SetupWithManager(mgr, *maxConcurrentInactiveTerminationReconciles); err != nil {
 			log.Error(err, "unable to create controller", "controller", instanceInactiveTermination)
 			os.Exit(1)
@@ -221,6 +224,7 @@ func main() {
 			EnableExpirationNotifications: *enableExpirationNotifications,
 			MailClient:                    mailClient,
 			NotificationInterval:          *expirationNotificationInterval,
+			MarginTime:                    *marginTime,
 		}).SetupWithManager(mgr, *maxConcurrentExpirationReconciles); err != nil {
 			log.Error(err, "unable to create controller", "controller", instanceExpiration)
 			os.Exit(1)

operators/deploy/instance-operator/templates/deployment.yaml

@@ -164,6 +164,7 @@ spec:
             - --mail-template-dir={{ .Values.configurations.mailTemplateDir }}
             - --enable-inactivity-notifications={{ .Values.configurations.automation.enableInactivityNotifications }}
             - --enable-expiration-notifications={{ .Values.configurations.automation.enableExpirationNotifications }}
+            - --margin-time={{ .Values.configurations.automation.marginTime }}
           ports:
             - name: auto-metrics
               containerPort: 8080

operators/deploy/instance-operator/values.yaml

@@ -56,6 +56,7 @@ configurations:
     enableExpirationNotifications: true
     inactiveTerminationNotificationInterval: "24h"
     expirationNotificationInterval: "24h"
+    marginTime: "1m"
   publicExposure:
     # The IP pool used to assign public IPs to instances.
     # Specify IPs as ranges or CIDRs, e.g., "172.18.0.240-172.18.0.249" or "172.18.0.250/30"

operators/pkg/instautoctrl/expiration.go

@@ -49,6 +49,7 @@ type InstanceExpirationReconciler struct {
 	EnableExpirationNotifications bool
 	MailClient                    *mail.Client
 	NotificationInterval          time.Duration
+	MarginTime                    time.Duration
 	// This function, if configured, is deferred at the beginning of the Reconcile.
 	// Specifically, it is meant to be set to GinkgoRecover during the tests,
 	// in order to lead to a controlled failure in case the Reconcile panics.
@@ -174,9 +175,9 @@ func (r *InstanceExpirationReconciler) Reconcile(ctx context.Context, req ctrl.R
 	// Calculate requeue time at the instance inactive deadline time:
 	// if the instance is not yet to be terminated, we requeue it after the remaining time
 	requeueTime := remainingTime
-	// add 1 minute to the remaining time to avoid requeueing just before the deadline
+	// add margin time to the remaining time to avoid requeueing just before the deadline
 	// avoiding a double requeue
-	requeueTime += 1 * time.Minute
+	requeueTime += r.MarginTime
 	dbgLog.Info("Remaining time before expiration", "remainingTime", remainingTime.String(), "instance", instance.Name, "namespace", instance.Namespace)
 
 	dbgLog.Info("requeueing instance")

operators/pkg/instautoctrl/inactivity.go

@@ -52,6 +52,7 @@ type InstanceInactiveTerminationReconciler struct {
 	NotificationInterval          time.Duration
 	MailClient                    *mail.Client
 	Prometheus                    PrometheusClientInterface
+	MarginTime                    time.Duration
 	// This function, if configured, is deferred at the beginning of the Reconcile.
 	// Specifically, it is meant to be set to GinkgoRecover during the tests,
 	// in order to lead to a controlled failure in case the Reconcile panics.
@@ -209,8 +210,8 @@ func (r *InstanceInactiveTerminationReconciler) Reconcile(ctx context.Context, r
 	tracer.Step("Inactive termination done")
 
 	// Calculate requeue time at the instance inactive deadline time: if the instance is not yet to be terminated, we requeue it after the remaining time
-	// Let's add 1 minute to the remaining time to avoid requeueing just before the deadline, avoiding a double requeue
-	requeueTime := remainingTime + 1*time.Minute
+	// Let's add margin time to the remaining time to avoid requeueing just before the deadline, avoiding a double requeue
+	requeueTime := remainingTime + r.MarginTime
 	dbgLog.Info("requeueing instance")
 	return ctrl.Result{RequeueAfter: requeueTime}, nil
 }
@@ -550,7 +551,7 @@ func (r *InstanceInactiveTerminationReconciler) ShouldSendWarningNotification(ct
 		return false, err
 	}
 	if numAlerts > 0 {
-		if time.Since(lastNotificationTime) < r.NotificationInterval-1*time.Minute {
+		if time.Since(lastNotificationTime) < r.NotificationInterval-r.MarginTime {
 			log.Info("Last notification sent within the notification interval, skipping email notification", "instance", instance.Name)
 			return false, nil
 		}