Skip to content

Commit dbf0312

Browse files
dkwon17gtrivedi88rohanKanojia
authored
Add end user restore documentation (#3045)
* Add end user restore documentation Signed-off-by: David Kwon <dakwon@redhat.com> Assisted-by: gemini-2.5-pro * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Break down docs into procedures Signed-off-by: dkwon17 <dakwon@redhat.com> * Fix wording Signed-off-by: dkwon17 <dakwon@redhat.com> * Fix build error Signed-off-by: dkwon17 <dakwon@redhat.com> * Update wording Signed-off-by: dkwon17 <dakwon@redhat.com> * Update ordering Signed-off-by: dkwon17 <dakwon@redhat.com> * Update modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc Co-authored-by: Rohan Kumar <rohan.kumar.kanojia@gmail.com> * Update screenshots Signed-off-by: dkwon17 <dakwon@redhat.com> * Update modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashboard.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashboard.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashboard.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> --------- Signed-off-by: David Kwon <dakwon@redhat.com> Signed-off-by: dkwon17 <dakwon@redhat.com> Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> Co-authored-by: Rohan Kumar <rohan.kumar.kanojia@gmail.com>
1 parent 990b6c7 commit dbf0312

9 files changed

Lines changed: 81 additions & 0 deletions

modules/administration-guide/pages/devworkspace-backup.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ integrated registry or link:https://quay.io[Quay.io], to store backup archives a
1414

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

17+
Users can restore backups from the {prod-short} dashboard. See xref:end-user-guide:restoring-workspaces-from-backups.adoc[].
18+
1719
NOTE: By default, the {devworkspace} backup job is disabled.
1820

1921
You can configure the backup by using the `DevWorkspaceOperatorConfig` resource with the following fields:
72.8 KB
Loading
53.6 KB
Loading
42.6 KB
Loading

modules/end-user-guide/nav.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
**** xref:url-parameter-for-the-existing-workspace-name.adoc[]
1818
** xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
1919
** xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
20+
** xref:restoring-workspaces-from-backups.adoc[]
21+
*** xref:proc-restoring-a-workspace-from-backup.adoc[]
22+
*** xref:proc-viewing-backups-in-the-dashboard.adoc[]
2023
** xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
2124
** xref:using-the-fuse-overlay-storage-driver.adoc[]
2225
*** xref:accessing-fuse.adoc[]

modules/end-user-guide/pages/getting-started-with-che.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@ If your organization is already running a {prod-short} instance, you can get sta
1313
* xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
1414
* xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
1515
* xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
16+
* xref:restoring-workspaces-from-backups.adoc[]
1617
* xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
1718
* xref:using-the-fuse-overlay-storage-driver.adoc[]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="restoring-a-workspace-from-backup_{context}"]
3+
= Restoring a workspace from a backup
4+
5+
Recover uncommitted changes or recreate a workspace environment by restoring from a backup snapshot through the {prod-short} dashboard. When the restoration is complete, the dashboard opens the new workspace in a browser tab.
6+
7+
.Prerequisites
8+
* Backups are enabled for your cluster.
9+
* You know which default registry or external registry backup image to use.
10+
. You have identified a default registry or external registry backup image to use.
11+
12+
.Procedure
13+
14+
. On the Restore page, select the backup source:
15+
** Default registry: Select a backup from the list.
16+
** External registry: Provide a backup image URL.
17+
+
18+
.Restore mode and backup source selection
19+
image::workspace-backup/restore_section_1.png[Selecting the backup source during restoration,link="{imagesdir}/workspace-backup/restore_section_1.png"]
20+
. Enter a name for the restored workspace.
21+
. Optional: Configure the memory limits, CPU limits, and the editor.
22+
+
23+
.Resource limits and editor selection
24+
image::workspace-backup/restore_section_2.png[Configuring resources and editors for a restored workspace,link="{imagesdir}/workspace-backup/restore_section_2.png"]
25+
. Click *Restore Workspace* and wait for the workspace to start.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="viewing-backups-in-the-dashboard_{context}"]
3+
= Viewing backups in the dashboard
4+
5+
To inspect the status of your workspace backups, view the list of available backups in the {prod-short} dashboard.
6+
Backups displayed in the {prod-short} dashboard are backups available in the default registry set by the administrator.
7+
8+
.Procedure
9+
10+
. In the {prod-short} dashboard, click Workspace.
11+
. In the {prod-short} dashboard, click *Workspaces*.
12+
. Select the *Backups* tab to view available backups.
13+
14+
.The Backups tab in the Workspace view
15+
image::workspace-backup/backups_tab.png[The Backups tab in the Workspace view of the dashboard,link="{imagesdir}/workspace-backup/backups_tab.png"]
16+
17+
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.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_content-type: CONCEPT
2+
:description: Restoring a Che workspace from a DevWorkspace backup
3+
:keywords: workspace, backup, restore, devworkspace, dashboard
4+
:navtitle: Restoring workspaces from backups
5+
:page-aliases:
6+
7+
[id="restoring-workspaces-from-backups"]
8+
= Restoring workspaces from backups
9+
10+
When backups are enabled for {devworkspace} instances on your cluster, a cron job backs up workspace data for stopped workspaces.
11+
12+
Backup storage, registry access, and schedules are configured cluster-wide by administrators in the {devworkspace} Operator.
13+
For administrator steps, see xref:administration-guide:devworkspace-backup.adoc[].
14+
15+
Backing up and restoring workspaces allows you to recover uncommitted source code changes. Restored workspaces use a minimal devfile rather than the original project devfile.
16+
17+
From the {prod-short} dashboard you can:
18+
19+
* Open the list of backups and inspect backup status.
20+
* Restore a workspace from a backup that is already available to you (*internal* backup), or from an image reference you provide (*external* backup).
21+
* Choose compute limits and the editor for the new workspace before you start the restore.
22+
23+
When the restored workspace is ready, the dashboard opens it in a new browser tab.
24+
25+
[NOTE]
26+
====
27+
A restored workspace is created from a minimal devfile with the restored source code being transferred to the workspace from an init container.
28+
The *Devfile* tab in the workspace will not show the original devfile from the workspace's Git repository.
29+
====
30+
31+
include::proc-viewing-backups-in-the-dashboard.adoc[leveloffset=+1]
32+
33+
include::proc-restoring-a-workspace-from-backup.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)