Restore workspace from backup #1572

Allda · 2026-01-14T12:18:51Z

What does this PR do?

Add init container for workspace restoration

A new init container is added to the workspace deployment in case user choose to restore the workspace from backup.

By setting the workspace attribute "controller.devfile.io/restore-workspace" the controller sets a new init container instead of cloning data from git repository.

By default an automated path to restore image is used based on cluster settings. However user is capable overwrite that value using another attribute "controller.devfile.io/restore-source-image".

The restore container runs a wokspace-recovery.sh script that pull an image using oras an extract files to a /project directory.

What issues does this PR fix or reference?

#1525

Is it tested? How?

No automated tests are available in the first phase. I will add tests once I get the first approval that the concept is ok.

How to test:

Configure a cluster to enable backups
Create a new workspace and make changes in any of its files and save it.
Stop the workspace `kubectl patch devworkspace restore-workspace-2 --type=merge -p '{"spec": {"started": false}}'
Wait till it is stopped, and backup is executed for the workspace (verify the backup image exists in the registry)
Delete a workspace from cluster kubectl delete devworkspace restore-workspace-2
Add an attribute to the workspace CRD as shown below (controller.devfile.io/restore-workspace)
Create a workspace
Wait till it boots up and verify the changed file is present

kind: DevWorkspace
apiVersion: workspace.devfile.io/v1alpha2
metadata:
  labels:
    controller.devfile.io/creator: ""
  name: restore-workspace-2
spec:
  started: true
  routingClass: 'basic'
  template:
    attributes:
      controller.devfile.io/storage-type: common
      controller.devfile.io/restore-workspace: 'true'

PR Checklist

E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)
- v8-devworkspace-operator-e2e: DevWorkspace e2e test
- v8-che-happy-path: Happy path for verification integration with Che

What's missing:

integration with registry authentication
integration with build in OCP registry

openshift-ci · 2026-01-14T12:18:58Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Allda
Once this PR has been reviewed and has the lgtm label, please assign dkwon17 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pkg/library/env/workspaceenv.go

pkg/library/restore/restore.go

controllers/workspace/devworkspace_controller.go

dkwon17 · 2026-01-16T02:17:30Z

pkg/library/restore/restore.go

+) (*corev1.Container, error) {
+	wokrspaceTempplate := &workspace.Spec.Template
+	// Check if restore is requested via workspace attribute
+	if !wokrspaceTempplate.Attributes.Exists(constants.WorkspaceRestoreAttribute) {


IMHO I think it would be more readable if this check was done by the caller in devworkspace_controller.go

In the example presented in the Is it tested? How? section of this PR, the example has:

controller.devfile.io/restore-workspace: 'true'

which made me assume that:

controller.devfile.io/restore-workspace: 'false'

would disable the restore functionality for the devworkspace.

Could we also check for "false" string here?

I extracted the condition and moved it to the controller itself to make the code path easier to read. I also enhanced the logic to recognize the attribute value. The new test verifies that setting a value to false skips the restore container.

pkg/library/storage/storage.go

pkg/library/restore/restore.go

pkg/constants/attributes.go

A new init container is added to the workspace deployment in case user choose to restore the workspace from backup. By setting workspace attribute "controller.devfile.io/restore-workspace" the controller sets a new init container instead of cloning data from git repository. By default an automated path to restore image is used based on cluster settings. However user is capable overwrite that value using another attribute "controller.devfile.io/restore-source-image". The restore container runs a wokspace-recovery.sh script that pull an image using oras an extract files to a /project directory. Signed-off-by: Ales Raszka <araszka@redhat.com>

A new tests that verifies the workspace is created from a backup. It checks if a deployment is ready and if it contains a new restore init container with proper configuration. There are 2 tests - one focused on common pvc and other that have per-workspace storage. Signed-off-by: Ales Raszka <araszka@redhat.com>

The condition whether an workspace should be restored from workspace was in the restore module itself. This make a reading a code more difficult. Now the condition is checked in the controller itself and restore container is only added when enabled. This commit also fixes few minor changes based on the code review comments: - Licence header - Attribute validation - Add a test for disabled workspace recovery - Typos Signed-off-by: Ales Raszka <araszka@redhat.com>

A new config is added to control the restore container. Default values are set for the new init container. It can be changed by user in the config. The config uses same logic as the project clone container config. Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda · 2026-01-16T12:39:50Z

controllers/workspace/devworkspace_controller_test.go

+					BackupCronJob: &controllerv1alpha1.BackupCronJobConfig{
+						Enable: ptr.To[bool](true),
+						Registry: &controllerv1alpha1.RegistryConfig{
+							Path: "localhost:5000",


@dkwon17 For the purposes of the integration tests, I need a valid backup container somewhere in a registry (the container could be empty with vely low size) to be able start and successfully execute the restore container. What would be the best place to upload it?

To verify the tests works I used my local registry, but that's not an option for running it outside of the localhost.

rohanKanojia · 2026-01-18T16:38:15Z

pkg/library/restore/restore.go

+	options Options,
+	log logr.Logger,
+) (*corev1.Container, error) {
+	wokrspaceTempplate := &workspace.Spec.Template


Suggested change

wokrspaceTempplate := &workspace.Spec.Template

workspaceTemplate := &workspace.Spec.Template

rohanKanojia · 2026-01-18T16:39:57Z

pkg/library/restore/restore.go

+
+	resources := dwResources.FilterResources(options.Resources)
+	if err := dwResources.ValidateResources(resources); err != nil {
+		return nil, fmt.Errorf("invalid resources for project clone container: %w", err)


Suggested change

return nil, fmt.Errorf("invalid resources for project clone container: %w", err)

return nil, fmt.Errorf("invalid resources for workspace restore container: %w", err)

rohanKanojia · 2026-01-18T16:45:19Z

pkg/library/restore/restore.go

+func GetWorkspaceRestoreInitContainer(
+	ctx context.Context,
+	workspace *common.DevWorkspaceWithConfig,
+	k8sClient client.Client,
+	options Options,
+	log logr.Logger,
+) (*corev1.Container, error) {


maybe cleanup unused arguments if not required for future purposes (please add TODO if that's the case)

Suggested change

func GetWorkspaceRestoreInitContainer(

ctx context.Context,

workspace *common.DevWorkspaceWithConfig,

k8sClient client.Client,

options Options,

log logr.Logger,

) (*corev1.Container, error) {

func GetWorkspaceRestoreInitContainer(

workspace *common.DevWorkspaceWithConfig,

options Options,

) (*corev1.Container, error) {

rohanKanojia · 2026-01-18T16:48:33Z

pkg/library/restore/restore.go

+	enableRecovery := workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)
+	return enableRecovery


perhaps it can be inlined?

Suggested change

enableRecovery := workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)

return enableRecovery

return workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)

rohanKanojia · 2026-01-18T16:54:14Z

pkg/library/restore/restore.go

+			return nil, fmt.Errorf("workspace restore requested but backup cron job registry is not configured")
+		}
+		// Use default backup image location based on workspace info
+		restoreSourceImage = workspace.Config.Workspace.BackupCronJob.Registry.Path + "/" + workspace.Namespace + "/" + workspace.Name + ":latest"


Will the default backup image always have latest tag ? This can make restores non-deterministic and harder to debug or roll back if the image changes unexpectedly.

rohanKanojia · 2026-01-18T17:13:15Z

pkg/constants/attributes.go

+	// WorkspaceRestoreAttribute defines whether workspace restore should be performed for a DevWorkspace.
+	// If this attribute is present, the restore process will be performed during workspace
+	// initialization before the workspace containers start.
+
+	// The backup source is automatically determined from the cluster configuration or can be overridden
+	// by specifying the WorkspaceRestoreSourceImageAttribute.


Suggested change

// WorkspaceRestoreAttribute defines whether workspace restore should be performed for a DevWorkspace.

// If this attribute is present, the restore process will be performed during workspace

// initialization before the workspace containers start.

// The backup source is automatically determined from the cluster configuration or can be overridden

// by specifying the WorkspaceRestoreSourceImageAttribute.

// WorkspaceRestoreAttribute defines whether workspace restore should be performed for a DevWorkspace.

// If this attribute is present and set to true, the restore process will be performed during

// workspace initialization, before workspace containers start.

//

// The backup source is automatically determined from the cluster configuration unless overridden

// by WorkspaceRestoreSourceImageAttribute.

rohanKanojia · 2026-01-18T17:37:05Z

controllers/workspace/devworkspace_controller_test.go

+			})
+			defer config.SetGlobalConfigForTesting(nil)
+			By("Reading DevWorkspace with restore configuration from testdata file")
+			createDevWorkspace(devWorkspaceName, "restore-workspace-disabled.yaml")


There is no file named restore-workspace-disabled.yaml in testdata/

rohanKanojia · 2026-01-19T03:33:44Z

apis/controller/v1alpha1/devworkspaceoperatorconfig_types.go

 }

+type RestoreConfig struct {
+	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`


Suggested change

ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`

// ImagePullPolicy configures the imagePullPolicy for the restore clone container.

// If undefined, the general setting .config.workspace.imagePullPolicy is used instead.

ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`

Allda requested review from akurinnoy, dkwon17, ibuziuk and rohanKanojia as code owners January 14, 2026 12:18

tolusha reviewed Jan 15, 2026

View reviewed changes

pkg/library/env/workspaceenv.go Outdated Show resolved Hide resolved

tolusha reviewed Jan 15, 2026

View reviewed changes

pkg/library/restore/restore.go Show resolved Hide resolved

tolusha reviewed Jan 15, 2026

View reviewed changes

controllers/workspace/devworkspace_controller.go Outdated Show resolved Hide resolved

dkwon17 reviewed Jan 16, 2026

View reviewed changes

pkg/library/storage/storage.go Outdated Show resolved Hide resolved

dkwon17 reviewed Jan 16, 2026

View reviewed changes

pkg/library/restore/restore.go Outdated Show resolved Hide resolved

dkwon17 reviewed Jan 16, 2026

View reviewed changes

pkg/constants/attributes.go Outdated Show resolved Hide resolved

openshift-merge-robot added the needs-rebase label Jan 16, 2026

Allda added 4 commits January 16, 2026 09:56

Allda force-pushed the 23570-restore-workspace branch from 1b95d94 to 5480c1c Compare January 16, 2026 11:04

openshift-merge-robot removed the needs-rebase label Jan 16, 2026

Allda commented Jan 16, 2026

View reviewed changes

rohanKanojia reviewed Jan 18, 2026

View reviewed changes

rohanKanojia reviewed Jan 19, 2026

View reviewed changes

	wokrspaceTempplate := &workspace.Spec.Template
	workspaceTemplate := &workspace.Spec.Template

	return nil, fmt.Errorf("invalid resources for project clone container: %w", err)
	return nil, fmt.Errorf("invalid resources for workspace restore container: %w", err)

		enableRecovery := workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)
		return enableRecovery

	enableRecovery := workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)
	return enableRecovery
	return workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)

Restore workspace from backup #1572

Are you sure you want to change the base?

Restore workspace from backup #1572

Uh oh!

Conversation

Allda commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

PR Checklist

What's missing:

Uh oh!

openshift-ci bot commented Jan 14, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rohanKanojia Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rohanKanojia Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Allda commented Jan 14, 2026 •

edited

Loading

rohanKanojia Jan 18, 2026 •

edited

Loading

rohanKanojia Jan 18, 2026 •

edited

Loading