Delete snapshot request ConfigMap after 24h TTL

Author: nprokopic

pkg/snapshot/controller.go

@@ -229,12 +229,12 @@ func (c *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 	case RequestPhasePartiallyFailed:
 		fallthrough
 	case RequestPhaseCompleted:
-		err = c.reconcileCompletedRequest(ctx, &configMap)
+		err = c.reconcileCompletedRequest(ctx, &configMap, snapshotRequest.RequestMetadata)
 		if err != nil {
 			return ctrl.Result{}, fmt.Errorf("failed to reconcile completed snapshot request %s/%s: %w", configMap.Namespace, configMap.Name, err)
 		}
 	case RequestPhaseFailed:
-		err = c.reconcileFailedRequest(ctx, &configMap)
+		err = c.reconcileFailedRequest(ctx, &configMap, snapshotRequest.RequestMetadata)
 		if err != nil {
 			return ctrl.Result{}, fmt.Errorf("failed to reconcile failed snapshot request %s/%s: %w", configMap.Namespace, configMap.Name, err)
 		}

pkg/snapshot/controllerbase.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"strings"
+	"time"
 
 	snapshotsv1 "github.com/kubernetes-csi/external-snapshotter/client/v8/clientset/versioned"
 	"github.com/loft-sh/vcluster/pkg/config"
@@ -129,19 +130,19 @@ func (c *reconcilerBase) removeFinalizer(ctx context.Context, configMap *corev1.
 }
 
 // reconcileCompletedRequest cleans up the completed snapshot/restore request resources.
-func (c *reconcilerBase) reconcileCompletedRequest(ctx context.Context, configMap *corev1.ConfigMap) error {
+func (c *reconcilerBase) reconcileCompletedRequest(ctx context.Context, configMap *corev1.ConfigMap, requestMetadata RequestMetadata) error {
 	c.logger.Infof("%s request from ConfigMap %s/%s has been completed", c.kind.ToCapital(), configMap.Namespace, configMap.Name)
-	err := c.reconcileDoneRequest(ctx, configMap)
+	err := c.reconcileDoneRequest(ctx, configMap, requestMetadata)
 	if err != nil {
 		return fmt.Errorf("failed to delete %s request Secret %s/%s: %w", c.kind, configMap.Namespace, configMap.Name, err)
 	}
 	return nil
 }
 
 // reconcileFailedRequest cleans up the failed snapshot/restore request resources.
-func (c *reconcilerBase) reconcileFailedRequest(ctx context.Context, configMap *corev1.ConfigMap) error {
+func (c *reconcilerBase) reconcileFailedRequest(ctx context.Context, configMap *corev1.ConfigMap, requestMetadata RequestMetadata) error {
 	c.logger.Errorf("%s request from ConfigMap %s/%s has failed", c.kind.ToCapital(), configMap.Namespace, configMap.Name)
-	err := c.reconcileDoneRequest(ctx, configMap)
+	err := c.reconcileDoneRequest(ctx, configMap, requestMetadata)
 	if err != nil {
 		return fmt.Errorf("failed to delete %s request Secret %s/%s: %w", c.kind, configMap.Namespace, configMap.Name, err)
 	}
@@ -153,17 +154,38 @@ func (c *reconcilerBase) reconcileFailedRequest(ctx context.Context, configMap *
 func (c *reconcilerBase) reconcileDeletedRequest(ctx context.Context, configMap *corev1.ConfigMap) (retErr error) {
 	// snapshot/restore request ConfigMap deleted, so delete Secret as well
 	c.logger.Infof("%s request ConfigMap %s/%s deleted", c.kind.ToCapital(), configMap.Namespace, configMap.Name)
+	defer func() {
+		if retErr != nil {
+			// an error occurred, don't remove the finalizer
+			return
+		}
+		err := c.removeFinalizer(ctx, configMap)
+		if err != nil {
+			retErr = fmt.Errorf(
+				"failed to remove vCluster %s controller finalizer from the %s request ConfigMap %s/%s: %w",
+				c.kind,
+				c.kind,
+				configMap.Namespace,
+				configMap.Name,
+				err)
+		}
+	}()
 
-	err := c.reconcileDoneRequest(ctx, configMap)
+	err := c.deleteRequestSecret(ctx, configMap)
 	if err != nil {
-		return fmt.Errorf("failed to delete %s request Secret %s/%s: %w", c.kind, configMap.Namespace, configMap.Name, err)
+		return fmt.Errorf(
+			"failed to delete %s request Secret %s/%s: %w",
+			c.kind,
+			configMap.Namespace,
+			configMap.Name,
+			err)
 	}
 	return nil
 }
 
 // reconcileDoneRequest deletes the snapshot/restore request Secret and removes the finalizer from the
 // snapshot/restore request ConfigMap.
-func (c *reconcilerBase) reconcileDoneRequest(ctx context.Context, configMap *corev1.ConfigMap) (retErr error) {
+func (c *reconcilerBase) reconcileDoneRequest(ctx context.Context, configMap *corev1.ConfigMap, requestMetadata RequestMetadata) (retErr error) {
 	defer func() {
 		if retErr != nil {
 			// an error occurred, don't remove the finalizer
@@ -190,6 +212,27 @@ func (c *reconcilerBase) reconcileDoneRequest(ctx context.Context, configMap *co
 			configMap.Name,
 			err)
 	}
+
+	if time.Since(requestMetadata.CreationTimestamp.Time) >= DefaultRequestTTL {
+		err = c.deleteRequestConfigMap(ctx, configMap)
+		if err != nil {
+			return fmt.Errorf("failed to delete %s request ConfigMap %s/%s: %w", c.kind, configMap.Namespace, configMap.Name, err)
+		}
+	}
+	return nil
+}
+
+func (c *reconcilerBase) deleteRequestConfigMap(ctx context.Context, configMap *corev1.ConfigMap) error {
+	// delete snapshot/restore request secret
+	err := c.client().Delete(ctx, configMap)
+	if kerrors.IsNotFound(err) {
+		c.logger.Debugf("%s request ConfigMap %s/%s aleady deleted", c.kind.ToCapital(), configMap.Namespace, configMap.Name)
+		return nil
+	} else if err != nil {
+		return fmt.Errorf("failed to delete %s request ConfigMap %s/%s: %w", c.kind, configMap.Namespace, configMap.Name, err)
+	}
+
+	c.logger.Infof("Deleted %s request ConfigMap %s/%s", c.kind, configMap.Namespace, configMap.Name)
 	return nil
 }
 

pkg/snapshot/request.go

@@ -3,6 +3,7 @@ package snapshot
 import (
 	"encoding/json"
 	"fmt"
+	"time"
 
 	"github.com/loft-sh/vcluster/pkg/config"
 	"github.com/loft-sh/vcluster/pkg/constants"
@@ -25,6 +26,8 @@ const (
 	RequestPhaseCompleted               RequestPhase = "Completed"
 	RequestPhasePartiallyFailed         RequestPhase = "PartiallyFailed"
 	RequestPhaseFailed                  RequestPhase = "Failed"
+
+	DefaultRequestTTL = 24 * time.Hour
 )
 
 type RequestPhase string

pkg/snapshot/restorecontroller.go

@@ -197,12 +197,12 @@ func (c *RestoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 			return ctrl.Result{}, fmt.Errorf("unexpected volume snapshots request phase %s", volumesRestoreStatus.Phase)
 		}
 	case RequestPhaseCompleted:
-		err = c.reconcileCompletedRequest(ctx, &configMap)
+		err = c.reconcileCompletedRequest(ctx, &configMap, restoreRequest.RequestMetadata)
 		if err != nil {
 			return ctrl.Result{}, fmt.Errorf("failed to reconcile completed restore request %s/%s: %w", configMap.Namespace, configMap.Name, err)
 		}
 	case RequestPhaseFailed:
-		err = c.reconcileFailedRequest(ctx, &configMap)
+		err = c.reconcileFailedRequest(ctx, &configMap, restoreRequest.RequestMetadata)
 		if err != nil {
 			return ctrl.Result{}, fmt.Errorf("failed to reconcile failed restore request %s/%s: %w", configMap.Namespace, configMap.Name, err)
 		}