Skip to content

docs: mention DWO_NAMESPACE env var in backup docs #3059

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
dkwon17 wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −0
Open

docs: mention DWO_NAMESPACE env var in backup docs #3059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8cd7b1
docs: mention DWO_NAMESPACE env var in backup docs
dkwon17 Mar 31, 2026
430468b
Fix PR feedback
dkwon17 Apr 2, 2026
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
2 changes: 2 additions & 0 deletions ...ministration-guide/pages/devworkspace-backup-integrated-openshift-registry.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,5 @@ echo "https://$(oc get route default-route -n openshift-image-registry --templat

Once the backup job is finished, the backup archives will be available in the {devworkspace} {namespace} under a repository
with a matching {devworkspace} name.

include::partial$snip_defining-dwo-namespace-for-backups.adoc[]
2 changes: 2 additions & 0 deletions modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ kubectl label secret devworkspace-backup-registry-auth controller.devfile.io/wat
====
The {devworkspace} Operator copies the `devworkspace-backup-registry-auth` secret to each {devworkspace} {namespace} so that backups from user workspaces can be pushed to the registry. If you do not want that secret copied automatically, create a `devworkspace-backup-registry-auth` secret with user-specific credentials in each {devworkspace} {namespace} instead.
====

include::partial$snip_defining-dwo-namespace-for-backups.adoc[]
22 changes: 22 additions & 0 deletions modules/administration-guide/partials/snip_defining-dwo-namespace-for-backups.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
:_content-type: SNIPPET

[NOTE]
====
If the installation {namespace} for the {devworkspace} operator is not `openshift-operators`, you must define it as an environment variable for the {prod} dashboard in the `CheCluster` Custom Resource.

[source,yaml,subs="+attributes,+quotes"]
----
apiVersion: org.eclipse.che/v2
kind: CheCluster
spec:
components:
dashboard:
deployment:
containers:
- env:
- name: DWO_NAMESPACE
value: $OPERATOR_INSTALL_NAMESPACE <1>
name: che-dashboard
Copy link
Copy Markdown
Contributor Author

@dkwon17 dkwon17 Mar 31, 2026

Choose a reason for hiding this comment

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

This value is the same for both upstream and downstream.

----
Copy link
Copy Markdown
Contributor

@gtrivedi88 gtrivedi88 Apr 1, 2026

Choose a reason for hiding this comment

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

Minor: The file should end with a final newline after ---- to comply with .editorconfig (insert_final_newline = true) and prevent AsciiDoc rendering issues when the snippet is included mid-file (as in the regular OCI registry page).

Copy link
Copy Markdown
Contributor Author

@dkwon17 dkwon17 Apr 2, 2026

Choose a reason for hiding this comment

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

fixed

<1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:devworkspace-operator.adoc[{devworkspace} operator overview].
====
Loading