Add end user restore documentation#3045
Conversation
Signed-off-by: David Kwon <dakwon@redhat.com> Assisted-by: gemini-2.5-pro
|
🎊 Navigate the preview: https://69c551c66356e6685aa3dad5--eclipse-che-docs-pr.netlify.app 🎊 |
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
| [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. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
Changed to:
When backups are enabled for {devworkspace} instances on your cluster, a cron job will backup workspace data for stopped workspaces.
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
|
Hi @dkwon17 We have a concept module and two procedures module in here. As a results, based on mod docs guide lines we need 3 files.
Please let me know if you have questions. |
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
| *Internal* backups are backups the {prod-short} dashboard detects and lists. | ||
| On {ocp}, they are represented as `ImageStream` resources in your namespace. | ||
|
|
||
| *External* backups are backups from a registry not specified by the administrator when cofiguring cluster-wide backups. |
There was a problem hiding this comment.
External backups can also be defined by the cluster administrator if not using the built-in registry. This sentence is a bit confusing.
There was a problem hiding this comment.
My latest change updates it to the following:

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:

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 .
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc
Outdated
Show resolved
Hide resolved
….adoc Co-authored-by: Rohan Kumar <rohan.kumar.kanojia@gmail.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/restoring-workspaces-from-backups.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-restoring-a-workspace-from-backup.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-viewing-backups-in-the-dashboard.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-viewing-backups-in-the-dashboard.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/proc-viewing-backups-in-the-dashboard.adoc
Outdated
Show resolved
Hide resolved
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…ackup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…ackup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…ackup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…ackup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…ackup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…oard.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…oard.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…oard.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
…ackup.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
* 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>
* Add note about default DWO installation namespace (#3034) * Add note about default DWO installation namespace Signed-off-by: dkwon17 <dakwon@redhat.com> * Mention that default DWO namespace is openshift-operators for OpenShift Signed-off-by: dkwon17 <dakwon@redhat.com> * Update modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/administration-guide/pages/devworkspace-backup-integrated-openshift-registry.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Fix error with # in the reference url Signed-off-by: dkwon17 <dakwon@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com> Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * 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> * Update backup config docs to mention backoffLimit (#3044) * Update backup config docs to mention backoffLimit Signed-off-by: dkwon17 <dakwon@redhat.com> * Update namespace for backup auth secret Signed-off-by: dkwon17 <dakwon@redhat.com> * Add example usecase of oras.extraArgs Signed-off-by: dkwon17 <dakwon@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com> Signed-off-by: David Kwon <dakwon@redhat.com> Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> Co-authored-by: Rohan Kumar <rohan.kumar.kanojia@gmail.com>
Assisted-by: gemini-2.5-pro
What does this pull request change?
Adds restore documentation for the dashboard.
The doc is available in the new
Restoring a workspace from backupsection in the end user guide.What issues does this pull request fix or reference?
Documentation is for functionality added from these PRs:
Specify the version of the product this pull request applies to
DS 3.27
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.