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

The function will be used across both backup and restore features and should be accessed multiple places. Signed-off-by: Ales Raszka <[email protected]>

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 <[email protected]>

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

tolusha · 2026-01-15T09:48:36Z

pkg/library/env/workspaceenv.go

 	return nil
 }

+func GetErnvinmentVariablesForProjectRestore(workspace *common.DevWorkspaceWithConfig) []corev1.EnvVar {


Suggested change

func GetErnvinmentVariablesForProjectRestore(workspace *common.DevWorkspaceWithConfig) []corev1.EnvVar {

func GetEnvironmentVariablesForProjectRestore(workspace *common.DevWorkspaceWithConfig) []corev1.EnvVar {

tolusha · 2026-01-15T16:34:38Z

pkg/library/restore/restore.go

+		{Name: "BACKUP_IMAGE", Value: restoreSourceImage},
+	}...)
+
+	return &corev1.Container{


We need some default resources specified for this container

tolusha · 2026-01-15T16:40:59Z

controllers/workspace/devworkspace_controller.go

+	}
+
+	// Add init container to clone projects only if restore container wasn't created
+	if !workspaceRestoreCreated {


Could you elaborate please, why do we need fall back on this?
cc @dkwon17

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?

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

pkg/library/storage/storage.go

@@ -0,0 +1,65 @@
+//
+// Copyright (c) 2019-2025 Red Hat, Inc.


Suggested change

// Copyright (c) 2019-2025 Red Hat, Inc.

// Copyright (c) 2019-2026 Red Hat, Inc.

dkwon17 · 2026-01-16T04:29:04Z

pkg/library/restore/restore.go

@@ -0,0 +1,129 @@
+//
+// Copyright (c) 2019-2025 Red Hat, Inc.


Suggested change

// Copyright (c) 2019-2025 Red Hat, Inc.

// Copyright (c) 2019-2026 Red Hat, Inc.

dkwon17 · 2026-01-16T04:29:56Z

pkg/constants/attributes.go

 	// from the DevWorkspace
 	BootstrapDevWorkspaceAttribute = "controller.devfile.io/bootstrap-devworkspace"
+
+	// WorkspaceRestoreAttribute defines whether workspace restore should be performed when creating a DevWorkspace.


Suggested change

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

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

Small suggestion

Allda added 2 commits January 14, 2026 13:05

Extract GetWorkspacePVCInfo to separate module

cd8852e

The function will be used across both backup and restore features and should be accessed multiple places. Signed-off-by: Ales Raszka <[email protected]>

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

dkwon17 reviewed Jan 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Restore workspace from backup #1572

Restore workspace from backup #1572

Allda commented Jan 14, 2026 •

edited

Loading

Uh oh!

openshift-ci bot commented Jan 14, 2026

Uh oh!

tolusha Jan 15, 2026

Uh oh!

tolusha Jan 15, 2026

Uh oh!

tolusha Jan 15, 2026

Uh oh!

dkwon17 Jan 16, 2026

Uh oh!

dkwon17 Jan 16, 2026

Uh oh!

dkwon17 Jan 16, 2026

Uh oh!

dkwon17 Jan 16, 2026

Uh oh!

dkwon17 Jan 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	func GetErnvinmentVariablesForProjectRestore(workspace *common.DevWorkspaceWithConfig) []corev1.EnvVar {
	func GetEnvironmentVariablesForProjectRestore(workspace *common.DevWorkspaceWithConfig) []corev1.EnvVar {

	// Copyright (c) 2019-2025 Red Hat, Inc.
	// Copyright (c) 2019-2026 Red Hat, Inc.

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

Restore workspace from backup #1572

Are you sure you want to change the base?

Restore workspace from backup #1572

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!

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!

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!

4 participants

Allda commented Jan 14, 2026 •

edited

Loading