docs: Add a doc for devworkspace backup feature by Allda · Pull Request #3028 · eclipse-che/che-docs

Allda · 2026-02-19T13:42:26Z

What does this pull request change?

The pull request adds documentation for a backup feature introduced in the recent devworkspace operator.

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

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.

Any procedure:
- Successfully tested.
Any page or link rename:
- The page contains a redirection for the previous URL.
- Propagate the URL change in:
  - Dashboard default branding data
Builds on Eclipse Che hosted by Red Hat.
the Validate language on files added or modified step reports no vale warnings.

github-actions · 2026-02-19T13:42:34Z

⚡️ Deploying pull request preview...

github-actions · 2026-02-19T13:42:36Z

Click here to review and test in web IDE:

Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda · 2026-02-19T15:11:38Z

@akurinnoy I added a doc for the backup feature. Once you have a dashboard available, could you create another PR with a doc for the dashboard?

ibuziuk · 2026-02-23T10:46:18Z

modules/administration-guide/pages/devworkspace-backup.adoc

+[id="devworkspace-backup"]
+= Workspace backup for {prod}
+
+Starting from {prod} version v7.115.0, the {devworkspace} backup job allows for periodic backups of {devworkspace} data to a specified backup location.


@gtrivedi88 ptal, and recommend how the docs should be downstreamed e.g. 7.115 - > Dev Spaces 3.27

@ibuziuk As for downstreaming, when this is merged and we carve out a 7.115 branch in main. The pipeline watcher which watches for the changes in upstream branch for specific release versions, will create a issue in Gitlab.

At the very begining of every release, in the attributes we have to define the upstream branches (7.114.x, and 7.115.x) which will make downstream (3.27) and then schedule a pipieline, which will keep watching for those branches for content updates.

Let me know if you have questions

modules/administration-guide/pages/devworkspace-backup.adoc

ibuziuk

@Allda LGTM, but we also need to cover the restore process as part of this procedure to have the e2e experience documented

Allda · 2026-02-24T11:33:29Z

@Allda LGTM, but we also need to cover the restore process as part of this procedure to have the e2e experience documented

Yep, that is why I pinged @akurinnoy earlier in this PR to address the restore doc once the dashboard is finished #3028 (comment)

Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda · 2026-02-26T13:28:31Z

@ibuziuk I addressed your notes. Can this be merged? The restore feature will be documented in a separate PR.

ibuziuk · 2026-02-26T14:31:03Z

@Allda I have concern about Starting from {prod} version v7.115.0 which is upstream specific

Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda · 2026-02-27T07:50:53Z

@Allda I have concern about Starting from {prod} version v7.115.0 which is upstream specific

@ibuziuk I removed it based on an agreement from yesterday.

modules/administration-guide/pages/devworkspace-backup.adoc

Signed-off-by: Ales Raszka <araszka@redhat.com>

gtrivedi88 · 2026-03-02T12:41:36Z

modules/administration-guide/pages/devworkspace-backup.adoc

+[id="devworkspace-backup"]
+= Workspace backup for {prod}
+
+The {devworkspace} backup job allows for periodic backups of {devworkspace} data to a specified backup location.


Suggested change

The {devworkspace} backup job allows for periodic backups of {devworkspace} data to a specified backup location.

The {devworkspace} backup job provides periodic backups of {devworkspace} data to a specified location. After you enable and configure the job, it runs at defined intervals to create backups of {devworkspace} data. The backup controller requires an OCI-compliant registry, such as the **Red Hat OpenShift** integrated registry or link:https://quay.io[Quay.io], to store backup archives as image artifacts.

gtrivedi88 · 2026-03-02T12:41:51Z

modules/administration-guide/pages/devworkspace-backup.adoc

+= Workspace backup for {prod}
+
+The {devworkspace} backup job allows for periodic backups of {devworkspace} data to a specified backup location.
+Once enabled and configured, the backup job will run at defined intervals to create backups of {devworkspace} data.


Suggested change

Once enabled and configured, the backup job will run at defined intervals to create backups of {devworkspace} data.

gtrivedi88 · 2026-03-02T12:52:16Z

modules/administration-guide/pages/devworkspace-backup.adoc

+
+The {devworkspace} backup job allows for periodic backups of {devworkspace} data to a specified backup location.
+Once enabled and configured, the backup job will run at defined intervals to create backups of {devworkspace} data.
+The backup controller depends on an OCI-compatible registry e.g.,https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp4-ver}/html/registry/registry-overview#registry-integrated-openshift-registry_registry-overview[OpenShift build-in registry]


Suggested change

The backup controller depends on an OCI-compatible registry e.g.,https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp4-ver}/html/registry/registry-overview#registry-integrated-openshift-registry_registry-overview[OpenShift build-in registry]

gtrivedi88 · 2026-03-02T12:52:24Z

modules/administration-guide/pages/devworkspace-backup.adoc

+The {devworkspace} backup job allows for periodic backups of {devworkspace} data to a specified backup location.
+Once enabled and configured, the backup job will run at defined intervals to create backups of {devworkspace} data.
+The backup controller depends on an OCI-compatible registry e.g.,https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp4-ver}/html/registry/registry-overview#registry-integrated-openshift-registry_registry-overview[OpenShift build-in registry]
+or https://quay.io[quay.io] used as an image artifact storage for backup archives.


Suggested change

or https://quay.io[quay.io] used as an image artifact storage for backup archives.

gtrivedi88 · 2026-03-02T12:52:35Z

modules/administration-guide/pages/devworkspace-backup.adoc

+The backup controller depends on an OCI-compatible registry e.g.,https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp4-ver}/html/registry/registry-overview#registry-integrated-openshift-registry_registry-overview[OpenShift build-in registry]
+or https://quay.io[quay.io] used as an image artifact storage for backup archives.
+
+The backup makes a snapshot of *stopped* Workspace PVCs and stores them as tar.gz archives in the specified OCI registry.


Suggested change

The backup makes a snapshot of *stopped* Workspace PVCs and stores them as tar.gz archives in the specified OCI registry.

The backup process takes a snapshot of *stopped* workspace persistent volume claims (PVCs) and stores them as `tar.gz` archives in the specified OCI registry.

@gtrivedi88 The stopped workspace is impotant detail to mention. Do you really want it to be removed? The backup won't happen for the running workspace.

Thank you, please add. I have updated my comment.

gtrivedi88 · 2026-03-02T12:53:10Z

modules/administration-guide/pages/devworkspace-backup.adoc

+
+NOTE: By default, the {devworkspace} backup job is disabled.
+
+The backup is configurable using `DevWorkspaceOperatorConfig` with the following fields:


Suggested change

The backup is configurable using `DevWorkspaceOperatorConfig` with the following fields:

You can configure the backup by using the `DevWorkspaceOperatorConfig` resource with the following fields:

gtrivedi88 · 2026-03-02T12:53:27Z

modules/administration-guide/pages/devworkspace-backup.adoc

+
+The backup is configurable using `DevWorkspaceOperatorConfig` with the following fields:
+
+* *`enable`*: Set to `true` to enable the backup job, `false` to disable it. Default: `false`.


Suggested change

* *`enable`*: Set to `true` to enable the backup job, `false` to disable it. Default: `false`.

* `enable`: Set to `true` to enable the backup job or `false` to disable it. The default value is `false`.

gtrivedi88 · 2026-03-02T12:53:48Z

modules/administration-guide/pages/devworkspace-backup.adoc

+The backup is configurable using `DevWorkspaceOperatorConfig` with the following fields:
+
+* *`enable`*: Set to `true` to enable the backup job, `false` to disable it. Default: `false`.
+* *`schedule`*: A Cron expression defining how often the backup job runs. Default: `"0 1 * * *"`.


Suggested change

* *`schedule`*: A Cron expression defining how often the backup job runs. Default: `"0 1 * * *"`.

* `schedule`: A Cron expression that defines the backup frequency. The default value is `"0 1 * * *"`.

gtrivedi88 · 2026-03-02T12:54:00Z

modules/administration-guide/pages/devworkspace-backup.adoc

+
+* *`enable`*: Set to `true` to enable the backup job, `false` to disable it. Default: `false`.
+* *`schedule`*: A Cron expression defining how often the backup job runs. Default: `"0 1 * * *"`.
+* *`registry.path`*: A base registry location where the backup archives will be pushed.


Suggested change

* *`registry.path`*: A base registry location where the backup archives will be pushed.

* `registry.path`: The base registry location for backup archives.

gtrivedi88 · 2026-03-02T12:54:20Z

modules/administration-guide/pages/devworkspace-backup.adoc

+* *`schedule`*: A Cron expression defining how often the backup job runs. Default: `"0 1 * * *"`.
+* *`registry.path`*: A base registry location where the backup archives will be pushed.
+
+The value provided for registry.path is only the first segment of the final location. The full registry path is assembled dynamically, incorporating the name of the workspace and the :latest tag, following this pattern:


Suggested change

The value provided for registry.path is only the first segment of the final location. The full registry path is assembled dynamically, incorporating the name of the workspace and the :latest tag, following this pattern:

The value for `registry.path` is the first segment of the final location. The full path is assembled dynamically by using the workspace name and the `:latest` tag in the following pattern:

gtrivedi88 · 2026-03-02T12:54:41Z

modules/administration-guide/pages/devworkspace-backup.adoc

+
+`<registry.path>/<namespace>/<devworkspace-name>:latest`
+
+* *`registry.authSecret`*: (Optional) The name of the Kubernetes Secret containing credentials to access the OCI registry. If not provided, it is assumed that the registry is public or uses integrated OpenShift registry.


Suggested change

* *`registry.authSecret`*: (Optional) The name of the Kubernetes Secret containing credentials to access the OCI registry. If not provided, it is assumed that the registry is public or uses integrated OpenShift registry.

* `registry.authSecret`: (Optional) The name of the Kubernetes secret that contains credentials for the OCI registry. If you do not provide a secret, the system assumes the registry is public or uses the **Red Hat OpenShift** integrated registry.

gtrivedi88 · 2026-03-02T12:55:02Z

modules/administration-guide/pages/devworkspace-backup.adoc

+`<registry.path>/<namespace>/<devworkspace-name>:latest`
+
+* *`registry.authSecret`*: (Optional) The name of the Kubernetes Secret containing credentials to access the OCI registry. If not provided, it is assumed that the registry is public or uses integrated OpenShift registry.
+* *`oras.extraArgs`*: (Optional) Additional arguments to pass to the `oras` CLI tool during push and pull operations.


Suggested change

* *`oras.extraArgs`*: (Optional) Additional arguments to pass to the `oras` CLI tool during push and pull operations.

* `oras.extraArgs`: (Optional) Additional arguments for the `oras` CLI tool during push and pull operations.

gtrivedi88 · 2026-03-02T12:57:51Z

modules/administration-guide/pages/devworkspace-backup.adoc

+* *`oras.extraArgs`*: (Optional) Additional arguments to pass to the `oras` CLI tool during push and pull operations.
+
+
+There are several configuration options to customize the logic:


I feel this is a big topic and we can have multiple .adoc files.
Please see my comment here: #3029 (comment)

I see we have a mix of concept and procedures in one .adoc file.

Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda requested review from a team, deerskindoll, gtrivedi88 and mkuznyetsov as code owners February 19, 2026 13:42

Allda requested a review from tolusha February 19, 2026 13:42

Allda force-pushed the backup-doc branch 3 times, most recently from 84931c4 to a7da9ea Compare February 19, 2026 14:04

docs: Add a doc for devworkspace backup feature

ce2c46e

Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda force-pushed the backup-doc branch from a7da9ea to ce2c46e Compare February 19, 2026 15:04

ibuziuk reviewed Feb 23, 2026

View reviewed changes

modules/administration-guide/pages/devworkspace-backup.adoc Outdated Show resolved Hide resolved

ibuziuk reviewed Feb 23, 2026

View reviewed changes

Add OCP build-in registry to backup doc

f5c1bbd

Signed-off-by: Ales Raszka <araszka@redhat.com>

Remove the version from backup doc

2410195

Signed-off-by: Ales Raszka <araszka@redhat.com>

tolusha reviewed Feb 27, 2026

View reviewed changes

rohanKanojia reviewed Feb 27, 2026

View reviewed changes

modules/administration-guide/pages/devworkspace-backup.adoc Outdated Show resolved Hide resolved

rohanKanojia reviewed Feb 27, 2026

View reviewed changes

modules/administration-guide/pages/devworkspace-backup.adoc Outdated Show resolved Hide resolved

btjd reviewed Feb 27, 2026

View reviewed changes

modules/administration-guide/pages/devworkspace-backup.adoc Outdated Show resolved Hide resolved

fix: Address PR reviews comments

344ab69

Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda force-pushed the backup-doc branch from 39405bf to 344ab69 Compare March 2, 2026 12:36

gtrivedi88 reviewed Mar 2, 2026

View reviewed changes

Split backup doc into multiple

ed96736

Signed-off-by: Ales Raszka <araszka@redhat.com>

	The backup makes a snapshot of stopped Workspace PVCs and stores them as tar.gz archives in the specified OCI registry.
	The backup process takes a snapshot of stopped workspace persistent volume claims (PVCs) and stores them as `tar.gz` archives in the specified OCI registry.


		NOTE: By default, the {devworkspace} backup job is disabled.

		The backup is configurable using `DevWorkspaceOperatorConfig` with the following fields:

	The backup is configurable using `DevWorkspaceOperatorConfig` with the following fields:
	You can configure the backup by using the `DevWorkspaceOperatorConfig` resource with the following fields:


		The backup is configurable using `DevWorkspaceOperatorConfig` with the following fields:

		* `enable`: Set to `true` to enable the backup job, `false` to disable it. Default: `false`.

	* `enable`: Set to `true` to enable the backup job, `false` to disable it. Default: `false`.
	* `enable`: Set to `true` to enable the backup job or `false` to disable it. The default value is `false`.

	* `schedule`: A Cron expression defining how often the backup job runs. Default: `"0 1 * * *"`.
	* `schedule`: A Cron expression that defines the backup frequency. The default value is `"0 1 * * *"`.

	* `registry.path`: A base registry location where the backup archives will be pushed.
	* `registry.path`: The base registry location for backup archives.

	The value provided for registry.path is only the first segment of the final location. The full registry path is assembled dynamically, incorporating the name of the workspace and the :latest tag, following this pattern:
	The value for `registry.path` is the first segment of the final location. The full path is assembled dynamically by using the workspace name and the `:latest` tag in the following pattern:

	* `registry.authSecret`: (Optional) The name of the Kubernetes Secret containing credentials to access the OCI registry. If not provided, it is assumed that the registry is public or uses integrated OpenShift registry.
	* `registry.authSecret`: (Optional) The name of the Kubernetes secret that contains credentials for the OCI registry. If you do not provide a secret, the system assumes the registry is public or uses the Red Hat OpenShift integrated registry.

	* `oras.extraArgs`: (Optional) Additional arguments to pass to the `oras` CLI tool during push and pull operations.
	* `oras.extraArgs`: (Optional) Additional arguments for the `oras` CLI tool during push and pull operations.

		* `oras.extraArgs`: (Optional) Additional arguments to pass to the `oras` CLI tool during push and pull operations.


		There are several configuration options to customize the logic:

Conversation

Allda commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this pull request change?

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

Pull Request checklist

Uh oh!

github-actions bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Allda commented Feb 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtrivedi88 Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ibuziuk left a comment

Choose a reason for hiding this comment

Uh oh!

Allda commented Feb 24, 2026

Uh oh!

Allda commented Feb 26, 2026

Uh oh!

ibuziuk commented Feb 26, 2026

Uh oh!

Allda commented Feb 27, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtrivedi88 Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtrivedi88 Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Allda commented Feb 19, 2026 •

edited

Loading

github-actions bot commented Feb 19, 2026 •

edited

Loading

github-actions bot commented Feb 19, 2026 •

edited

Loading

gtrivedi88 Mar 2, 2026 •

edited

Loading

gtrivedi88 Mar 2, 2026 •

edited

Loading

gtrivedi88 Mar 2, 2026 •

edited

Loading