Backup/Restore Add-On

PostgreSQL Backup/Restore Add-On

The Database Backup/Restore Add-On works with PostgreSQL and dedicated Backup Storage to automatically create database dumps, store them remotely, keep a configurable number of recent backups, and restore a selected snapshot from the dashboard.

In this article
!

PostgreSQL redeployment

Before updating or redeploying a PostgreSQL instance, create a database backup first. PostgreSQL version upgrades may require dedicated data-upgrade procedures such as pg_dumpall or pg_upgrade.

Create Backup Storage

1

Open Backup Storage in Marketplace

If Backup Storage is not already available on the account, install the dedicated Backup Storage package from Marketplace.

Backup Storage in Marketplace
Install the Backup Storage package from Marketplace.
2

Configure the storage

Choose Standalone or Cluster storage. For Cluster storage, also define the number of nodes. Then configure:

  • Storage size
  • Environment — environment domain name
  • Display Name — environment alias
  • Region — when multiple regions are available
Backup Storage installation
Configure storage type, capacity, environment name, display name, and region.

Click Install. After creation, the storage environment is automatically added to the Backup storage nodes group.

Backup Storage environment
Backup Storage is grouped automatically after installation.
✓

Shared storage

A single Backup Storage environment can store backups for multiple databases.

Install the PostgreSQL Backup/Restore Add-On

Once Backup Storage is ready, hover over the PostgreSQL database environment, click the Add-Ons icon, find Database Backup/Restore Add-On, and click Install.

Database Backup Restore Add-On
Install the Database Backup/Restore Add-On for the PostgreSQL database.

Configure Backup Scheduling

Pre-definedSelect a standard interval: hourly, daily, weekly, or monthly.
CustomChoose the exact time, required days of the week, and time zone.
Manual (crontab)Provide a cron expression. The documented manual schedule uses UTC.
Backup storageSelect the Backup Storage environment that will hold the PostgreSQL backups.
Number of backupsDefine how many of the newest backups should be retained.
Database UserPostgreSQL account used by the add-on to access the database.
Database PasswordPassword for the selected PostgreSQL account.
Custom backup schedule
Configure a custom backup time, days, and time zone.
Crontab backup schedule
Use a UTC cron expression for manual scheduling.
Backup Restore Add-On installation
Select schedule, storage, retention count, and PostgreSQL credentials.

Click Install. After successful installation, the add-on begins creating PostgreSQL backups according to the selected schedule.

Backup Restore Add-On installed
The Backup/Restore Add-On is active after installation.

Manage the Add-On

Backup NowCreate a PostgreSQL backup immediately, outside the configured schedule.
ConfigureChange the schedule, Backup Storage target, number of retained backups, or database credentials.
RestoreRestore PostgreSQL from a previously created snapshot.
UninstallRemove the Backup/Restore Add-On.
Managing Backup Restore Add-On
Use Backup Now, Configure, Restore, or Uninstall after installation.

Each backup is stored on Backup Storage under a dedicated folder for the backed-up database. Individual snapshots use execution timestamps, which helps distinguish and organize multiple recovery points.

Restore PostgreSQL from a Backup

!

Current data will be overwritten

Restoring a snapshot replaces the current database data. Changes created after that snapshot will be permanently lost.

Open the installed add-on and click Restore. Then select:

  • Restore from — the environment whose backup should be used.
  • Backup — the required timestamped snapshot.
Restore PostgreSQL from backup
Choose the source environment and timestamped backup snapshot.

Click Restore and confirm the action. Once restoration starts, it cannot be canceled or reverted. Wait for the dashboard success notification.

During restoration, the relevant Backup Storage directory is mounted to the target database layer’s master node and the selected database dump is applied.

i

Master node behavior

Backup and restore operations are performed on the database layer’s master node. For a Primary-Secondary PostgreSQL topology, ensure that the cluster Primary is also the master node of the database layer before restoration.

Expected Result

PostgreSQL backups are created automatically according to the selected schedule, stored on dedicated remote Backup Storage, retained according to the configured backup count, and available for immediate or scheduled restoration through the dashboard.

Important Notes

  • Create a backup before redeploying or updating a PostgreSQL instance.
  • A dedicated Backup Storage environment is required before installing the add-on.
  • One Backup Storage environment can be used by multiple databases.
  • Manual crontab scheduling uses UTC.
  • Backup snapshots are organized by database and execution timestamp.
  • Restore operations run on the database layer’s master node.
  • Restoration overwrites existing data and cannot be canceled after it starts.