Configuring Backup and Restore for Anypoint Platform PCE
Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) stores backup archives on the platform shared filesystem. Depending on the storage mode you selected at installation, this is either an NFS server (NFS mode) or a dynamically provisioned volume from your RWX-capable StorageClass (StorageClass mode, Anypoint Platform PCE 4.3.0 and later). Make sure that the storage backing your shared filesystem is highly available and that frequent backups are configured and performed.
In StorageClass mode, use a StorageClass with reclaimPolicy: Retain for the backup-restore volume so that deleting the PersistentVolumeClaim does not destroy historical data.
|
To preserve your data:
-
Enable automatic backups to protect against system failures or operational issues.
-
Schedule backups at least daily, or more frequently based on your needs.
-
Store backups externally, outside the Anypoint Platform cluster.
The backup and restore process is controlled via Anypoint Platform PCE APIs.
Create a Backup
To create a backup, run the following command:
curl -k <platform-dns>/platform/backup-X POST -H 'Authorization: Bearer ${token}' -H 'Content-Type: application/json' -d '{"backup-file-name": "${backupFileName}.tar.gz"}'
Backup Content
| Information | Included in Anypoint Platform PCE Backup |
|---|---|
Databases |
Yes |
Configurations |
Yes |
Secrets |
Yes |
Object Store |
Yes |
Disclaimer settings |
Yes |
SMTP settings |
Yes |
DNS settings |
No |
Platform certificate |
No |
Shared filesystem settings (NFS or StorageClass) |
No |
Shared filesystem contents |
No |
Drives |
No |
Runtimes* |
No |
Anypoint Monitoring metrics |
No |
*Anypoint Platform PCE has information only about runtimes, such as their names and status.
Perform a System Restore
Consider the following before you perform a system restore:
-
Before running a restore, configure certain settings, such as the shared filesystem (NFS or StorageClass), certificates, and DNS because they are not included in the backup.
-
Backups cannot be transferred between different versions of Anypoint Platform PCE; therefore, your new installation must match the version of your backup.
-
The new installation must use the same storage mode (NFS or StorageClass) as the source installation. The installer rejects changes to the storage mode on an existing cluster.
To perform the restore, run the following command:
curl -k <platform-dns>/platform/restore-X POST -H 'Authorization: Bearer ${token}' -H 'Content-Type: application/json' -d '{"backup-file-name": "${backupFileName}.tar.gz"}
The backup file is stored on the platform shared filesystem.
Create an InfluxDB Backup
To create an InfluxDB backup, run the this command:
curl -k <platform-dns>/platform/amv/backup-X POST -H 'Authorization: Bearer ${token}' -H 'Content-Type: application/json' -d '{"backup-file-name": "${backupFileName}.tar.gz"}'
Perform an InfluxDB Restore
To perform an InfluxDB restore, run this command:
curl -k <platform-dns>/platform/amv/restore-X POST -H 'Authorization: Bearer ${token}' -H 'Content-Type: application/json' -d '{"backup-file-name": "${backupFileName}.tar.gz"}'
The backup file is stored on the platform shared filesystem.