Upgrading from 5.3.0.x to 5.4.1

NOTE

Assuming IW_HOME=/opt/infoworks, use the command: export IW_HOME=/opt/infoworks.

Assuming IW_USER=infoworks, use the command: export IW_USER=infoworks.

Prerequisites

• Ensure that you have upgraded the OS on the system to Ubuntu 20.04 if you are on an Ubuntu-based system.

• Ensure that GNU bc arbitrary precision calculator language (bc) is installed.

• Ensure that the Default Java version is pointing to Java 8.

• Ensure that all files in ${IW_HOME} are owned by the Infoworks user.

• Ensure that all the services are up and running in ${IW_HOME}/bin/status.sh.

Upgrade Procedure

Back Up Infoworks

You must take a backup of ${IW_HOME} before starting the upgrade process.

To back up Infoworks services, perform the following steps:

Step 1: Stop Infoworks service by executing the following command via IW_USER:

Step 2: Switch to root user.

Step 3: Take a backup of the Infoworks by executing the following command:

Step 4: Switch back to IW_USER.

Step 5: Start Infoworks service by executing the following command:

Before you upgrade, it is recommended to take a backup of Mongo Atlas Infoworks DBs if any.

Step 1: Install/Download MongoDB tool, if needed.

Step 2: Create a directory to store the database backup dump using the below command

Step 3: Use the below command to take a dump (backup) of the databases from the MongoDB server.

If MongoDB is hosted on Atlas

If MongoDB is installed with Infoworks on the same VM

Internet-based Upgrade

Step 1: Download the upgrade script using the following commands:

Step 2: Provide execute permission to the script using the following command.

Step 3: Execute the following script to source the env.sh file. This sources the Infoworks environment variables, such as path variables.

Step 4: Export the following environment variables:

NOTE This step is not needed for Atlas to Atlas upgrades.

For Non-managed Mongo (only):

Step 5: Execute the following script:

For example, to upgrade to version 5.4.1, use the following script:

For Ubuntu 20.04

For RHEL8

Step 6: Upgrade the license after logging into the UI.

Internet-free Upgrade

NOTE Replace ${IW_HOME} with the location where your Infoworks instance is installed. For example, /opt/infoworks.

Before you upgrade, it is recommended to take a backup of Mongo Atlas Infoworks DBs if any.

Perform the following steps for the internet-free upgrade:

For Ubuntu 20.04 machine, perform the following command:

For RHEL8 machine, perform the following command:

Step 1: Get the Upgrader Tarball using the following link:

Step 2: SCP this tarball into /home/infoworks path of the Edge Node.

Step 3: Untar the Upgrader Tarball using the following command:

The following upgrade scripts are available:

• Update Script (internet-free-update.sh)

• Deployer Tar (deploy_5.4.1.tar.gz)

• Infoworks Package Tar (infoworks-5.4.1-${os}.tar.gz)

• Configure Script (configure.sh)

Step 4: Create the downloads and scripts directory for Infoworks Package Tar.

Step 5: Copy the Infoworks Package Tar to target downloads location:

Step 6: Copy the Configure Script, Update Script and Deployer Tar to the target scripts directory:

Step 7: Edit the configure.sh file:

NOTE This step is not needed for Atlas to Atlas upgrades.

Configure the parameters as described in the table given below, and then save the file:

For Non-managed Mongo (only):

Step 8: Provide the executable permissions to the Upgrade script.

Step 9: Perform the following steps for upgrade:

Step 10: Perform a cleanup of the /home/infoworks directory, using the following command:

Step 11: Upgrade the license after logging into the UI.

NOTES

• As a part of the upgrade/install for a non-managed mongo setup, the following MongoDB artifacts are deleted from the local machine:

  • Binaries

  • Data

  • Configurations

• As a part of the upgrade, MongoDB dumps are taken on the local machine at iw_home/temp/backup-5.4.0/mongo_. After upgradation, it is recommended to test the migration to MongoDB Atlas thoroughly by running Infoworks Ingestion and Pipeline Jobs. These dumps can be deleted after the tests are complete._ __

• As a part of the upgrade, Postgres backup is taken on the local machine at iw_home/resources/postgres/pgsql.old_. After upgrading, it is recommended to test the migration to Postgres thoroughly by running Infoworks Workflow Jobs. These dumps can be deleted after the tests are complete._

Important Note for Teradata Users

You must perform the following steps after upgrading to 5.4.1:

Step 1: Ensure that you download the Teradata JDBC driver from the Teradata portal.

Step 2: Extract the compressed file (.zip or .tar), and copy the drivers namely, tdgssconfig.jar, terajdbc4.jar from the extracted file.

Step 3: Create lib/dist-jobs directory under the $IW_HOME/lib/ingestion/connectors/teradata folder, so that the directory structure becomes $IW_HOME/lib/ingestion/connectors/teradata/lib/dist-jobs, and place the downloaded drivers inside it.