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:

 Command 
    
xxxxxxxxxx
 
${IW_HOME}/bin/stop.sh all mongo
Copy

Step 2: Switch to root user.

 Command 
    
xxxxxxxxxx
 
sudo su -
Copy

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

 Command 
    
xxxxxxxxxx
 
cp -r ${IW_HOME}/../infoworks ${IW_HOME}/../infoworks.bkp
Copy

Step 4: Switch back to IW_USER.

 Command 
    
xxxxxxxxxx
 
sudo su - ${IW_USER}
Copy

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

 Command 
    
xxxxxxxxxx
 
${IW_HOME}/bin/start.sh mongo all
Copy

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

 Command 
    
xxxxxxxxxx
 
mkdir -p $IW_HOME/mongo_bkpcd $IW_HOME/mongo_bkp
Copy

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

If MongoDB is hosted on Atlas

 Command 
    
xxxxxxxxxx
 
mongodump "mongodb+srv://<username>:<password>@<mongodb_server_hostname>/<db_name>"
Copy

If MongoDB is installed with Infoworks on the same VM

 Command 
    
xxxxxxxxxx
 
mongodump "mongodb://infoworks:IN11**rk@localhost:27017/infoworks-new"
Copy

Internet-based Upgrade

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

 Command 
    
xxxxxxxxxx
 
cd ${IW_HOME}/scriptswget https://iw-saas-setup.s3-us-west-2.amazonaws.com/5.4/update.sh --no-check-certificate
Copy

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

 Command 
    
xxxxxxxxxx
 
chmod +x update.sh
Copy

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

 Command 
    
xxxxxxxxxx
 
source ${IW_HOME}/bin/env.sh
Copy

Step 4: Export the following environment variables:

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

Field	Description	Details
METADB_MANAGED	This flag indicates whether the Mongo Installation is managed by Infoworks	Enter Y (default) for Infoworks Managed, or N for an external mongo. export METADB_MANAGED=
METADB_USE_SRV	This flag indicates whether the MONGO_HOST corresponds to a DNS SRV record	Enter N(default) for No (prefix “mongodb://”), or Y for Yes (prefix “mongodb+srv://”) export METADB_USE_SRV=

For Non-managed Mongo (only):

Field	Description	Details
METADB_FORCE_DROP	This flag indicates whether the Installer should overwrite any existing Databases.	Enter N (default) for No (the provided databases must be empty), or Y to allow the dropping of databases. export METADB_FORCE_DROP=N
MONGO_HOST	This flag indicates the Mongo host URL to connect to	Enter the Mongo Server or Seed DNS hostname (without prefix) export MONGO_HOST=
MONGO_USER	The Mongo user that is used to authenticate into Infoworks DBs	Enter a user that has at least read/write permissions over the databases mentioned. (defaults to Infoworks). export MONGO_USER=
MONGO_PASS	The Password of the aforementioned MONGO_USER	Enter the Password of the MONGO_USER (defaults to Infoworks Mongo Password) export MONGO_PASS=
MONGO_DB	The Database Name that will store Infoworks MetaData.	Enter a valid database name. export MONGO_DB=
MONGO_QUARTZDB	The Database Name that will store Quartzio MetaData.	Enter a valid database name. export MONGO_QUARTZDB=

Step 5: Execute the following script:

 Command 
    
xxxxxxxxxx
 
./update.sh -v {{version}}
Copy

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

For Ubuntu 20.04

 Command 
    
xxxxxxxxxx
 
./update.sh -v 5.4.1-ubuntu2004
Copy

For RHEL8

 Command 
    
xxxxxxxxxx
 
./update.sh -v 5.4.1-rhel8
Copy

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:

 Command 
    
xxxxxxxxxx
 
export os=ubuntu2004
Copy

For RHEL8 machine, perform the following command:

 Command 
    
xxxxxxxxxx
 
export os=rhel8
Copy

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

 Command 
    
xxxxxxxxxx
 
https://iw-saas-setup.s3.us-west-2.amazonaws.com/5.4/iwx_upgrader_internet_free_${os}_5.4.1.tar.gz
Copy

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

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

 Command 
    
xxxxxxxxxx
 
tar -xvf iwx_upgrader_internet_free_${os}_5.4.1.tar.gz
Copy

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.

 Command 
    
xxxxxxxxxx
 
mkdir -p ${IW_HOME}/temp/downloadsmkdir -p ${IW_HOME}/scripts/
Copy

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

 Command 
    
xxxxxxxxxx
 
cp infoworks-5.4.1-${os}.tar.gz ${IW_HOME}/temp/downloads
Copy

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

 Command 
    
xxxxxxxxxx
 
cp configure.sh internet-free-update.sh deploy_5.4.1.tar.gz ${IW_HOME}/scripts/
Copy

Step 7: Edit the configure.sh file:

 Command 
    
xxxxxxxxxx
 
cd ${IW_HOME}/scripts/vi configure.sh
Copy

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:

Field	Description	Details
METADB_MANAGED	This flag indicates whether the Mongo Installation is managed by Infoworks	Enter Y (default) for Infoworks Managed, or N for an external mongo. export METADB_MANAGED=
METADB_USE_SRV	This flag indicates whether the MONGO_HOST corresponds to a DNS SRV record	Enter N(default) for No (prefix “mongodb://”), or Y for Yes (prefix “mongodb+srv://”) export METADB_USE_SRV=

For Non-managed Mongo (only):

Field	Description	Details
METADB_FORCE_DROP	This flag indicates whether the Installer should overwrite any existing Databases.	Enter N (default) for No (the provided databases must be empty), or Y to allow the dropping of databases. export METADB_FORCE_DROP=N
MONGO_HOST	This flag indicates the Mongo host URL to connect to	Enter the Mongo Server or Seed DNS hostname (without prefix) export MONGO_HOST=
MONGO_USER	The Mongo user that is used to authenticate into Infoworks DBs	Enter a user that has at least read/write permissions over the databases mentioned. (defaults to Infoworks). export MONGO_USER=
MONGO_PASS	The Password of the aforementioned MONGO_USER	Enter the Password of the MONGO_USER (defaults to Infoworks Mongo Password) export MONGO_PASS=
MONGO_DB	The Database Name that will store Infoworks MetaData.	Enter a valid database name. export MONGO_DB=
MONGO_QUARTZDB	The Database Name that will store Quartzio MetaData.	Enter a valid database name. export MONGO_QUARTZDB=

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

 Command 
    
xxxxxxxxxx
 
chmod +x ${IW_HOME}/scripts/internet-free-update.sh
Copy

Step 9: Perform the following steps for upgrade:

 Command 
    
xxxxxxxxxx
 
source ${IW_HOME}/bin/env.shcd ${IW_HOME}/scripts/./internet-free-update.sh -v 5.4.1-${os}
Copy

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

 Command 
    
xxxxxxxxxx
 
rm -rf infoworks-5.4.1-${os}.tar.gz deploy_5.4.1.tar.gz internet-free-update.sh
Copy

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.

Last updated on Mar 24, 2023

Was this page helpful?