Upgrading: Requirements

The following are the requirements for upgrading Orchestrator.

• User access: all commands must be performed as root or an equivalent superuser.
• Both the Aspera Common Package and Aspera Orchestrator are already installed on the Linux server.
• A backup of MySQL data has been performed by MySQL dump.

  $ /opt/aspera/common/mysql/bin/mysqldump -h localhost –u root –p orchestrator > /tmp/orchestrator_db_backup_timestamp.sql

  Note: The generated .sql file may take several gigabytes of disk space depending on the database size, so make sure that enough space is available on the targeted partition (/tmp in the example above) before running the backup
• A backup of Aspera Orchestrator data performed with the Snapshot feature. Refer to the Orchestrator User Guide on how to take a snapshot.
  Note: Move all backup files onto a safe server after running the backup so that they don’t take up space on Orchestrator.
• Orchestrator services must be stopped.
• Archive /opt/aspera/var:

  $ cd /opt/aspera/ ; tar chvfz /tmp/aspera_orig_timestamp.tar.gz var/

  The directory /opt/aspera/orchestrator/ is overwritten with the newly released files, while files under /opt/aspera/var/config/orchestrator/ are left unchanged during the upgrade. During the installation, custom images, branding files and style sheets are copied from /opt/aspera/var/config/orchestrator/ to /opt/aspera/orchestrator/public/. Thus make sure that any custom files (as well as orchestrator.yml, if the default Orchestrator configuration has been changed) are placed under /opt/aspera/var/config/orchestrator/ before doing the upgrade.

• If the database configuration is not standard (if, for example, there is a nonstandard password), back up the following file:

  /opt/aspera/orchestrator/config/database.yml

  It will be overwritten by the default released file, and you will lose the data unless it is backed up elsewhere.