Skip to content

docs : update outdated restore documentation with restore functionality #1603

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.

Sign up for GitHub

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

Open
rohanKanojia wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −8
Open

docs : update outdated restore documentation with restore functionality #1603

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 12 additions & 8 deletions docs/dwo-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,17 +196,21 @@ The secret must contain a label `controller.devfile.io/watch-secret=true` to be
kubectl label secret my-secret controller.devfile.io/watch-secret=true -n devworkspace-controller
```

### Restore from backup
We are aiming to provide automated restore functionality in future releases. But for now you can still
manually restore the data from the backup archives created by the backup job.
### Restore workspace from backup

Since the backup archive is available in OCI registry you can use any OCI compatible tool to pull
the archive locally. For example using [oras](https://github.com/oras-project/oras) cli tool:
DevWorkspaces can now be restored from a backup by setting the `controller.devfile.io/restore-workspace: 'true'` attribute. When this attribute is set, the workspace deployment includes a restore init container that pulls the backed-up `/projects` content from an OCI registry instead of cloning from Git.
Copy link
Collaborator

@dkwon17 dkwon17 Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small suggestion:

Suggested change
DevWorkspaces can now be restored from a backup by setting the `controller.devfile.io/restore-workspace: 'true'` attribute. When this attribute is set, the workspace deployment includes a restore init container that pulls the backed-up `/projects` content from an OCI registry instead of cloning from Git.
DevWorkspaces can be restored from a backup by setting the `controller.devfile.io/restore-workspace: 'true'` attribute. When this attribute is set, the workspace deployment includes a restore init container that pulls the backed-up `/projects` content from an OCI registry instead of cloning from Git.


```bash
oras pull <registry-path>/<devworkspace-name>:latest
By default, the restore source is derived from the admin-configured registry at `<registry>/<namespace>/<workspace>:latest`. Users can optionally specify a custom source image using the `controller.devfile.io/restore-source-image` attribute.

```yaml
kind: DevWorkspace
spec:
template:
attributes:
controller.devfile.io/restore-workspace: 'true'
# Optional: restore from a specific image instead of the default backup registry
controller.devfile.io/restore-source-image: 'registry.example.com/my-backup:latest'
```
The archive will be downloaded as a `devworkspace-backup.tar.gz` file which you can extract and restore the data.

## Configuring PVC storage access mode

Expand Down
Loading