-
Notifications
You must be signed in to change notification settings - Fork 173
Add end user restore documentation #3045
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
f0e141d
728d776
afde4cf
a67c454
e27b485
b798ed7
632d31d
39b6541
9b6d82f
a9ceeeb
6300eb6
11e10dd
082a931
f422fff
a77ba1a
4006534
e81307b
08dd112
7baf4ad
6f9840c
7c57d57
116cd89
e489cdf
2b678b3
6b1b540
3fc87f4
4fbe707
76e51f5
db05a67
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||||||
|
|
||||||
| When backup is enabled for {devworkspace} instances on your cluster, workspace data can be captured when a workspace stops. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Changed to: |
||||||
| You can then start a new workspace from an existing backup by using the {prod-short} dashboard. | ||||||
|
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. | ||||||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| [NOTE] | ||||||
| ==== | ||||||
| Backup storage, registry access, and schedules are configured cluster-wide by administrators in the {devworkspace} Operator. | ||||||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||||||
| For administrator steps, see xref:administration-guide:devworkspace-backup.adoc[]. | ||||||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||||||
| ==== | ||||||
|
|
||||||
| == Understanding workspace backups | ||||||
|
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. | ||||||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| *Internal* backups are backups the {prod-short} dashboard detects and lists. | ||||||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||||||
| On {ocp}, they are represented as `ImageStream` resources in your namespace. | ||||||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| *External* backups are backups from a registry not specified by the administrator when cofiguring cluster-wide backups. | ||||||
|
dkwon17 marked this conversation as resolved.
Outdated
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My latest change updates it to the following: This is referring to the Basically, |
||||||
|
|
||||||
| 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 | ||||||
|
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 | ||||||
|
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] | ||||||


Uh oh!
There was an error while loading. Please reload this page.