Skip to content

Commit fb82363

Browse files
dkwon17gtrivedi88
andauthored
Update backup registry secret name (#3054)
* Update backup registry secret name Signed-off-by: dkwon17 <dakwon@redhat.com> * Update modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Add warning about auth secret copy functionality Signed-off-by: David Kwon <dakwon@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com> Signed-off-by: David Kwon <dakwon@redhat.com> Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
1 parent d809eea commit fb82363

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,31 @@ config:
2626
backupCronJob:
2727
enable: true
2828
registry:
29-
authSecret: my-secret
29+
authSecret: devworkspace-backup-registry-auth
3030
path: quay.io/my-company-org
3131
schedule: '0 */4 * * *'
3232
imagePullPolicy: Always
3333
----
3434
<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].
3535

36-
The `authSecret` must point to a real {kubernetes} Secret of type `kubernetes.io/dockerconfigjson` containing credentials to access the registry.
36+
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.
3737
The secret should be created in the installation {namespace} for the {devworkspace} operator.
3838

3939
To create one, you can use the following command:
4040

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

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

4848
[source,shell,subs="+attributes,+quotes"]
4949
----
50-
kubectl label secret my-secret controller.devfile.io/watch-secret=true
50+
kubectl label secret devworkspace-backup-registry-auth controller.devfile.io/watch-secret=true
5151
----
52+
53+
[WARNING]
54+
====
55+
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.
56+
====

0 commit comments

Comments
 (0)