Dynamic PVC selection base on workspace

A backup job now determines the name of pvc based on used storage type.
It distinguish between different storage types (common and per-workspace) and
mount the volume dynamically.

Signed-off-by: Ales Raszka <[email protected]>

Author: Allda

controllers/backupcronjob/backupcronjob_controller.go

@@ -24,10 +24,13 @@ import (
 	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
 	"github.com/devfile/devworkspace-operator/internal/images"
+	"github.com/devfile/devworkspace-operator/pkg/common"
 	"github.com/devfile/devworkspace-operator/pkg/conditions"
 	"github.com/devfile/devworkspace-operator/pkg/config"
+	wkspConfig "github.com/devfile/devworkspace-operator/pkg/config"
 	"github.com/devfile/devworkspace-operator/pkg/constants"
 	"github.com/devfile/devworkspace-operator/pkg/infrastructure"
+	"github.com/devfile/devworkspace-operator/pkg/provision/storage"
 	"github.com/go-logr/logr"
 	"github.com/robfig/cron/v3"
 	batchv1 "k8s.io/api/batch/v1"
@@ -352,12 +355,18 @@ func (r *BackupCronJobReconciler) createBackupJob(
 	backUpConfig := dwOperatorConfig.Config.Workspace.BackupCronJob
 
 	// Find a PVC with the name "claim-devworkspace" or based on the name from the operator config
-	pvcName := "claim-devworkspace"
-	if dwOperatorConfig.Config.Workspace.PVCName != "" {
-		pvcName = dwOperatorConfig.Config.Workspace.PVCName
+	pvcName, workspacePath, err := r.getWorkspacePVCName(workspace, dwOperatorConfig, ctx, logger)
+	if err != nil {
+		log.Error(err, "Failed to get workspace PVC name", "devworkspace", workspace.Name)
+		return err
+	}
+	if pvcName == "" {
+		log.Error(err, "No PVC found for DevWorkspace", "id", dwID)
+		return err
 	}
+
 	pvc := &corev1.PersistentVolumeClaim{}
-	err := r.Get(ctx, client.ObjectKey{Name: pvcName, Namespace: workspace.Namespace}, pvc)
+	err = r.Get(ctx, client.ObjectKey{Name: pvcName, Namespace: workspace.Namespace}, pvc)
 	if err != nil {
 		log.Error(err, "Failed to get PVC for DevWorkspace", "id", dwID)
 		return err
@@ -388,7 +397,7 @@ func (r *BackupCronJobReconciler) createBackupJob(
 								{Name: "WORKSPACE_ID", Value: dwID},
 								{
 									Name:  "BACKUP_SOURCE_PATH",
-									Value: "/workspace/" + dwID + "/" + constants.DefaultProjectsSourcesRoot,
+									Value: "/workspace/" + workspacePath,
 								},
 								{Name: "STORAGE_DRIVER", Value: "overlay"},
 								{Name: "BUILDAH_ISOLATION", Value: "chroot"},
@@ -475,6 +484,32 @@ func (r *BackupCronJobReconciler) createBackupJob(
 	return nil
 }
 
+// getWorkspacePVCName determines the PVC name and workspace path based on the storage provisioner used.
+func (r *BackupCronJobReconciler) getWorkspacePVCName(workspace *dw.DevWorkspace, dwOperatorConfig *controllerv1alpha1.DevWorkspaceOperatorConfig, ctx context.Context, logger logr.Logger) (string, string, error) {
+	config, err := wkspConfig.ResolveConfigForWorkspace(workspace, r.Client)
+
+	workspaceWithConfig := &common.DevWorkspaceWithConfig{}
+	workspaceWithConfig.DevWorkspace = workspace
+	workspaceWithConfig.Config = config
+
+	storageProvisioner, err := storage.GetProvisioner(workspaceWithConfig)
+	if err != nil {
+		return "", "", err
+	}
+	if _, ok := storageProvisioner.(*storage.PerWorkspaceStorageProvisioner); ok {
+		pvcName := common.PerWorkspacePVCName(workspace.Status.DevWorkspaceId)
+		return pvcName, constants.DefaultProjectsSourcesRoot, nil
+
+	} else if _, ok := storageProvisioner.(*storage.CommonStorageProvisioner); ok {
+		pvcName := "claim-devworkspace"
+		if dwOperatorConfig.Config.Workspace.PVCName != "" {
+			pvcName = dwOperatorConfig.Config.Workspace.PVCName
+		}
+		return pvcName, workspace.Status.DevWorkspaceId + "/" + constants.DefaultProjectsSourcesRoot, nil
+	}
+	return "", "", nil
+}
+
 func (r *BackupCronJobReconciler) copySecret(workspace *dw.DevWorkspace, ctx context.Context, sourceSecret *corev1.Secret, logger logr.Logger) (namespaceSecret *corev1.Secret, err error) {
 	log := logger.WithName("copySecret")
 	existingNamespaceSecret := &corev1.Secret{}

project-backup/workspace-recovery.sh

@@ -6,7 +6,6 @@ set -x
 : "${DEVWORKSPACE_BACKUP_REGISTRY:?Missing DEVWORKSPACE_BACKUP_REGISTRY}"
 : "${DEVWORKSPACE_NAMESPACE:?Missing DEVWORKSPACE_NAMESPACE}"
 : "${DEVWORKSPACE_NAME:?Missing DEVWORKSPACE_NAME}"
-: "${PROJECTS_ROOT:?Missing PROJECTS_ROOT}"
 : "${BACKUP_SOURCE_PATH:?Missing BACKUP_SOURCE_PATH}"
 
 BACKUP_IMAGE="${DEVWORKSPACE_BACKUP_REGISTRY}/backup-${DEVWORKSPACE_NAMESPACE}-${DEVWORKSPACE_NAME}:latest"
@@ -16,6 +15,9 @@ backup() {
   local new_image
   new_image=$(buildah from scratch)
 
+  echo "Backing up workspace from path: $BACKUP_SOURCE_PATH"
+  ls -la "$BACKUP_SOURCE_PATH"
+
   buildah copy "$new_image" "$BACKUP_SOURCE_PATH" /
   buildah config --label DEVWORKSPACE="$DEVWORKSPACE_NAME" "$new_image"
   buildah config --label NAMESPACE="$DEVWORKSPACE_NAMESPACE" "$new_image"
@@ -29,8 +31,8 @@ restore() {
   local container_name="workspace-restore"
 
   podman create --name "$container_name" "$BACKUP_IMAGE"
-  rm -rf "${PROJECTS_ROOT:?}"/*
-  podman cp "$container_name":/. "$PROJECTS_ROOT"
+  rm -rf "${BACKUP_SOURCE_PATH:?}"/*
+  podman cp "$container_name":/. "$BACKUP_SOURCE_PATH"
   podman rm "$container_name"
 }