Back up and restore Planning Analytics Workspace Distributed

You must manage your Docker Swarm appropriately.

Review Administer and maintain a swarm of Docker Engines at https://docs.docker.com/engine/swarm/admin_guide/ for detailed information on managing your Swarm.

Back up

Backups are performed online and do not disrupt the availability of Planning Analytics Workspace Distributed.

To back up the Planning Analytics Workspace Distributed databases, run the tools/backup.sh script:

tools/backup.sh

If no parameters are supplied, the script creates a folder that is called backup in the current working directory and stores the backup data in a folder with a name generated based on the current date and time.

You can also supply a folder path for the backup. If the folder exists, it must be empty. If the path does not exist, the script creates it.

tools/backup.sh my/backup/folder

Schedule backups according to your business requirements. You might want to compress and encrypt the contents of the backup folder before you archive it.

Restore

You can rebuild and restore a failed Docker swarm or restore Planning Analytics Workspace Distributed.

Restore a failed Swarm

Follow the steps in Recover from disaster at https://docs.docker.com/engine/swarm/admin_guide/#recover-from-disaster to rebuild your Swarm.

When the swarm is recovered, install Planning Analytics Workspace Distributed. If the configuration settings from your backup are applicable to your recovered Planning Analytics Workspace Distributed instance, you can copy the relevant files such as paw.env to the config directory before you start Planning Analytics Workspace Distributed. Start Planning Analytics Workspace Distributed as usual and then restore your Planning Analytics Workspace Distributed databases.

Restore Planning Analytics Workspace Distributed databases

When Planning Analytics Workspace Distributed is running, to restore Planning Analytics Workspace Distributed databases, run the tools/restore.sh script:

tools/restore.sh path-to-backup-folder