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 WIoTP MessageGateway .tz files for installation.  The preparation steps for installing MessageGateway as an update or for the first time are the same.  For more information, see Preparing the IBM WIoTP MessageGateway .tz packages for installation.

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

Installing IBM WIoTP MessageGateway

2. Installing the fix:

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

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

      cd imaserver

      sudo  yum -y --nogpgcheck update IBMWIoTPMessageGatewayServer*.rpm

      systemctl start IBMWIoTPMessageGatewayServer

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

      cd imawebui

      sudo yum -y --nogpgcheck update IBMWIoTPMessageGatewayWebUI*.rpm

      systemctl start IBMWIoTPMessageGatewayWebUI

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

yum install IBMWIoTPMessageGatewayServer*.rpm

or uninstall and reinstall with rpm or yum (if you wish 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 MessageGateway is running in docker:

I. Build the IBM WIoTP MessageGateway Docker image.

Build the IBM WIoTP MessageGateway 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> .

Eg:

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

II. Build the IBM WIoTP MessageGateway 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> .

Eg:

docker build --force-rm=true -t imawebui:5.0.0.2.20200729-1714 .

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 WIoTP MessageGateway 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 WIoTP MessageGateway 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 WIoTP MessageGateway 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 WIoTP MessageGateway Web UI was running. For example,

docker rm imawebui

V.  Remove the old MessageGateway images (optional)

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

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

for every version of MessageGateway, 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 WIoTP MessageGateway Web UI image by issuing the following command:

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

If, however, you tag each MessageGateway image with a build specific version, eg:

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 had used for previous incarnations of the MessageGateway containers.

Here's the general syntax for how to start the IBM WIoTP MessageGateway server container:

docker run --cap-add SYS_ADMIN --net=host -P -it --name=<server_container_name> -env-file=IBMWIoTPMessageGatewayServer-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=IBMWIoTPMessageGatewayServer-docker.env -m 64G -v /data/messagesight:/var/messagesight -v /mnt/tmp:/var/tmp -d imaserver:5.0.0.2.20200729-1714

To start the IBM WIoTP MessageGateway Web UI container:

docker run --cap-add SYS_ADMIN --net=host -P -it --name=<webui_container_name> --env-file=IBMWIoTPMessageGatewayServer-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=IBMWIoTPMessageGatewayServer-docker.env -m 2G -v /data/messagesight:/var/messagesight -v /mnt/tmp:/var/tmp -d imawebui:5.0.0.2.20200729-1714

3. Verifying the installation:

If this is your initial install of the product see Configuring the licensed usage for IBM WIoTP MessageGateway 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 WIoTP MessageGateway server and services by using REST Administration APIs.