Chapter 18. Back up OpenShift Dev Spaces workspaces

Procedure

1. Configure the DevWorkspaceOperatorConfig resource to enable the backup job:

   apiVersion: controller.devfile.io/v1alpha1
   kind: DevWorkspaceOperatorConfig
   metadata:
     name: devworkspace-operator-config
     namespace: openshift-operators
   config:
     workspace:
       backupCronJob:
         enable: true
         registry:
           path: <integrated_registry_url>
         oras:
           extraArgs: '--insecure'
         schedule: '0 */4 * * *'
       imagePullPolicy: Always

   where:

   openshift-operators

   The default installation namespace for the Dev Workspace Operator on OpenShift. If the Dev Workspace Operator is installed in a different namespace, use that namespace instead.

   <integrated_registry_url>

   The URL to the OpenShift Container Platform integrated registry for your cluster.

   --insecure

   The --insecure flag may be required depending on the integrated registry’s routing configuration.

2. Get the default path to the integrated registry:

   echo "$(oc get route default-route -n openshift-image-registry --template='{{ .spec.host }}')"

Procedure

1. Configure the DevWorkspaceOperatorConfig resource to enable the backup job:

   kind: DevWorkspaceOperatorConfig
   apiVersion: controller.devfile.io/v1alpha1
   metadata:
     name: devworkspace-operator-config
     namespace: openshift-operators
   config:
     workspace:
       backupCronJob:
         enable: true
         registry:
           authSecret: devworkspace-backup-registry-auth
           path: <registry_url>
         schedule: '0 */4 * * *'
       imagePullPolicy: Always

   where:

   openshift-operators

   The default installation namespace for the Dev Workspace Operator on OpenShift. If the Dev Workspace Operator is installed in a different namespace, use that namespace instead.

   <registry_url>

   The OCI registry URL. For example: quay.io/my-company-org.

   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. Create the Secret in the installation project for the Dev Workspace Operator.

2. Create the registry credentials Secret:

   oc create secret docker-registry devworkspace-backup-registry-auth --from-file=config.json -n openshift-operators

3. Add the required label to the Secret for the Dev Workspace Operator to recognize it:

   oc label secret devworkspace-backup-registry-auth controller.devfile.io/watch-secret=true -n openshift-operators

   Warning

   The Dev Workspace Operator copies the devworkspace-backup-registry-auth Secret to each Dev Workspace project so that backups from user workspaces can be pushed to the registry. To use different credentials per project, create a devworkspace-backup-registry-auth Secret with user-specific credentials in each Dev Workspace project instead.