Upgrading Infoworks from 5.5.0 to 5.5.1 for VM

To upgrade to 5.5.1, you need a newly generated license that enables the supported environments on the installation. For more information, contact support@infoworks.io.

Important

For VMs which are on Infoworks 5.0.0 release, 5.0.0 to 5.5.1 will be a 2 step upgrade. 5.0.0 to 5.5.0 immediately followed by 5.5.0 to 5.5.1.

Documentation for 5.0.0 to 5.5.0 can be found here. Documentation for 5.5.0 to 5.5.1 is as below:

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 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.
Ensure that you have the new license key to use the version of Infoworks to be upgraded to. If you do not have it, you may contact support@infoworks.io to receive the same.
Make sure openssl11-libs is installed on the VM
- sudo yum install openssl11-libs
Before proceeding with upgrade, please ensure to take a back-up of ${IW_HOME}/conf/emr_defaults.json.
Ensure that GNU bc arbitrary precision calculator language (bc) is installed
- sudo yum install bc

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:

${IW_HOME}/bin/stop.sh all mongo

Step 2: Switch to root user.

sudo su -

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

cp -r ${IW_HOME}/../infoworks ${IW_HOME}/../infoworks.bkp

Step 4: Switch back to IW_USER.

sudo su - ${IW_USER}

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

${IW_HOME}/bin/start.sh mongo all

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

mkdir -p $IW_HOME/mongo_bkp cd $IW_HOME/mongo_bkp

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

If MongoDB is hosted on Atlas

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

If MongoDB is installed with Infoworks on the same VM

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

Internet-based 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 internet-based upgrade:

Step 1: Execute the following command:

cd ${IW_HOME}/scripts [[ -f update.sh ]] && rm -rf update.sh [[ -d iw-installer ]] && rm -rf iw-installer

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

wget https://iw-saas-setup.s3-us-west-2.amazonaws.com/5.5/update.sh --no-check-certificate

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

chmod +x update.sh

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

source ${IW_HOME}/bin/env.sh

Step 5: 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=

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 6: Execute the following script:

./update.sh -v {{version}}

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

For Amazon Linux 2, perform the following command:

./update.sh -v 5.5.1-amazonlinux2

Step 7: 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.0.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.5.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.

Post Upgrade Steps Please add this key value pair in table's advanced configuration section for sync to target tables with "Is Existing Table" checked to work where target type is postgres; Key: is_table_case_sensitive and Value: true.

Steps for Post Upgrade Migration:

Download the script from s3:

curl -o pipeline_sf_target_case_migration.py https://iw-saas-setup.s3.us-west-2.amazonaws.com/aflac/pipeline_sf_target_case_migration.py

Take backup of pipeline_versions collection:

mongodump --db infoworks-new --collection pipeline_versions --out /path/to/dump/directory --username your-username --password your-password

NOTE Make sure that the dump directory exists and username/password are updated in the above command

Run the command with help option to check the usage:

python pipeline_sf_target_case_migration.py -h

Run the command with dryrun option:

python pipeline_sf_target_case_migration.py "mongodb://user:password@localhost:27017/infoworks-new" --dryrun

Confirm the documents that will be updated from log file: iwx_script_output_<timestamp>.log
Run the command for migration:

python pipeline_sf_target_case_migration.py "mongodb://user:password@localhost:27017/infoworks-new"

Last updated by Monika Momaya on Jun 3, 2024

Was this page helpful?