Back Up & Restore an Embedded Config Database
Learn how to back up and restore the embedded NGINX Controller config database.
Follow the steps in this guide to back up and restore an internal NGINX Controller config database. Use this guide if you selected the option to use an embedded config database when you installed NGINX Controller. Embedded config means that NGINX Controller is using an internal database to store configuration data.
NGINX Controller automatically takes a snapshot of the embedded config database every 60 minutes and saves the backups on the config DB volume. The backup file location varies depending on the volume chosen at setup:
Local: The backup files are located in
/opt/nginx-controller/postgres_data/with the following naming scheme:
NFS: The backup files are located in the path on the NFS server host that was specified during installation and have the following naming scheme:
These automated config backups do not include backups of metrics data, which must be backed up separately; refer to Backup & Restore the Metrics Database for those instructions.
As a best practice, we recommend that you make scheduled backups of the entire config DB volume and keep the backups off-site for safekeeping.
This section explains how to restore the embedded config database from the latest backup file or a specific, timestamped file.
If you restore the config database on top of a new installation of NGINX Controller, make sure to follow the steps to restore your NGINX config and encryption keys afterward.
To restore the embedded NGINX Controller config database from the latest automated backup, run the following command:
/opt/nginx-controller/helper.sh backup restore
To restore the embedded config database from a specific backup file:
/opt/nginx-controller/helper.sh backup restore <filename>
If you installed the embedded config database on a local volume, the backup files are located in
If you installed the embedded config database on an NFS volume, follow the steps in (NFS) Copy Config Database Backup to Local Volume for Restoration to download the backup file to your local volume, and then use the
helper.shscript to restore from it.
To restore the embedded config database from a specific backup file, the file needs to be on your local volume.
Take the following steps to copy an embedded config database backup file from an NFS volume to your local volume for restoration:
Log on to the node where PostgreSQL is installed as a user with sudo privileges.
Change to the
Create a local backup directory to copy the backup file to:
Get the NFS volume details:
mount | grep nfs
The output looks similar to the following:
<nfs_host>:<path_on_host> on <local path> type nfs4 (mount options...)
192.0.2.1:/mnt/nfs_share/nfs_postgresql on /var/lib/kubelet/pods/1ce4e221-d6d6-434f-9e73-bc81c879530e/volumes/kubernetes.io~nfs/controller-postgres type nfs4 (mount options ...)
<nfs_host>:<path_on_host>details corresponding to the
nfs_postgresqlvolume, namely the volume mounted on the Kubernetes
Create a parent directory to mount the NFS path to:
sudo mkdir -p /mnt/local_pgdata
Mount the NFS path:
sudo mount <nfs_host>:<path_on_host> /mnt/local_pgdata
sudo mount 192.0.2.1:/mnt/nfs_share/nfs_postgresql /mnt/local_pgdata
View the list of the available backup files. The files have the following naming scheme:
Copy the backup file from which you want to restore to the
sudo cp /mnt/local_pgdata/backup_<timestamp>.tar local_backups/
Use the NGINX Controller
helper.shscript to restore the backup file:
/opt/nginx-controller/helper.sh backup restore local_backups/backup_<timestamp>.tar
After the backup has been restored, you can unmount the NFS path and delete the backup file in the
sudo umount /mnt/local_pgdata rm -i local_backups/backup_<timestamp>.tar
This documentation applies to the following versions of NGINX Controller: 3.12, 3.13, 3.14, 3.15, 3.16.1, 3.17, 3.18, 3.18.1, 3.18.2 and 3.18.3.
This documentation applies to the following versions of NGINX Controller API Management module: 3.18, 3.18.1, 3.19, 3.19.1, 3.19.2, 3.19.3 and 3.19.4.
This documentation applies to the following versions of NGINX Controller App Delivery module: 3.20, 3.20.1, 3.21, 3.22, 3.22.1, 3.22.2, 3.22.3, 3.22.4 and 3.22.5.