Upgrading

Before you upgrade IBM Financial Services Workbench, ensure that the following tasks are complete:

1. Review the upgrade notes

   Please note the version-specific upgrade instructions in the upgrade notes for your version. It contains important information about the version-specific changes and the necessary changes to be made when you upgrade to the new version. Also check the upgrade notes of all version numbers between the currently installed version and the version you are about to install.

2. Verify system requirements

   If you plan to upgrade IBM Cloud Pak for Data or a third-party component along with the upgrade, please check compatibility with the system requirements and inspect the installing 3rd-party components page before upgrading to the new version. It is recommended that you upgrade only on the basis of the changes required for the upgrade and re-run the installation process separately if other configuration changes require it.

3. Provide access to the configuration files of the last installation

   This guide assumes that you have read access to the folder containing the customized configuration files that were used for the currently installed version. Use the backup of the custom configuration files that was created according to the Backup the configuration files section just before the last installation was performed. For example in folder ~/install/sssob_2.2.2/ssob-install/deployments/configs.bak/.

4. Obtain account with sufficient permissions

   Setting up cluster-wide resources requires an account in the cluster administrator role, and upgrading to a new version by running the install.sh script requires the project administrator role for the project where you previously installed IBM Financial Services Workbench.

To obtain files required for upgrading IBM Financial Services Workbench:

• Go to Passport Advantage Online

• Search for Financial Services Workbench for Cloud Pak for Data

• Download the new version you want to upgrade to, e.g. ssob-3.0-ibm-openshift-4.6-cpd-installations.tgz

Unpack the installation file on the computer from which the installation commands are to be executed:

INSTALLDIR=~/install/
mkdir ${INSTALLDIR}
cd ${INSTALLDIR}
tar xzvf ssob-3.0-ibm-openshift-4.6-cpd-installations.tgz
mv ssob-3.0-ibm-openshift-4.6-cpd-installations ssob_3.0
cd ${INSTALLDIR}/ssob_3.0

Unless required otherwise in the upgrade notes, the upgrade uses the same configuration files that were active when the last version was installed. Take the configuration files from the backup configuration directory of the last installation, e.g. ~/install/sssob_2.2.2/ssob-install/deployments/configs.bak/ and copy those files to the config folder of the version you are about to install, e.g. ~/install/ssob_3.0/ssob-install/deployments/configs/.

For detailed instructions, refer to the installation process. The installation of the new version during the upgrade is essentially the same as the initial installation. To illustrate the upgrade, the following sections provide examples of the commands required for the installation.

1. Before you begin

   Make sure that docker is started and that you are logged into OpenShift as project / cluster admin.

   oc login
   systemctl start docker
   cd ~/install/ssob_3.0

2. Set up cluster-wide resources

   Run the script ssob_admin_setup.sh with cluster-admin permissions in the project where the last version was installed , i.e. zen.

   cd ssob-install/deployments
   chmod +x ssob_admin_setup.sh
   ./ssob_admin_setup.sh --accept_license --cpd_namespace=zen --external_address_image_registry=image-registry.apps.{your.domain.cloud}

3. Installation

   Run the script ssob_install.sh with project-admin permissions in the project where the last version was installed.

   $ cd ~/install/ssob_3.0/ssob-install/deployments
   $ chmod +x ssob_install.sh
   $ ./ssob_install.sh \
   --accept_license \
   --external_address_image_registry=image-registry.apps.{your.domain.cloud} \
   --internal_address_image_registry=image-registry.openshift-image-registry.svc:5000 \
   --cpd_namespace=zen \
   --host_domain=apps.{your.domain.cloud} \
   --helm-tls-ca-cert=~/install/ssob_3.0/zenhelm/ca.cert.pem \
   --helm-tls-cert=~/install/ssob_3.0/zenhelm/helm.cert.pem \
   --helm-tls-key=~/install/ssob_3.0/zenhelm/helm.key.pem

4. Configure the installation

   Solution Designer and Solution Hub will not work until the configuration via the K5 Configurator API has been done properly. If you are upgrading to version 2.5, you must configure this once.

   Attention: If you upgrade to 2.5, you must keep your previous configuration available (see pre-installation-checklist.html#concept_pre_installation__section_xfb_kqs_tnb ) and use the K5 Configurator API to create the same configuration settings as before the upgrade.

5. Validate the installation

   The installation will finish with the message The script finished successfully. Make sure that the expected versions of Solution Designer and Solution Hub are deployed. Additionally, check at least that the Solution Designer works as expected.

6. Troubleshooting

   In case the installation failed, please check the log file /tmp/wdp.install.log and refer to the Troubleshooting section.

Please refer to the upgrade notes for the corresponding version(s). They may contain additional necessary upgrade steps, especially migration instructions. And validate that the Solution Designer and Solution Envoy Web applications can be opened in the browser.