Running an on-demand database backup

Run a backup of the analytics database outside the scheduled time.

About this task

You can take an analytics backup at any time, you do not need to wait for the scheduled database backups to run. However, avoid running multiple backups at the same time.

When you trigger an on-demand backup, a local backup is taken and then copied to your remote backup location (SFTP of object-store). If a remote backup location is not configured, then the backup is stored locally.

Local backups are taken automatically every 55 minutes past each hour. If you trigger an on-demand backup while a scheduled local backup is running, then the on-demand backup waits until the scheduled backup is complete, and then creates a new local backup.

Procedure

  1. Confirm that your analytics subsystem is working correctly:
    apicup subsys health-check <analytics subsystem>
    if successful, the command returns silently with exit code 0.
  2. Start the backup by running the following command:
    apicup subsys backup <analytics subsystem>
  3. Monitor the progress of your backup with:
    apicup subsys list-backups <analytics subsystem>
    NAME                     STATUS   ID                                         CR TYPE   CLUSTER       AGE   COMMENT
    analytics-backup-d8hsp   Ready    analytics-all-2024-06-14t21:12:25.136z     create    analytics     45m   backup for analytics service 1
    analytics-record-b5w74   Ready    analytics-all-2024-06-14t21:12:25.136z     record    analytics     43m   
    When the backup is complete the status changes from Running to Ready.