Backup/Restore Add-On

Database Backup/Restore Add-On

The Database Backup/Restore Add-On automatically creates database backups and stores them on dedicated remote Backup Storage. It supports MySQL/MariaDB/Percona, PostgreSQL, and Redis.

PostgreSQL: create a database backup before redeploying or updating a PostgreSQL instance.
MariaDB Galera: the add-on includes the additional actions required for Galera. Manual dump restoration needs separate Galera-specific consideration.

Create Backup Storage

Before installing the add-on, create a dedicated Backup Storage instance unless one is already available. Open the Backup Storage package from Marketplace.

Backup Storage in Marketplace
Create dedicated Backup Storage from Marketplace.

Choose Standalone or Cluster storage. For Cluster storage, also select the number of nodes. Then specify storage size, Environment, Display Name, and Region where applicable.

Backup Storage installation
Configure the Backup Storage environment.

After installation, the storage environment is automatically added to the Backup storage nodes group. One storage instance can be used by multiple databases.

Backup Storage environment
Backup Storage is grouped automatically after installation.

Install the Backup/Restore Add-On

Hover over the required database, open Add-Ons, locate Database Backup/Restore Add-On, and click Install.

Database Backup Restore Add-On
Install the Backup/Restore add-on from the database Add-Ons list.
Pre-definedHourly, daily, weekly, or monthly backup schedule.
CustomSelect exact Time, Days of the week, and Time Zone.
Manual (crontab)Provide a cron expression; the documented manual schedule uses UTC.
Backup storageSelect an installed Backup Storage environment.
Number of backupsSet how many newest backups should be retained.
Database credentialsProvide Database User and Database Password.
Custom backup schedule
Custom backup scheduling.
Crontab backup schedule
Manual cron-based scheduling uses UTC.
Backup Restore Add-On installation
Configure schedule, storage, retention, and database credentials.

After installation succeeds, the add-on begins creating backups according to the selected schedule.

Backup Restore Add-On installed
The add-on is active after successful installation.

Managing the Add-On

Backup NowCreate an immediate backup.
ConfigureChange schedule, storage, retention count, or credentials.
RestoreRestore from a stored backup.
UninstallRemove the add-on.
Managing Backup Restore Add-On
Manage immediate backups, configuration, restoration, or uninstallation.

Each database snapshot is stored on Backup Storage in a dedicated folder named for the backed-up database, with a unique execution timestamp. During restoration, the related storage directory is mounted to the database layer’s master node and the selected SQL dump is applied.

Master node only: all backup/restore operations run on the database layer’s master node. For a non-clustered database layer with multiple nodes, restoration affects one node only. For Primary-Secondary topology, ensure that the Primary is also the layer master.

Restore a Database

Warning: restoring a backup overwrites existing data. Changes made after the selected backup was created will be permanently lost.

Select Restore, then choose Restore from for the target environment and select the required timestamped Backup.

Restore database from backup
Choose the environment and backup snapshot to restore.

Click Restore and confirm the operation. After it starts, the action cannot be canceled or reverted. The dashboard displays a success notification when restoration is complete.

Expected Result

The database is backed up automatically to remote Backup Storage according to the selected schedule and retention count. Backups can also be created on demand and restored from timestamped snapshots when required.

Important Notes

  • Supported databases: MySQL/MariaDB/Percona, PostgreSQL, and Redis.
  • Backup Storage must exist before installing the backup add-on.
  • One Backup Storage instance can serve multiple databases.
  • Manual crontab scheduling uses UTC.
  • Restore operations run on the database layer master node.
  • Restoration overwrites current data and cannot be canceled once started.