Update process

Updating XDM

This section describes how to apply maintenance updates to XDM for Docker and Kubernetes installations. It explains the general update procedure, platform-specific steps, and how to handle common update issues such as session problems and database migration locks.

General Update Procedure

Before updating XDM, always follow these general steps:

  1. Read the release notes and changelog for the new version.

    Check which changes are included, whether there are breaking changes, and which configuration parameters have been added, changed, or deprecated.

  2. Perform a full backup:

    • Backup the XDM admin database as described in Admin Database backup.

    • Ensure that persistent volumes or host directories (for example xdm-data, xdm-tasks, xdm-backups) are included in your regular backup process.

  3. Plan a maintenance window and logoff:

    • Inform users about the planned downtime.

    • Ask all users to log off before the update.

    • For Kubernetes and Docker, stop external traffic (for example by disabling the Ingress or placing a maintenance page in front of the UI) if needed.

      If active sessions remain during the update, they may cause deserialization errors after the update (for example InvalidClassException if internal libraries change).

  4. Prepare configuration changes:

    • Review the sample docker-compose.yml or Helm values.yaml of the new installation package.

    • Identify new parameters that should be configured (for example new security settings, feature flags).

    • Identify deprecated or removed options and plan how to migrate them.

    • Apply the changes to your local configuration before or during the update.

Updating The Jenkins Plugin

Every XDM update may include an updated Jenkins plugin. To update it:

  1. Extract the file xdm3-jenkins-plugin-<latest version>.hpi from the new base installation package.

  2. Upload and install the plugin on your Jenkins server.

  3. Restart Jenkins if required by your Jenkins configuration.

For more information, see Jenkins Integration.

Updating FileBridge

If you use FileBridge, update both the server and driver components.

Updating FileBridge On A Host

  • Upload the new FBRSRV.XMIT.BIN file from the base installation package to the host system.

  • Replace the existing FBRSRV.XMIT.BIN with the new version according to your host installation procedure.

Updating FileBridge On A Linux Server

  • Replace the file-bridge-server-<latest version>.jar on the Linux server with the new version from the base installation package.

  • Restart the FileBridge server process.

  • Update the corresponding driver file file-bridge-driver-<latest version>.jar on all clients that connect to the FileBridge server.

  • In XDM, replace the FileBridge driver in the directory xdm-config/jdbc-drivers/ with the new version.

After updating FileBridge and its driver, test connectivity from XDM to the FileBridge server and verify that tasks using FileBridge run successfully.