Instructions for installing IBM InfoSphere Information Server 11.7.1.3 Service Pack 4

Fix Readme

Abstract

This document contains guidance for installation of the IBM InfoSphere Information Server 11.7.1.3 Service Pack 4 upgrade package available on IBM Fix Central.

Content

Table of Contents
    1) Introduction
    2) Using a password or passwordless SSH for installation
    3) Downloads and pre-Upgrade steps
    4) Installation of 11.7.1.3 Service Pack 4
         4.1. Instructions for upgrading Information Server in GUI mode of the Update Installer
         4.2. Instructions for upgrading Information Server in Console mode of the Update Installer
    5) Post upgrade actions

1) Introduction

The IBM InfoSphere Information Server 11.7.1.3 Service Pack 4 ispkg image is available for upgrading of Information Server version 11.7.1.3 installations. The steps for installing Information Server 11.7.1.3 Service Pack 4 depend on whether the Microservices tier is installed.

Requirements for installing 11.7.1.3 Service Pack 4:

You must install Information Server version 11.7.1.3.
If you have a Microservices tier, it must be at version 11.7.1.3, and all pods must be up and running.

Important:
    Depending on your installation environment and whether you installed the original or latest version of 11.7.1.3, more steps might be required before you install 11.7.1.3 Service Pack 4.
    Check whether your installation environment matches the Environment section in technote.
    If it does, you can determine whether you need to do these steps in one of two ways:

Examine the name of the file that you downloaded for installation of 11.7.1.3:
- Original version: fixpack_FP3_IS1171_linux64_11710-11712.tar.gz
- Latest version: fixpack_FP3_Respin1_IS1171_linux64_11710-11712.tar.gz
Examine the description in the 11.7.1.3 PatchManifest.xml file installed on your system (about line 6 in the file):
- Original version: <Description description="Information Server 11.7.1 FixPack 3 (fixpack.is_11_7_1_3.linux64.b134.211020-2005)"/>
- Latest version: <Description description="Information Server 11.7.1 FixPack 3 (fixpack.is_11_7_1_3.linux64.b135.211201-0526)"/>

If you installed the latest version of 11.7.1.3, you can proceed with the installation of 11.7.1.3 Service Pack 4.

If you installed the original version of 11.7.1.3, you must follow the instructions in this technote. If you applied these instructions previously, you do not have to repeat the steps.

2) Using a password or passwordless SSH for installation

2.1) If you initially installed Enterprise Search in Information Server, 11.7.0.0 through 11.7.0.2, such installations required

a. a user with root privileges on the master node

b. setting up passwordless SSH from the user running the installation on the Information Server host to the master node

c. setting up passwordless SSH for the root user between the master node and itself

During the installation of Information Server 11.7.1.3 Service Pack 4, you can continue to use your current setup; no changes are needed to facilitate the installation.

However, you might want to take advantage of newly added features in the installer:

a. You are no longer required to set up passwordless SSH for the root user between the master node and itself.

b. In some installation modes, you do not have to set up any passwordless ssh.
See the next section for details.

2.2) Installation modes available while upgrading the Microservices tier

You have four installation modes to choose from, during upgrade of the Microservices tier:

     a. Specify that the root user must be used on the master node, and provide the password and sftp port.
         In this case, you do not have to set up passwordless SSH from the Information Server host to the master node.
         However, for a multiple nodes environment, you must set up passwordless SSH for the root user from the master node to the worker nodes.

    b. Specify a nonroot user to be used on the master node, and provide the password and sftp port.
         The specified nonroot user must have sudo privilege with NOPASSWD enabled.
         In this case, you do not have to set up passwordless SSH from the user running the installation on the Information Server host to the master node.
         For a multiple nodes environment:

i. The specified nonroot user must be set up in the same manner on all nodes.
ii. You must set up passwordless SSH for the specified nonroot user from the master node to the worker nodes.

c. Specify that the root user must be used on the master node, and don't provide a password.
You must set up passwordless SSH from the user running the installation on the Information Server host to the master node.
For a multiple nodes environment, passwordless SSH must also be set up for the root user from the master node to the worker nodes.

    d. Specify that a nonroot user must be used on the master node, and don't provide a password.
         The specified nonroot user must have sudo privilege with NOPASSWD enabled.
         You must set up passwordless SSH from the user running the installation on the Information Server host to the master node.
         For a multiple nodes environment:
                i. The specified nonroot user must be set up in the same manner on all nodes.
                ii. Passwordless SSH must also be set up for the specified nonroot user from the master node to the worker nodes.

Note:

1. To enable NOPASSWD for the nonroot user, use visudo to append " ALL=NOPASSWD: ALL" to the user's entry in the /etc/sudoers file, or add an entry.

The resulting line is

ALL=(ALL) NOPASSWD: ALL

2. If the root user was used during the installation of 11.7.0.x, then the root user must also be used when 11.7.1.3 Service Pack 4 is installed.

        3. Sample setup of passwordless SSH connection for a root user to the Microservices Tier node.
             a. If the file /root/.ssh/id_rsa.pub does not exist, create the SSH Keys with the following command:
                     > ssh-keygen -f /root/.ssh/id_rsa -q -N ""
             b. Copy the SSH public key to the Microservices Tier node with the following command:
                     > ssh-copy-id -i /root/.ssh/id_rsa.pub root@<enterprise search="" node="">
             c. Validate the root passwordless SSH connection to the Microservices Tier node with the following command:
                     > ssh root@<enterprise search="" node=""> hostname
             A nonroot user with sudo privileges can be set up for passwordless SSH in the same manner.

3) Downloads and pre-upgrade steps

3.1) Download the latest Update Installer

Update the Update Installer to the latest (11.7.1.105 or later):

3.1.1) On the Information Server host, download the Update Installer from
https://www.ibm.com/support/pages/node/6574447

        3.1.2) In the document, Updating IBM InfoSphere Information Server, Version 11.7, and installing additional products, under Version 11.7, click the link installing_fixes_fixpacks_updates117.html.
        3.1.3) See section “Installing a new version of the Update Installer before installing an update, fix, or patch” for the steps to extract the new Update Installer and run updateImage.sh.
                    If you used the default directory for Information Server, the Update Installer is installed in /opt/IBM/InformationServer/Updates/bin.

3.2) Download the 11.7.1.3 Service Pack 4 images
    You must download the following images from IBM Fix Central depending on your installation choices.
        For more information on locating the images, see the Download document.

3.2.1) On the Information Server host, download, and extract the Information Server 11.7.1.3 Service Pack 4 ispkg image from IBM Fix Central.
          For example, servicepack_11.7.1.3_SP4_linux64_11713.tar.gz
          Note:
                         1. Set your umask to 022 before the image is extracted.
                         2. Unpack the file to get the ispkg and readme files.

3.2.2) On the Microservices tier, download the ISES Image for Information Server 11.7.1.3 Service Pack 4 from IBM Fix Central. Do not extract the file.
For Service Pack 4, servicepack_11.7.1.3_SP4_microservices_11713.tar.gz

3.3) Pre-upgrade steps

3.3.1) The metadata needed for the Information Analyzer microservice is persisted in a schema named 'ASSET_RELATION'. If this schema was not created previously, it needs to be created before installation of the Service Pack. The steps to create the schema are mentioned in the resolution section of technote 0887665. Absence of the schema causes the ia-services pod to crash.

3.3.2) If you have a Microservices tier, run the following command on your services tier
$ cd <IIS_INSTALL_LOCATION>/ASBServer/bin
$ ./iisAdmin.sh -set -key com.ibm.iis.ug.installed.version -value 11713

4) Installation of 11.7.1.3 Service Pack 4

Most of the following screen captures are from installing Service Pack 2. The same apply to Service pack 4.

4.1) Instructions for upgrading Information Server in GUI mode of the Update Installer

4.1.1) Login to the Information Server host. Change directory to <IS_HOME>/Updates/bin
              For example, cd /opt/IBM/InformationServer/Updates/bin

4.1.2) Verify that the Update Installer version is 11.7.1.105 or later:
                  ./installUpdates -version

4.1.3) Initiate the Service Pack install with the following command:
                   ./installUpdates
              This command launches the Update Installer in GUI mode.

4.1.4) Provide information as required in each panel to complete the installation.
               Click Login.

welcomepage

4.1.5) Review the System requirements, Release Notes, and Planning information.
             Click Next.
image-20220106134057-1

4.1.6) The Update Installer displays the Information Server installation directory.
              Click Next.

image-20220106134153-2

4.1.7) If you do not have a Microservices tier, skip forward to step 4.1.8.
             Note: Information on adding a Microservices tier to 11.7.1.3 Service Pack 4 can be found in technote 6241456.

4.1.7.1) You can choose whether to upgrade the Microservices tier during the installation of 11.7.1.3 Service Pack 4.
                 Note the following requirements for upgrade:
                         1. The Microservices tier must be at version 11.7.1.3.
                         2. All pods must be up and running.
                              You can check the status of the pods by running the following command:
    kubectl get pods --all-namespaces

4.1.7.2) If you do not want to upgrade the Microservices tier now, check the "Skip patching of Information Server microservices tier" checkbox.
                Click Next and skip forward to step 4.1.8.
Information on later upgrading your Microservices tier to 11.7.1.3 Service Pack 4 can be found in technote 6241456.

image-20220106134233-3

4.1.7.3) To upgrade the Microservices tier
                  a. Deselect the "Skip patching of Information Server microservices tier" checkbox.
                  b. Specify a fully qualified domain name for the Master Node Host.
                  c. Specify the same User as was used during the initial installation of the Microservices tier.
                  d. See section 2.2 for more information on "Authenticate with a password".
                  e. If you specify a nonroot user, in /etc/security/limits.conf, the hard and soft setting of nofile and nproc for the specified user must be 10240.
                       Also, umask must be set to 022 in ~/.bashrc.

                 Click Next.

image-20220106134355-4

4.1.8) In the list of "Packages to be installed", select the 11.7.1.3 Service Pack 4 ispkg file you downloaded from IBM Fix Central.
            Click Next.

4.1.9) If you have a Microservices tier, provide your existing credentials for Kafka and Solr (for example, solruser, solrpwd etc). The Update Installer creates the specified users in Kafka and Solr; they do not have to be an operating system user, Information Server user, or LDAP user.
Later, you can use the specified values for maintenance actions such as accessing the Solr web UI.
Click Next.

image-20220106134552-6

4.1.10) Provide the location of Information Server, the Administrator user name, and password. Accept the certificate and click Next.

image-20220106134651-7

4.1.11) On the System Requirements Check page, confirm that all system requirements passed, and then click Next.

image-20220106134746-8

4.1.12) If you have a Microservices tier, examine the results from system requirement checks of the Microservices tier. If all is good, click Next.

image-20220106134842-9

4.1.13) Review the Preinstallation Summary and click the Install button to start the installation.
image-20220106135028-10

4.1.14) Click the Finish button after the installation completes.
image-20220106135113-11

4.1.15) Click “Advanced” followed by "Accept the Risk and Continue".
image-20220106135220-12
image-20220106135334-13

4.1.16) The Launchpad is displayed.

4.1.16.1) If you do not have a Microservices tier, the Information Server Launchpad is displayed.

image-20220106135550-16

4.1.16.2) If you have a Microservices tier, the Information Server (Microservices) Launchpad is displayed.

image-20220106135424-15

4.2) Instructions for upgrading Information Server in Console mode of the Update Installer

            Note:
             1. The Microservices tier must be at version 11.7.1.3 before installation of Service Pack 4.
             2. The validation checks performed by the Update Installer in Console mode are not as extensive as the checks performed when the Update Installer is in GUI mode.

4.2.1) Login to the Information Server host. Change directory to <IS_HOME>/Updates/bin
             For example, cd /opt/IBM/InformationServer/Updates/bin

4.2.2) Verify that the Update Installer version is 11.7.1.105 or later:
                   ./installUpdates -version
              If you need to update the Update Installer, see step 3.1.

4.2.3) Run the Update Installer to upgrade Information Server.
            For example,
                   installUpdates -i /opt/IBM/InformationServer/ -p /opt/Builds/ISPKG/<ispkg_file_name>.ispkg -verbose -console -properties <property_file_name>

       where
          <ispkg_file_name> is the ispkg file you downloaded from IBM Fix Central
                            For example, servicepack_11.7.1.3_SP4_linux64_11713.tar.gz
          <property_file_name> is the name of the property file wherein you specify values for the various properties that control the upgrade of the Microservices tier.

Sample property file

               The Update Installer prompts you for the Information Server administrator user ID and password, and the WebSphere Administrator user ID and password.

5) Post upgrade actions

5.1) Information Server Microservices tier launchpad does not display icons properly

If you experience JR62814 in your environment, do the following steps on your relevant tiers.

On the Microservices tier host:

1. Modify the iis-server Ingress
a. kubectl edit Ingress iis-server

             b. Locate the following lines
                 ingress.kubernetes.io/configuration-snippet: |
                 proxy_redirect "https://$host:<IIS services tier port>/" "https://$host/";

Ensure that the newly added proxy_redirect lines are properly aligned with the prior proxy_redirect line as consumption of the file contents is sensitive to the formatting.

d. Save this ConfigMap.

2. Modify the iis-redirect Ingress
a. kubectl edit Ingress iis-redirect

           b. Locate the following lines
             ingress.kubernetes.io/configuration-snippet: |
          proxy_redirect "https://$host:<IIS services tier port>/" "https://<IIS services tier short host name>:<IIS services tier port>/";

           c. After these lines, insert proxy-redirect directives for short host name, alias name, and IP address:
          proxy_redirect "https://<Microservices tier short host name>:<IIS services tier port>" "https://<IIS services tier short host name>:<IIS services tier port>/";
          proxy_redirect "https://<Microservices tier host name alias>:<IIS services tier port>" "https://<IIS services tier host name alias>:<IIS services tier port>/";
      proxy_redirect "https://<Microservices tier IP address>:<IIS services tier port>" "https://<IIS services tier IP address>:<IIS services tier port>/";
                 Ensure that the newly added proxy_redirect lines are properly aligned with the prior proxy_redirect line as consumption of the file contents is sensitive to the formatting.

d. Save this ConfigMap.

3. Delete nginx ingress pod by using the following command:
kubectl delete pods -l app=ingress-nginx -n kube-system

4. Ensure that nginx ingress pod is up and running by using the following command:
kubectl get pods -l app=ingress-nginx -n kube-system

        On the Information Server host:

        1. Add a host alias property:

      $ cd <IIS_INSTALL_LOCATION>/ASBServer/bin
        $ ./iisAdmin.sh -set -key com.ibm.iis.ug.host.aliases -value
         <Microservices tier long host name>,<Microservices tier short host name>,<Microservices tier alias name>,<Microservices tier IP address>
      $ ./iisAdmin.sh -d -key com.ibm.iis.ug.host.aliases

        2. Restart WebSphere Application Server.

        On the Browser host:

        Add an entry in the hosts file
       UNIX:    /etc/hosts
       Windows: <Drive>:\Windows\System32\drivers\etc\host on Windows)
              with IP address, long host name, short host name, and alias name as follows:
            <Microservices tier IP address> <Microservices tier long host name> <Microservices tier short host name> <Microservices tier alias name>

5.2) (Optional) Backup and purge the Backup folder within the Updates and _uninstall folders

        Information Server saves prior versions of JAR files to facilitate patch rollbacks and uninstall of components:
       a. In the Updates folder within your Information Server location, for each patch installed, a patch folder is created with the name of the patch. The patch folder contains copies of files that are replaced during the patch installation. The patch folder name is based on the name of the patch, which can be seen in the History section of your Version.xml. The files in this folder are used by the Update installer to roll back a patch installation; they are not needed while Information Server is used.
   b. Each time the Update Installer is updated, the JAR files used by the Update Installer that are changed, are saved in a new lib.<timestamp> folder within the Updates folder.
   c. The _uninstall folder contains files that are only used while Information Server components are uninstalled.

For Apache Log4j related patches, the prior vulnerable versions of Apache Log4j could be present within such folders.
If you want to remove such Apache Log4j files from the system, take a backup of such a folder, and then purge the folder.

An appropriate backup of the patch folder must be restored before any subsequent patch rollback attempt.
Likewise, an appropriate backup of the files in _uninstall must be restored before any subsequent uninstall action.

5.3) Remove log4j version 1.x JAR file from brokers.war
The service pack installation does not remove a log4j version 1.x JAR file on the services tier in <IIS_INSTALL_LOCATION>/wlp/usr/servers/mis/apps/brokers.war. You can use the following steps to replace the war file,

a. Extract the ispkg file of this service pack.
For example,
unzip servicepack_11.7.1.3_SP4_linux64_11713.ispkg

b. Change directory to ...\servicepack_11.7.1.3_SP4_linux64_11713.ispkg.zip\IMAM\deploy

c. Copy brokersserver.war to a temporary directory

d. In the temporary directory, rename brokersserver.war to brokers.war

e. On the services tier, replace brokers.war in <IIS_INSTALL_LOCATION>/wlp/usr/servers/mis/apps

d. Do a clean restart the IBM metadata interchange agent service

For example, on Windows operating system,

         To stop the server, net stop mis
       To delete mis server workarea,
                          Change directory to ISHOME\wlp\usr\servers\mis
                          rmdir /s workarea

To start the server, net start mis

On Linux operating system,

To stop the server, ISHOME/wlp/bin/server stop mis

To start the server, ISHOME/wlp/bin/server start mis --clean

5.4) Remove log4j version 1.x JAR file used for Salesforce
If you have a client-only installation of Information Server 11.7.1.x, the service pack installation does not remove log4j version 1.x JAR files that were deployed for usage by the Salesforce Connector. Since the Salesforce Connector does not use this folder anymore, the folder can be deleted:
On the client-only installation machine:

1. Change directory to <IS_HOME>\ASBNode\lib\java

2. rmdir salesforce

5.5) Clean up shared open source deployment on the services tier when a Microservices tier is present
If you installed Information Server with a Microservices tier, and choose to not update the Microservices tier when an Information Server patch is applied, the Update Installer might install extra "shared-open-source" services on the services tier. Additionally, Information Server is configured to use these services instead of the services on the Microservices tier, and a shared-open-source directory is erroneously created on the services tier.

Follow these steps to reconfigure Information Server to again work with the Microservices tier:

            a. Change directory to the shared-open-source directory on the services tier:
                 AIX or Linux:    cd /opt/IBM/InformationServer/shared-open-source
       Windows:         cd C:\IBM\InformationServer\shared-open-source

            b. Uninstall shared-open-source services on the services tier
                 AIX:             bin/uninstall-aix-services.sh
                 Linux:           bin/uninstall-linux-services.sh
                 Windows:         bin\uninstall-windows-services.bat

            c. Use the iisAdmin tool to set the zookeeper host and port in Information Server (specify your Microservices tier host name):
                 AIX and Linux:    ./iisAdmin.sh -set -key com.ibm.iis.sdp.zookeeper.connect -value <masterNodeHost>:2181/kafka
                 Windows:    iisAdmin.bat -set -key com.ibm.iis.sdp.zookeeper.connect -value <masterNodeHost>:2181/kafka
                 See iisAdmin command documentation for more information.

            d. Delete the shared-open-source directory on the services tier:
                 AIX or Linux:    rm -r /opt/IBM/InformationServer/shared-open-source
       Windows:         rmdir /s C:\IBM\InformationServer\shared-open-source

Change History:
27 April 2022: Initial publication
03 May 2022: Updates/backup and _uninstall/Backup folders must be purged; not the entire Updates & _uninstall folders
20 May 2022: Remove log4j JAR file from brokers.war
19 July 2022: Delete the Salesforce folder in Client-tier only installations as it might contain old log4j version.
Clarified that a patch folder is created in Updates location, not a folder named backup.
29 November 2022: Updated section 5.3 steps to clean up log4j 1.x in brokers.war
31 January 2023: Added section 5.5 for cleanup of extra "shared-open-source" services on the services tier.

[{"Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSZJPZ","label":"IBM InfoSphere Information Server"},"ARM Category":[{"code":"a8m50000000L32vAAC","label":"Patch Installer-\u003ECumulative Service - Fix Packs and Service Packs"}],"Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"11.7.1"}]

Tips