doc: Add documentation for backup feature #1547

Allda · 2025-12-11T14:11:55Z

The DevWorkspaceOperatorConfig was extended to enable the workspace backup process. This commits describes the feature and how to configure it.

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

PR Checklist

E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)
- v8-devworkspace-operator-e2e: DevWorkspace e2e test
- v8-che-happy-path: Happy path for verification integration with Che

docs/dwo-configuration.md

The DevWorkspaceOperatorConfig was extended to enable the workspace backup process. This commits describes the feature and how to configure it. Signed-off-by: Ales Raszka <araszka@redhat.com>

openshift-ci · 2025-12-11T17:02:26Z

@Allda: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/v14-che-happy-path	`f3e7717`	link	true	`/test v14-che-happy-path`

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

ibuziuk · 2025-12-12T12:20:35Z

docs/dwo-configuration.md

+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:
+`<registry.path>/<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.


might be worth cross-linking with https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/registry/registry-overview

ibuziuk · 2025-12-12T12:23:47Z

docs/dwo-configuration.md

+
+There are several configuration options to customize the logic:
+
+### Integrated OpenShift container registry


Suggested change

### Integrated OpenShift container registry

### Integrated OpenShift container registry

Actually, disregard my previous comment, since it looks like this is an official naming - https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/registry/registry-overview#openshift-registry-common-terms_registry-overview

ibuziuk · 2025-12-12T12:25:06Z

docs/dwo-configuration.md

+
+**Note:** The `path` field must contain the URL to your OpenShift integrated registry given by the cluster.
+
+Once the backup job is finished the backup archives will be available in the DevWorkspace namespace under a repository


Suggested change

Once the backup job is finished the backup archives will be available in the DevWorkspace namespace under a repository

Once the backup job is finished, the backup archives will be available in the DevWorkspace namespace under a repository

ibuziuk · 2025-12-12T12:25:36Z

docs/dwo-configuration.md

+with matching Devworkspace name.
+
+### Regular OCI compatible registry
+To use a regular OCI compatible registry for backups, you need to provide registry credentials. Depending on your


Suggested change

To use a regular OCI compatible registry for backups, you need to provide registry credentials. Depending on your

To use a regular OCI-compatible registry for backups, you need to provide registry credentials. Depending on your

ibuziuk · 2025-12-12T12:25:47Z

docs/dwo-configuration.md

+Once the backup job is finished the backup archives will be available in the DevWorkspace namespace under a repository
+with matching Devworkspace name.
+
+### Regular OCI compatible registry


Suggested change

### Regular OCI compatible registry

### Regular OCI-compatible registry

ibuziuk · 2025-12-12T12:26:12Z

docs/dwo-configuration.md

+
+### Regular OCI compatible registry
+To use a regular OCI compatible registry for backups, you need to provide registry credentials. Depending on your
+RBAC policy the token can be provided via a secret in the operator namespace or in each DevWorkspace namespace.


Suggested change

RBAC policy the token can be provided via a secret in the operator namespace or in each DevWorkspace namespace.

RBAC policy, the token can be provided via a secret in the operator namespace or in each DevWorkspace namespace.

ibuziuk

great read, added a few minor suggestions

openshift-ci · 2025-12-12T12:27:33Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Allda, ibuziuk, rohanKanojia
Once this PR has been reviewed and has the lgtm label, please assign dkwon17 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

dkwon17 · 2025-12-12T22:26:29Z

docs/dwo-configuration.md

+**Note:** The `path` field must contain the URL to your OpenShift integrated registry given by the cluster.
+
+Once the backup job is finished the backup archives will be available in the DevWorkspace namespace under a repository
+with matching Devworkspace name.


Suggested change

with matching Devworkspace name.

with a matching Devworkspace name.

dkwon17 · 2025-12-12T22:28:01Z

docs/dwo-configuration.md

+
+```yaml
+kind: DevWorkspaceOperatorConfig
+apiVersion: controller.devfile.io/v1alpha1


Suggested change

apiVersion: controller.devfile.io/v1alpha1

apiVersion: controller.devfile.io/v1alpha1

metadata:

name: devworkspace-operator-config

namespace: $OPERATOR_INSTALL_NAMESPACE

dkwon17 · 2025-12-12T22:29:49Z

docs/dwo-configuration.md

+      schedule: '0 */4 * * *'
+    imagePullPolicy: Always
+```
+The `authSecret` must point to real Kubernetes Secret of type `kubernetes.io/dockerconfigjson` containing credentials to access the registry.


Suggested change

The `authSecret` must point to real Kubernetes Secret of type `kubernetes.io/dockerconfigjson` containing credentials to access the registry.

The `authSecret` must point to a real Kubernetes Secret of type `kubernetes.io/dockerconfigjson` containing credentials to access the registry.

dkwon17

LGTM, just a couple of comments on my side

dkwon17 · 2025-12-12T22:30:30Z

docs/dwo-configuration.md

+
+```yaml
+apiVersion: controller.devfile.io/v1alpha1
+kind: DevWorkspaceOperatorConfig


Suggested change

kind: DevWorkspaceOperatorConfig

kind: DevWorkspaceOperatorConfig

metadata:

name: devworkspace-operator-config

namespace: $OPERATOR_INSTALL_NAMESPACE

Allda requested review from akurinnoy, dkwon17, ibuziuk and rohanKanojia as code owners December 11, 2025 14:11

rohanKanojia reviewed Dec 11, 2025

View reviewed changes

docs/dwo-configuration.md Outdated Show resolved Hide resolved

docs/dwo-configuration.md Outdated Show resolved Hide resolved

Allda force-pushed the backup-doc branch 2 times, most recently from 9ba5af5 to 0a800dc Compare December 11, 2025 14:20

ibuziuk reviewed Dec 11, 2025

View reviewed changes

docs/dwo-configuration.md Outdated Show resolved Hide resolved

rohanKanojia reviewed Dec 11, 2025

View reviewed changes

docs/dwo-configuration.md Outdated Show resolved Hide resolved

doc: Add documentation for backup feature

f3e7717

The DevWorkspaceOperatorConfig was extended to enable the workspace backup process. This commits describes the feature and how to configure it. Signed-off-by: Ales Raszka <araszka@redhat.com>

Allda force-pushed the backup-doc branch from 0a800dc to f3e7717 Compare December 11, 2025 16:01

rohanKanojia approved these changes Dec 11, 2025

View reviewed changes

openshift-ci bot assigned rohanKanojia Dec 11, 2025

openshift-ci bot added the lgtm label Dec 11, 2025

ibuziuk reviewed Dec 12, 2025

View reviewed changes

ibuziuk approved these changes Dec 12, 2025

View reviewed changes

openshift-ci bot assigned ibuziuk Dec 12, 2025

dkwon17 reviewed Dec 12, 2025

View reviewed changes


		There are several configuration options to customize the logic:

		### Integrated OpenShift container registry


		Note: The `path` field must contain the URL to your OpenShift integrated registry given by the cluster.

		Once the backup job is finished the backup archives will be available in the DevWorkspace namespace under a repository

	Once the backup job is finished the backup archives will be available in the DevWorkspace namespace under a repository
	Once the backup job is finished, the backup archives will be available in the DevWorkspace namespace under a repository

	To use a regular OCI compatible registry for backups, you need to provide registry credentials. Depending on your
	To use a regular OCI-compatible registry for backups, you need to provide registry credentials. Depending on your

	### Regular OCI compatible registry
	### Regular OCI-compatible registry

	RBAC policy the token can be provided via a secret in the operator namespace or in each DevWorkspace namespace.
	RBAC policy, the token can be provided via a secret in the operator namespace or in each DevWorkspace namespace.

	with matching Devworkspace name.
	with a matching Devworkspace name.

-apiVersion: controller.devfile.io/v1alpha1
+apiVersion: controller.devfile.io/v1alpha1
+metadata:
+  name: devworkspace-operator-config
+  namespace: $OPERATOR_INSTALL_NAMESPACE

	The `authSecret` must point to real Kubernetes Secret of type `kubernetes.io/dockerconfigjson` containing credentials to access the registry.
	The `authSecret` must point to a real Kubernetes Secret of type `kubernetes.io/dockerconfigjson` containing credentials to access the registry.

doc: Add documentation for backup feature #1547

Are you sure you want to change the base?

doc: Add documentation for backup feature #1547

Conversation

Allda commented Dec 11, 2025

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ibuziuk Dec 12, 2025 • 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!

ibuziuk left a comment • 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!

openshift-ci bot commented Dec 12, 2025

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!

dkwon17 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openshift-ci bot commented Dec 11, 2025 •

edited

Loading

ibuziuk Dec 12, 2025 •

edited

Loading

ibuziuk left a comment •

edited

Loading