Restoring workspaces from backups

When backups are enabled for DevWorkspace instances on your cluster, a cron job will backup workspace data for stopped workspaces.

Backup storage, registry access, and schedules are configured cluster-wide by administrators in the DevWorkspace Operator. For administrator steps, see Workspace backup for Eclipse Che.

Backing up and restoring workspaces allows you to recover uncommitted source code changes. Note that restored workspaces use a minimal devfile rather than the original project devfile.

From the Che dashboard you can:

  • Open the list of backups and inspect backup status.

  • Restore a workspace from a backup that is already available to you (internal backup), or from an image reference you provide (external backup).

  • Choose compute limits and the editor for the new workspace before you start the restore.

When the restored workspace is ready, the dashboard opens it in a new browser tab.

A restored workspace is created from a minimal devfile with the restored source code being transferred to the workspace from an init container. The Devfile tab in the workspace will not show the original devfile from the workspace’s Git repository.

Viewing backups in the dashboard

To inspect the status of your workspace backups, view the list of available backups in the Che dashboard. Backups displayed in the Che dashboard are backups available in the default registry set by the administrator.

Procedure

  1. In the Che dashboard, click Workspace.

  2. Select the Backups tab to view available backups.

The Backups tab in the Workspace view of the dashboard
Figure 1. The Backups tab in the Workspace view

The Active tag represents backups for workspaces that still exist in the current cluster. Conversely, the Deleted tag represents backups for workspaces that no longer exist in the current cluster.

Restoring a workspace from a backup

You can start a new workspace from an existing backup by using the Che dashboard. When the restoration is complete, the dashboard opens the new workspace in a browser tab.

Prerequisites

  1. Backups are enabled for your cluster.

  2. You have identified a default registry or external registry backup image to use.

Procedure

  1. On the Restore page, select the backup source:

    • Default registry: Select a backup from the list.

    • External registry: Provide a backup image URL.

      Selecting the backup source during restoration
      Figure 2. Restore mode and backup source selection

  2. Enter a name for the restored workspace.

  3. Optional: Configure the memory limits, CPU limits, and the editor.

    Configuring resources and editors for a restored workspace
    Figure 3. Resource limits and editor selection

  4. Click Restore Workspace and wait for the workspace to start.