Skip to content

Commit 5950932

Browse files
committed
docs : update outdated restore documentation with restore functionality
Remove outdated section about workspace backup restore that was added during initial backup implementation. It is no longer relevant after changes in #1572 Signed-off-by: Rohan Kumar <rohaan@redhat.com>
1 parent cce29e8 commit 5950932

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/dwo-configuration.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -196,17 +196,21 @@ The secret must contain a label `controller.devfile.io/watch-secret=true` to be
196196
kubectl label secret my-secret controller.devfile.io/watch-secret=true -n devworkspace-controller
197197
```
198198

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

203-
Since the backup archive is available in OCI registry you can use any OCI compatible tool to pull
204-
the archive locally. For example using [oras](https://github.com/oras-project/oras) cli tool:
201+
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.
205202

206-
```bash
207-
oras pull <registry-path>/<devworkspace-name>:latest
203+
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.
204+
205+
```yaml
206+
kind: DevWorkspace
207+
spec:
208+
template:
209+
attributes:
210+
controller.devfile.io/restore-workspace: 'true'
211+
# Optional: restore from a specific image instead of the default backup registry
212+
controller.devfile.io/restore-source-image: 'registry.example.com/my-backup:latest'
208213
```
209-
The archive will be downloaded as a `devworkspace-backup.tar.gz` file which you can extract and restore the data.
210214

211215
## Configuring PVC storage access mode
212216

0 commit comments

Comments
 (0)