Skip to main content
This page provides version compatibility information for the watsonx Orchestrate ADK when deployed on IBM Software Hub (on-premises).

​
Overview

When deploying watsonx Orchestrate on IBM Software Hub, it’s essential to use the correct ADK version that corresponds to your IBM Software Hub version. This ensures optimal performance and compatibility.
For air-gapped environment setup instructions, see Operating in an air-gapped environment.

​
Compatibility matrix

The following table shows the supported ADK versions for each IBM Software Hub release:
Release DateIBM Software Hub VersionADK VersionStandard EnvironmentAir-Gapped Environment
30 June, 20255.2.01.6.2SupportedNot supported
30 July, 20255.2.0.11.6.xSupportedNot supported
27 August, 20255.2.11.8.xSupportedContact IBM support for a patch
29 October, 20255.2.21.12.xSupportedSupported
10 December, 20255.3.01.14.xSupportedSupported
25 February, 20265.3.12.3.xSupportedSupported
25 February, 20265.3.1 - Patch02.3.xSupportedSupported
11 March, 20265.3.1 - Patch12.5.xSupportedSupported

​
Version selection guidelines

When selecting an ADK version:
  1. Match your IBM Software Hub version: Always use the ADK version that corresponds to your IBM Software Hub deployment
  2. Check air-gapped support: If operating in an air-gapped environment, verify that your IBM Software Hub version supports it
  3. Apply patches: For patch releases, use the specified ADK version to ensure compatibility with bug fixes and improvements
Using an incompatible ADK version may result in unexpected behavior or functionality issues. Always verify version compatibility before deployment.

​
Installing the ADK

To install a specific ADK version: 
pip install ibm-watsonx-orchestrate==<version>
Replace <version> with the appropriate version from the compatibility matrix (e.g., 2.13.0).