In a Helm Chart deployment, backup-utility runs inside the toolbox pod the Helm Chart deploys. See Overview for what the resulting archive contains and what is stored separately.

Creating a backup

d8 k -n code exec deploy/code-toolbox -- backup-utility

The command creates a backup archive and uploads it to the object storage bucket configured through global.appConfig.object_store (see Object storage).

Restoring from a backup

  1. Put the instance in maintenance mode.

  2. Confirm the object storage bucket configured through global.appConfig.object_store holds the archive you want to restore.

  3. Run the restore command inside the toolbox pod:

    d8 k -n code exec deploy/code-toolbox -- backup-utility restore --backup-id <BACKUP_ID>
  4. Wait for the command to finish and confirm every pod is Running:

    d8 k -n code get pods
  5. Take the instance out of maintenance mode and sign in to confirm the restore succeeded.