Skip to content

Update backup registry secret name #3054

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 4 commits into
base: main
Choose a base branch
from
+9 −4
Open

Update backup registry secret name #3054

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2d29171
Update backup registry secret name
dkwon17 Mar 26, 2026
1ccc94a
Update modules/administration-guide/pages/devworkspace-backup-regular…
dkwon17 Mar 27, 2026
f5272ba
Update modules/administration-guide/pages/devworkspace-backup-regular…
dkwon17 Mar 27, 2026
f2d5080
Add warning about auth secret copy functionality
dkwon17 Mar 27, 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
13 changes: 9 additions & 4 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 @@ -26,26 +26,31 @@ config:
backupCronJob:
enable: true
registry:
authSecret: my-secret
authSecret: devworkspace-backup-registry-auth
Copy link
Copy Markdown
Contributor

@gtrivedi88 gtrivedi88 Mar 27, 2026

Choose a reason for hiding this comment

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

The PR description says this fixed name is a workaround for a bug where the restore init container cannot access the pull secret. Is this the permanent intended behavior, or should the docs note this as a known limitation that may change?

Copy link
Copy Markdown
Contributor Author

@dkwon17 dkwon17 Mar 27, 2026

Choose a reason for hiding this comment

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

It's right now a known limitation, which we will likely change for the next release

path: quay.io/my-company-org
schedule: '0 */4 * * *'
imagePullPolicy: Always
----
<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].

The `authSecret` must point to a real {kubernetes} Secret of type `kubernetes.io/dockerconfigjson` containing credentials to access the registry.
The `authSecret` must be named `devworkspace-backup-registry-auth`. It must reference a {kubernetes} Secret of type `kubernetes.io/dockerconfigjson` that contains credentials to access the registry.
The secret should be created in the installation {namespace} for the {devworkspace} operator.

To create one, you can use the following command:

[source,shell,subs="+attributes,+quotes"]
----
kubectl create secret docker-registry my-secret --from-file=config.json
{orch-cli} create secret docker-registry devworkspace-backup-registry-auth --from-file=config.json
----

The secret must contain a label `controller.devfile.io/watch-secret=true` to be recognized by the {devworkspace} Operator.

[source,shell,subs="+attributes,+quotes"]
----
kubectl label secret my-secret controller.devfile.io/watch-secret=true
kubectl label secret devworkspace-backup-registry-auth controller.devfile.io/watch-secret=true
----

[WARNING]
====
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.
====
Loading