Fix Instructions:

Before you install:

We strongly recommend performing a backup before upgrading the product software:

Backup and restore instructions

1. Preparing to install the fix:

Prepare the IBM IoT MessageSight .tz files for installation.  The preparation steps for installing MessageSight as an update or for the first time are the same.  For more information, see Preparing the IBM IoT MessageSight .tz packages for installation.

These instructions focus on providing instructions for updating MessageSight.  See the following instructions for installing MessageSight for the first time:

Installing IBM IoT MessageSight

2. Installing the fix:

A. RPM: In an environment where MessageSight is installed with rpm:

I. Updating the MessageSight Server package if Server is installed:

      cd imaserver
      sudo  yum -y --nogpgcheck update IBMIoTMessageSightServer*.rpm
      systemctl start IBMIoTMessageSightServer

II. Updating the MessageSight Server package if the WebUI is installed:

cd imawebui
sudo yum -y --nogpgcheck update IBMIoTMessageSightWebUI*.rpm
systemctl start IBMIoTMessageSightWebUI

NOTE: these packages can also be installed by using: rpm -Uvh IBMIoTMessageSight*.rpm. However, you must never update by using:

yum install IBMIoTMessageSightServer*.rpm

or uninstall and reinstall with rpm or yum (if you want  to preserve your existing data), since this will remove all of your data and config under /var/messagesight.

B. Docker: Installing the fix in an environment where MessageSight is running in docker:

I. Build the IBM IoT MessageSight Docker image.

Build the IBM IoT MessageSight server image by issuing the following command:

cd imaserver
mv *.rpm imaserver.rpm
docker build --force-rm=true -t <server_image_name>:<fix_version>.<build> .

For example:

docker build --force-rm=true -t imaserver:2.0.0.2.20210416-2128 .

II. Build the IBM IoT MessageSight Web UI image by issuing the following command:

cd imawebui
mv *.rpm imawebui.rpm
docker build --force-rm=true -t <webui_image_name>:<fix_version>.<build> .

For example:

docker build --force-rm=true -t imawebui:2.0.0.2.20210416-2128 .

III.  Stop the existing containers.

Stop the server container by issuing the following command:

docker stop <server_container_name>

where <server_container_name> is the name of the container in which the IBM IoT MessageSight server is running. For example,

docker stop imaserver

Stop the Web UI container by issuing the following command:

docker stop <webui_container_name>

where <webui_container_name> is the name of the container in which the IBM IoT MessageSight Web UI is running. For example,

docker stop imawebui

IV. Remove the containers.

Remove the server container by issuing the following command:

docker rm <server_container_name>

where <server_container_name> is the name of the container in which the IBM IoT MessageSight server was running. For example,

docker rm imaserver

Remove the Web UI container by issuing the following command:

docker rm <webui_container_name>

where <webui_container_name> is the name of the container in which the IBM IoT MessageSight Web UI was running. For example,

docker rm imawebui

V.  Remove the old MessageSight images (optional)

This step is only required if you are not tagging MessageSight docker images with version specific tags.  For example, if you build a MessageSight docker image like this:

docker build --force-rm=true -t imaserver: .

for every version of MessageSight, then you need to remove the previous image by issuing the following command(s), before building the update image:

docker rmi -f $(docker ps | grep imaserver | awk '{print $3}')

Remove the IBM IoT MessageSight Web UI image by issuing the following command:

docker rmi -f $(docker ps | grep imawebui | awk '{print $3}')

However, if you tag each MessageSight image with a build specific version, for example:

docker build --force-rm=true -t imaserver:<fix_version>.<build> .

then, this step is not required.

VI.  Start the new containers.

Use the same Docker run command that you used for previous incarnations of the MessageSight containers.

Here's the general syntax for how to start the IBM IoT MessageSight server container:

docker run --cap-add SYS_ADMIN --net=host -P -it --name=<server_container_name> -env-file=IBMIoTMessageSightServer-docker.env -m <memory> -v <local_data_directory>:/var/messagesight -v <local_temp_directory>:/var/tmp -d <server_image_name>:<fix_version>.<build>

A more concrete example:

docker run --cap-add SYS_ADMIN --net=host -P -it --name=imaserver -env-file=IBMIoTMessageSightServer-docker.env -m 64G -v /data/messagesight:/var/messagesight -v /mnt/tmp:/var/tmp -d imaserver:2.0.0.2.20210416-2128

To start the IBM IoT MessageSight Web UI container:

docker run --cap-add SYS_ADMIN --net=host -P -it --name=<webui_container_name> --env-file=IBMIoTMessageSightServer-docker.env -m <memory> -v <local_data_directory>:/var/messagesight -v <local_temp_directory>:/var/tmp -d <webui_image_name>:<fix_version>.<build>

A more concrete example:

docker run --cap-add SYS_ADMIN --net=host -P -it --name=imawebui --env-file=IBMIoTMessageSightServer-docker.env -m 4G -v /data/messagesight:/var/messagesight -v /mnt/tmp:/var/tmp -d imawebui:2.0.0.2.20210416-2128

3. Verifying the installation:

If this is your initial install of the product see Configuring the licensed usage for IBM IoT MessageSight and accepting the license by using REST Administration APIs for accepting the product license.

If this is an update, then you can verify the status of the server see Viewing the status of an IBM IoT MessageSight server and services by using REST Administration APIs.