Important upgrade considerations for Planning Analytics Workspace Distributed

A mandatory backup and restore is required to successfully upgrade specific versions of Planning Analytics Workspace Distributed on select platforms. This backup and restore is necessary to avoid data loss during the upgrade process.

You must perform a backup and restore on the following platforms when upgrading from a version prior to 2.0.64 to version 2.0.64 or later.

  • OpenShift Container Package 3.x
  • OpenShift Container Package 4.x

For example, you must perform a backup and restore when upgrading from 2.0.62 to version 2.0.64. Similarly, you must perform a backup and restore when upgrading from 2.0.63 to version 2.0.65. However, you do not need to perform a backup and restore when upgrading from version 2.0.64 (or later) to a more recent version.

During the upgrade installation, you will see a notice alerting you to the requirement for a backup.

*UPDGRADE NOTICE* 
You are about to upgrade from a Planning Analytics Workspace release prior to 2.0.64 and will require a backup of your data to complete the upgrade process. If you have not taken a backup, please STOP here and do so. Do you want to continue with this upgrade (y/n)? (default n)

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.

After the upgrade installation is complete, you'll also see a notice alerting you to restore the backup you created.

*UPDGRADE NOTICE*
Please note that to complete this upgrade you will need to restore the Planning Analytics Workspace backup of the previous version.

While Planning Analytics Workspace Distributed is running, execute the tools/restore.sh script:

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