Skip to content
Merged
Show file tree
Hide file tree
Changes from 16 commits
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-workspaces-from-backups.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.
3 changes: 3 additions & 0 deletions modules/end-user-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
**** 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-workspaces-from-backups.adoc[]
*** xref:proc-restoring-a-workspace-from-backup.adoc[]
*** xref:proc-viewing-backups-in-the-dashboard.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-workspaces-from-backups.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,25 @@
:mod-docs-content-type: PROCEDURE
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
[id="restoring-a-workspace-from-backup{context}"]
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
= Restoring a workspace from a backup

You can start a new workspace from an existing backup by using the {prod-short} dashboard. When the restoration is complete, the dashboard opens the new workspace in a browser tab.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

.Prerequisites

Comment thread
dkwon17 marked this conversation as resolved.
Outdated
. Backups are enabled for your cluster.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
. You have identified a default registry or external registry backup image to use.

.Procedure

. On the Restore page, select the backup source:
** Default registry: Select a backup from the list.
** External registry: Provide a backup image URL.
+
.Restore mode and backup source selection
image::workspace-backup/restore_section_1.png[Selecting the backup source during restoration,link="{imagesdir}/workspace-backup/restore_section_1.png"]
. Enter a name for the restored workspace.
. Optional: Configure the memory limits, CPU limits, and the editor.
+
.Resource limits and editor selection
image::workspace-backup/restore_section_2.png[Configuring resources and editors for a restored workspace,link="{imagesdir}/workspace-backup/restore_section_2.png"]
. Click Restore Workspace and wait for the workspace to start.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:mod-docs-content-type: PROCEDURE
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
[id="viewing-backups-in-the-dashboard{context}"]
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
= Viewing backups in the dashboard

To inspect the status of your workspace backups, view the list of available backups in the {prod-short} dashboard.
Backups displayed in the {prod-short} dashboard are backups available in the default registry set by the administrator.

.Procedure

. In the {prod-short} dashboard, click Workspace.
. Select the Backups tab to view available backups.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

.The Backups tab in the Workspace view
image::workspace-backup/backups_tab.png[The 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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
:_content-type: CONCEPT
:description: Restoring a Che workspace from a DevWorkspace backup
:keywords: workspace, backup, restore, devworkspace, dashboard
:navtitle: Restoring workspaces from backups
:page-aliases:

[id="restoring-workspaces-from-backups"]
= Restoring workspaces from backups

When backups are enabled for {devworkspace} instances on your cluster, a cron job will backup workspace data for stopped workspaces.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

Backup storage, registry access, and schedules are configured cluster-wide by administrators in the {devworkspace} Operator.
For administrator steps, see xref:administration-guide:devworkspace-backup.adoc[].

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.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated

From the {prod-short} 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.
Comment thread
dkwon17 marked this conversation as resolved.
Outdated
The *Devfile* tab in the workspace will not show the original devfile from the workspace's Git repository.
====

include::proc-viewing-backups-in-the-dashboard.adoc[leveloffset=+1]

include::proc-restoring-a-workspace-from-backup.adoc[leveloffset=+1]
Loading