Update

This section describes how to apply maintenance updates to XDM.

Overview

The process of updating XDM consists of replacing the Docker images that belong to XDM to the most recent versions.

XDM can be updated in two ways:

You can let Docker download the updated images automatically from UBS Hainer. This is referred to as an online update.
You can manually transfer the updated images to your system and register them in Docker. This is referred to as an offline update.

Updating XDM

It is recommended to backup the admin database before updating XDM. For more information, see the backup description.

Depending on your preferences, follow the instructions under the section Online update or the section Offline update.

Online update

If the system on which XDM is installed has access to the internet, you can let Docker download the updated images automatically from the UBS Hainer Docker repository. You must have an account for the UBS Hainer Docker repository, and Docker must be logged in (see the corresponding section in the Installation chapter).

Follow these instructions to perform an online update:

Make sure that your current working directory is the directory where XDM is installed.
Download the latest base installation package.
It is recommended to compare the content of xdm3-installation.zip with the directory where XDM is installed. It is also recommended to compare the content of the file docker-compose.yaml . There might be some changes in the configuration in this file or in the content of the XDM directory.
You can update all Docker images that belong to XDM at once, or you can update each Docker image individually. Choose one of the following two methods:
1. To update all Docker images that belong to XDM at once, enter the following command on the command line:
  docker-compose pull
2. To update the Docker images individually, enter the following commands on the command line:
  docker pull docker.ubs-hainer.com/xdm3-core docker pull docker.ubs-hainer.com/xdm3-dataflow docker pull docker.ubs-hainer.com/xdm3-ui

Offline update

If the system on which XDM is installed does not have internet access, you can use the packaged images in the file xdm3-images-installation.zip.

xdm3-images-installation.zip is not a whole update package. This zip file only contains the docker images for the offline installation.

For an offline update, the same steps as for an online update need to be performed. The only difference is that all docker images have to be registered manually in the docker repository with the help of the script load-image.sh instead of the docker pull you do during the online update.

This can be done by using the following command:

chmod +x load-image.sh
./load-image.sh

Configuring the desired Version

Before pulling the docker images automatically or manually, update the version tags for the installed version in the docker-compose.yml.

E.g. for version 3.23.11 set

image: docker.ubs-hainer.com/xdm3-core:3.23.11
...
image: docker.ubs-hainer.com/xdm3-dataflow:3.23.11
...
image: docker.ubs-hainer.com/xdm3-ui:3.23.11

If you want to update to the latest version, use the tag latest instead of the specific version.

For more information see XDM versioning.

Stopping and restarting XDM

After updating the Docker images, XDM must be stopped and restarted before the update takes effect. You can stop and restart XDM immediately after the update process is complete, or at a later point in time. Follow these instructions to stop and restart XDM:

Open a command line shell on the system where XDM is installed.
Change into the XDM base directory by using the cd command.
Enter the following command to stop XDM:
```
docker-compose down
```
Enter the following command to restart XDM:
```
docker-compose up -d
```
The parameter -d causes XDM to start in the background so that it will keep running when you exit then shell.

Note that a deep refresh of the XDM User Interface in your browser is necessary after an update to avoid loading a cached version of XDM out of your browser cache. For most of the common browsers this can be done by using Ctrl+F5

Updating the Jenkins Plugin

Every XDM update includes an update of the corresponding Jenkins Plugin.

Follow these instructions to update the Jenkins Plugin:

Extract the file xdm3-jenkins-plugin-<latest version>.hpi from the base installation package.
Upload and install it on your Jenkins.

For more information how to install the Jenkins plugin see the section Jenkins Integration.

Updating FileBridge

You can update the file bridge server either on a host or on a Linux server.

Follow these instructions to update the file bridge server on the respective system.

Updating FileBridge on a host

Upload and replace the file FBRSRV.XMIT.BIN on the host. The latest version of this file is available in the base installation package.

Updating FileBridge on a Linux server

Replace the file file-bridge-server<latest version>.jar on the Linux server. The latest version of the file is available in the base installation package.

There is also a corresponding driver for the new version of the file bridge server. The driver file is named file-bridge-driver-<latest version>.jar. This driver file has to be updated on all clients that connect to the file bridge server. In XDM the driver file has to be replaced in the directory xdm-config/jdbc-drivers/.

Updating the Kubernetes Helm Charts

For information how to update the Kubernetes Helm charts, see the update description.