Workspace backup for Eclipse Che

The DevWorkspace backup job provides periodic backups of DevWorkspace data to a specified location. After you enable and configure the job, it runs at defined intervals to create backups of DevWorkspace data. The backup controller requires an OCI-compliant registry, such as the e.g.,https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/registry/registry-overview#registry-integrated-openshift-registry_registry-overview[OpenShift build-in registry] integrated registry or Quay.io, to store backup archives as image artifacts.

The backup makes a snapshot of stopped Workspace PVCs and stores them as tar.gz archives in the specified OCI registry.

By default, the DevWorkspace backup job is disabled.

You can configure the backup by using the DevWorkspaceOperatorConfig resource with the following fields:

  • enable: Set to true to enable the backup job or false to disable it. The default value is false.

  • schedule: A Cron expression that defines the backup frequency. The default value is "0 1 * * *".

  • registry.path: The base registry location for backup archives.

    The value for registry.path is the first segment of the final location. The full path is assembled dynamically by using the workspace name and the :latest tag in the following pattern:

    <registry.path>/<namespace>/<devworkspace-name>:latest

  • registry.authSecret: (Optional) The name of the Kubernetes secret that contains credentials for the OCI registry. If you do not provide a secret, the system assumes the registry is public or uses the Red Hat OpenShift integrated registry.

  • oras.extraArgs: (Optional) Additional arguments for to the oras CLI tool during push and pull operations.

There are several configuration options to customize the logic: