Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
f0e141d
Add end user restore documentation
dkwon17 Mar 23, 2026
728d776
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
afde4cf
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
a67c454
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
e27b485
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
b798ed7
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
632d31d
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
39b6541
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
9b6d82f
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
a9ceeeb
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
6300eb6
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 Mar 24, 2026
11e10dd
Break down docs into procedures
dkwon17 Mar 24, 2026
082a931
Fix wording
dkwon17 Mar 24, 2026
f422fff
Fix build error
dkwon17 Mar 24, 2026
a77ba1a
Update wording
dkwon17 Mar 24, 2026
4006534
Update ordering
dkwon17 Mar 24, 2026
e81307b
Update modules/end-user-guide/pages/restoring-workspaces-from-backups…
dkwon17 Mar 25, 2026
08dd112
Update screenshots
dkwon17 Mar 25, 2026
7baf4ad
Update modules/end-user-guide/pages/restoring-workspaces-from-backups…
dkwon17 Mar 26, 2026
6f9840c
Update modules/end-user-guide/pages/restoring-workspaces-from-backups…
dkwon17 Mar 26, 2026
7c57d57
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 Mar 26, 2026
116cd89
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 Mar 26, 2026
e489cdf
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 Mar 26, 2026
2b678b3
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 Mar 26, 2026
6b1b540
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 Mar 26, 2026
3fc87f4
Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashb…
dkwon17 Mar 26, 2026
4fbe707
Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashb…
dkwon17 Mar 26, 2026
76e51f5
Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashb…
dkwon17 Mar 26, 2026
db05a67
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 Mar 26, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/administration-guide/pages/devworkspace-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ integrated registry or link:https://quay.io[Quay.io], to store backup archives a

The backup makes a snapshot of *stopped* Workspace PVCs and stores them as tar.gz archives in the specified OCI registry.

Users can restore backups from the {prod-short} dashboard. See xref:end-user-guide:restoring-a-workspace-from-backup.adoc[].

NOTE: By default, the {devworkspace} backup job is disabled.

You can configure the backup by using the `DevWorkspaceOperatorConfig` resource with the following fields:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions modules/end-user-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
**** xref:url-parameter-for-the-existing-workspace-name.adoc[]
** xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
** xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
** xref:restoring-a-workspace-from-backup.adoc[]
** xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
** xref:using-the-fuse-overlay-storage-driver.adoc[]
*** xref:accessing-fuse.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ If your organization is already running a {prod-short} instance, you can get sta
* xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
* xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
* xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
* xref:restoring-a-workspace-from-backup.adoc[]
* xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
* xref:using-the-fuse-overlay-storage-driver.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
:_content-type: CONCEPT
:description: Restoring a Che workspace from a DevWorkspace backup
:keywords: workspace, backup, restore, devworkspace, dashboard
:navtitle: Restoring a workspace from backup
:page-aliases:

[id="restoring-a-workspace-from-backup"]
= Restoring a workspace from backup
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

When backup is enabled for {devworkspace} instances on your cluster, workspace data can be captured when a workspace stops.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When backup is enabled for {devworkspace} instances on your cluster, workspace data can be captured when a workspace stops.
When backups are enabled for {devworkspace} instances on your cluster, the system captures workspace data when a workspace stops. You can start a new workspace from an existing backup by using the {prod-short} dashboard.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to:

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

You can then start a new workspace from an existing backup by using the {prod-short} dashboard.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

The main purpose of backing up and restoring workspaces is to recover uncommited source code changes, and push them from the restore workspace. Restored workspaces are created with minimal devfiles, and will not be created with the original project's devfile.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

[NOTE]
====
Backup storage, registry access, and schedules are configured cluster-wide by administrators in the {devworkspace} Operator.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
For administrator steps, see xref:administration-guide:devworkspace-backup.adoc[].
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
====

== Understanding workspace backups
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

After an administrator enables cluster-wide backups, source code data of stopped workspaces will be backed up in a container image, and automatically pushed to an OCI-compatible registry.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

*Internal* backups are backups the {prod-short} dashboard detects and lists.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
On {ocp}, they are represented as `ImageStream` resources in your namespace.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

*External* backups are backups from a registry not specified by the administrator when cofiguring cluster-wide backups.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

External backups can also be defined by the cluster administrator if not using the built-in registry. This sentence is a bit confusing.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My latest change updates it to the following:
image

This is referring to the Default registry (ie, choosing from dropdown, it works for both internal openshift registry and other registries like quay.io) and External registry (manually input container image) section in the UI:
image

Basically, External registry in the UI is not referring registries that are not the internal openshift registry, it's referring to any registry not defined in the DevWorkspaceOperatorConfig .


From the 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.

[NOTE]
====
A restored workspace is created from a minimal devfile with the restored source code being transfered 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
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

. In the left sidebar, open *Workspace*.
. Select the *Backups* tab to see available backups.

.The *Backups* tab in the *Workspace* view
image::workspace-backup/backups_tab.png[Backups tab in the Workspace view of the dashboard,link="{imagesdir}/workspace-backup/backups_tab.png"]

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
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
. On the restore page, set the name for the restored workspace, and choose whether to use an internal backup (represented as an `ImageStream` resource in the cluster) or an external backup by providing your own backup image url.
+
.Restore mode and backup source
image::workspace-backup/restore_section_1.png[Choosing internal or external backup when restoring a workspace,link="{imagesdir}/workspace-backup/restore_section_1.png"]
. Optionally set memory and CPU limits, and the editor to use.
+
.Resource limits and editor for a restored workspace
image::workspace-backup/restore_section_2.png[Memory limit CPU limit and editor selection when restoring from backup,link="{imagesdir}/workspace-backup/restore_section_2.png"]

. Start the restore by clicking the *Restore Workspace* button and wait until the workspace is running.

.Additional resources

* link:https://github.com/eclipse-che/che-dashboard/pull/1471[che-dashboard pull request #1471: Backup and restore DevWorkspaces]
* link:https://github.com/eclipse-che/che-dashboard/pull/1478[che-dashboard pull request #1478: Resource limits and related restore UI improvements]
Loading