Back Up and Restore Paragon Automation
This topic describes the backup and restore functionality available in Paragon Automation.
Back Up Paragon Automation
You can back up your current Paragon Automation network configuration using Paragon Shell CLI. When you run the backup command, all the application configuration information stored in PostgreSQL and ArangoDB configuration database systems are backed up. The backup procedure can be performed while the microservices and applications are running and does not affect the operation of the network.
To back up your Paragon Automation configuration state.
The backup takes a few minutes to complete. Upon completion, a backup file with a filename in the yyyymmdd-hhmmss format is created. The backup file is stored in the local persistent /export/paragon-shell/backup folder on the node. You'll have to exit out of Paragon Shell to the Linux root shell navigate to the backup folder.
Caveat of the backup process
-
Metrics data such as the data stored in InfluxDB is not backed up.
-
Application configurations (such as devices, sites, service orders, and so on) are backed up, but certificates and infrastructure services configurations are not backed up. This information must be kept unchanged before you perform a restore.
Restore Paragon Automation
To restore your Paragon Automation configuration from a specific backup configuration file.
You must perform the restore operation only on the node on which the required backup file is located.
Caveats of the restore process
-
When you perform the restore operation, the network configuration is returned to the configuration present in the backup file. From the time the backup was taken, if the network configuration has changed due to new devices being onboarded or new service orders being executed, the network configuration in Paragon Automation might be different from the actual network state. To ensure that the network configuration in Paragon Automation and the actual network state have minimal mismatch post a restore operation, we recommend that you take regular periodic backups or specific backups after every network intent change.
-
You cannot restore data from a release different from the current installed release of Paragon Automation.
-
You can restore data on the same setup on which a backup was taken and not on a fresh installation using the procedure described in this section. To restore backed up data on a fresh installation, use the procedure described in Disaster Recovery.
-
Since a backup does not store the certificates and infrastructure services configurations, that information must be kept unchanged during restoration.
-
Resources allocated to the network won’t be preserved after a restore and you must ensure that you release the allocated resources during the window between taking a backup and performing a restore.
View Backup Files
To view a list of all backup files across all nodes, use the following command:
root@Primary1> show paragon
backup
The node connects to all the other nodes in the Paragon Automation cluster using SSH and displays a list of all backup file names along with the IP address of the node on which the file is located.
To view a list of backup files along with a list of failed backup attempts, use the following command:
root@Primary1> show
paragon backup include-failure true
Delete Backup Files
To delete a backup file, use the following command.
root@Primary1> request paragon backup delete backup-id
backup-id
You can delete a backup file that is located only on the node that you execute the command.