v5.5.0.4

Date of Release: December 2023

Enhancement

Resolved Issues

NOTE The "*" symbol next to ID refers to the issues that have been resolved in the current release.

Prerequisites

NOTE Before going through the below mentioned prerequisites for this section, ensure that all the Prerequisites for Installing Infoworks on AKS are validated.

• Ensure the current deployment’s chart is present in /opt/infoworks.
• Python 3.8 or later version with the pip module is installed in the Bastion VM.
• Stable internet connectivity on the Bastion VM to download the required python packages from the python repository during installation/upgrades.
• Validate that the version of the old chart is 5.5.0.3.

xxxxxxxxxx

cat /opt/infoworks/iw-k8s-installer/infoworks/Chart.yaml | grep appVersion

xxxxxxxxxx

appVersion: 5.5.0.3

Upgrade Instructions

NOTE Due to limitations in DataBricks interactive cluster session management, to ensure successful upgrade and usage of upgraded Infoworks libraries:

1. Jobs using old versions of libraries must be completed/stopped.
2. Old versions of libraries must be uninstalled and databricks cluster should be restarted to clear the cache.

For the procedure of libraries uninstalling, refer Step 4 below.

To upgrade Infoworks on Kubernetes:

xxxxxxxxxx

export IW_HOME="/opt/infoworks"

Before selecting the type of upgrade execute the following commands.

Step 1: Create the required directories and change the path to that directory.

xxxxxxxxxx

mkdir -p $IW_HOME/downloads

cd $IW_HOME/downloads

NOTE If your Infoworks installation is configured not to use the Infoworks hosted registry (IW_HOSTED_REGISTRY=false), you should download the Docker image ‘infoworks-mongo-utils_v5.5.0.tar.gz’ following the instructions that have been shared with you. After downloading, push this image to your configured registry, ensuring that you do not change the image tags.

Internet-free Upgrade

NOTE If you are upgrading via Internet-based procedure, skip to the next section.

Step 1: Download the upgrade tar files shared by the Infoworks team to the Bastion (Jump host) VM and place it under $IW_HOME/downloads.

Step 2: To configure Internet-free upgrade, execute the following command:

xxxxxxxxxx

export INTERNET_FREE=true

Internet-based Upgrade

Step 1: Download the Update script tar file.

xxxxxxxxxx

wget https://iw-saas-setup.s3-us-west-2.amazonaws.com/5.5/iwx_updater_k8s_5.5.0.4.tar.gz

Common Steps for Both Internet-free and Internet-based

NOTE Once you have selected the type of upgrade, the below mentioned steps are common for both Internet-free and Internet-based.

Step 1: Extract the iwx_updater_k8s_5.5.0.4.tar.gz under $IW_HOME/downloads.

xxxxxxxxxx

tar xzvf iwx_updater_k8s_5.5.0.4.tar.gz

This should create two new files as follows - update-k8s.sh and configure.sh.

Step 2: Run the script.

xxxxxxxxxx

./update-k8s.sh -v 5.5.0.4

NOTE At the end of the above command's execution, if you want to run helm upgrade manually, then type N and press Enter. There is a 30-second timeout set to abandon the deployment of the upgraded version. If no input is received within the timeout duration, the deployment is triggered.

helm upgrade 531 /opt/infoworks/iw-k8s-installer/infoworks -n aks-upgrade-540 -f /opt/infoworks/iw-k8s-installer/infoworks/values.yaml 

​

Enter N to skip running the above command to upgrade the helm deployment. (timeout: 30 seconds): N

Upgrade success

Step 3: To modify any of the configurations listed below, follow the steps:

1. Email configurations: smtpHost, smtpPort, smtpUsername, smtpPassword, sslEnabled
2. Timeout for DT
3. Timeout for ingestion
4. nginx.ingress.kubernetes.io/proxy-body-size

Step 3A: Navigate to the directory IW_HOME/iw-k8s-installer. And Edit the values.yaml file

NOTE

• Email configurations can be found under customiwConfigs section in values.yaml
• Timeouts for DT and ingestion can be found under databricks section in values.yaml
• kubernetes.io/proxy-body-size can be found in nginx.ingress section in values.yaml

Step 3B: After editing the annotations, the values.yaml file should look as shown below:

Update the values and save the file.

Step 3C: Navigate to the directory IW_HOME/iw-k8s-installer. And Run the iw_deploy script

xxxxxxxxxx

./iw_deploy.sh

NOTE During the above command's execution, when it prompts if we need to override, type y and press Enter.

Step 3D: Restart all the deployments

xxxxxxxxxx

kubectl rollout restart deployment -n <namespace>

Step 4: (Applicable only for Databricks Persistent Clusters): A change in the Infoworks jar requires libraries being uninstalled and cluster restart. Without this step, there will be stale jars. Perform the following steps:

(i) Go to the Databricks workspace, navigate to the Compute page, and select the cluster that has stale jars.

(ii) In the Libraries tab, select all the Infoworks jars and click Uninstall.

(iii) From Infoworks UI or Databricks dashboard, select Restart Cluster.

Rollback

Prerequisites

• Before executing the rollback script, ensure that IW_HOME variable is set.
• Assuming Infoworks home directory is /opt/infoworks, run the below command to set the IW_HOME variable.
• Validate that the version of the old chart is 5.5.0.4.

xxxxxxxxxx

export IW_HOME=/opt/infoworks

• Ensure the current deployment’s chart is present in /opt/infoworks.
• Execute the below command to check the appVersion.

xxxxxxxxxx

cat $IW_HOME/iw-k8s-installer/infoworks/Chart.yaml | grep appVersion

xxxxxxxxxx

appVersion: 5.5.0.4

Rollback Instructions

NOTE Since IW_HOME has been exported in the Prerequisites section mentioned above, the following steps can be executed from any location for users with read/write access to the aforementioned IW_HOME.

Step 1: Download the rollback script.

xxxxxxxxxx

Step 2: Place the Update script in the same directory as that of the existing iw-k8s-installer.

Step 3: Ensure you have permission to the $IW_HOME directory.

Step 4: Give executable permission to the rollback script using the below command.

xxxxxxxxxx

Step 5: Run the script.

xxxxxxxxxx

Step 6: You will receive the following prompt, "Enter N to skip running the above command to upgrade the helm deployment. (timeout: 30 seconds): ", type Y and press Enter.

NOTE If you want to run helm upgrade manually, then type N and press Enter.

xxxxxxxxxx

NOTE There is a 30-second timeout set to abandon the deployment of the downgraded version. If no input is received within the timeout duration, the deployment is triggered.