-
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
Merged
Merged
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 728d776
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 afde4cf
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 a67c454
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 e27b485
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 b798ed7
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 632d31d
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 39b6541
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 9b6d82f
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 a9ceeeb
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 6300eb6
Update modules/end-user-guide/pages/restoring-a-workspace-from-backup…
dkwon17 11e10dd
Break down docs into procedures
dkwon17 082a931
Fix wording
dkwon17 f422fff
Fix build error
dkwon17 a77ba1a
Update wording
dkwon17 4006534
Update ordering
dkwon17 e81307b
Update modules/end-user-guide/pages/restoring-workspaces-from-backups…
dkwon17 08dd112
Update screenshots
dkwon17 7baf4ad
Update modules/end-user-guide/pages/restoring-workspaces-from-backups…
dkwon17 6f9840c
Update modules/end-user-guide/pages/restoring-workspaces-from-backups…
dkwon17 7c57d57
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 116cd89
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 e489cdf
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 2b678b3
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 6b1b540
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 3fc87f4
Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashb…
dkwon17 4fbe707
Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashb…
dkwon17 76e51f5
Update modules/end-user-guide/pages/proc-viewing-backups-in-the-dashb…
dkwon17 db05a67
Update modules/end-user-guide/pages/proc-restoring-a-workspace-from-b…
dkwon17 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| :mod-docs-content-type: PROCEDURE | ||
| [id="restoring-a-workspace-from-backup{context}"] | ||
|
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. | ||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||
|
|
||
| .Prerequisites | ||
|
|
||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||
| . Backups are enabled for your cluster. | ||
|
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. | ||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||
16 changes: 16 additions & 0 deletions
16
modules/end-user-guide/pages/proc-viewing-backups-in-the-dashboard.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| :mod-docs-content-type: PROCEDURE | ||
|
dkwon17 marked this conversation as resolved.
Outdated
|
||
| [id="viewing-backups-in-the-dashboard{context}"] | ||
|
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. | ||
|
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. | ||
33 changes: 33 additions & 0 deletions
33
modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
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. | ||
|
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. | ||
|
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] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.