Automated backup configuration

Automated backup configuration

If backup server is in your environment inventory file then add following section to environments/<environment>/dependencies/values.override.yaml and run "Deploy dependencies" workflow:

• Update backup_server_dir value to match with your environment name, e/g development

• Update schedule to reflect best time backup job to be started,

• Update host to the backup server IP address or hostname

• Set enabled to true

# Backup configuration
backup:
  enabled: true
  schedule: "0 1 * * *"
  backup_server_secret: backup-server-ssh-credentials
  backup_server_dir: /home/backup/<environment>
  host: <backup server IP address or hostname>

The backup server hostname is configured with backup.host and is no longer read from the backup-server-ssh-credentials secret. When the environment is managed by the yarn environment:init script, the value is populated from the BACKUP_HOST GitHub environment variable. A different host can be set per datastore with postgres.backup.host or minio.backup.host.

Push your changes to GitHub and Re-Deploy Dependencies

If backup server was provisioned as part of any other environments or is a third-party server, then please follow guide from helm chart, see Backup configuration.

Verify backup configuration

Verify kubernetes jobs are present:

1. Connect to your cluster with kubectl

2. Run following command:

   kubectl get cronjob -l job-type=backup -n opencrvs-deps-<environment>

   Example output:

   NAME              SCHEDULE    TIMEZONE   SUSPEND   ACTIVE   LAST SCHEDULE   AGE
   minio-backup      0 1 * * *   <none>     False     0        5h9m            13h
   postgres-backup   0 1 * * *   <none>     False     0        5h9m            20h

Verify Kubernetes jobs were executed per schedule:

Wait at least for first job execution, usually takes at to 24 hours

1. Connect to your cluster with kubectl

2. Run following command:

   kubectl get job -l job-type=backup -n opencrvs-deps-<environment>

   Example output:

   NAME                       STATUS     COMPLETIONS   DURATION   AGE
   minio-backup-29381820      Complete   1/1           9s         5h11m
   postgres-backup-29381820   Complete   1/1           13s        5h11m

Verify backup files are present on backup server

1. SSH (Login) to backup server

2. Become backup user:

   sudo -i
   su - backup

3. Check backup directory content:

   ls -l /home/backup/<environment>
   ls -l /home/backup/<environment>/<date>

   Example output:

   backup@backup-01:~$ ls -l /home/backup/production/2025-11-12
   total 25972
   -rw-r--r-- 1 backup backup 26506864 Nov 12 01:00 minio_backup_2025-11-12.tar.gz.enc
   -rw-r--r-- 1 backup backup      448 Nov 12 01:00 postgres_backup_2025-11-12.tar.gz.enc