Skip to main content
Using the ADK in an air gapped environment introduces additional challenges you need to address:
  • The ADK Python package is hosted on PyPI. In an air gapped environment, it is inaccessible.
  • By default, watsonx Orchestrate pulls packages from PyPI when installing Python tools.
  • The watsonx Orchestrate Developer Edition is not available.

Getting started

As a site administrator, you need to acquire:
  • Access to a jumpbox which connects to both the internet and your Cloud Pak for Data Cluster.
  • A locally hosted Python package registry accessible from your internal network. Examples of common PyPi registry providers include Artifactory and Sonatype Nexus, but other options are available.

Uploading the ADK to your local pypi registry

1

Get dependencies list

On your jumpbox, run the following to get the full list of dependencies necessary to generate wheel files for each dependency of the ADK.
BASH
# Install UV
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create a UV Virtual environment
uv venv adk --seed --python=3.12
source adk/bin/activate

pip install ibm-watsonx-orchestrate==<supported version>
pip freeze > requirements.txt
mkdir dependencies
cd dependencies
pip wheel -r requirements.txt
2

Copy wheel files

Copy all wheel files to your local PyPI registry provider.

Fixing Python tool import

To import Python tools successfully, configure watsonx Orchestrate to pull the ADK from your local registry. All python tools must be imported with a requirements.txt file. This file must contain at least the following:
--index-url https://my-pypi-registry
# optionally
my-dependency==dependency-version
Note: Any dependencies other than the ADK you want to utilize in your tools must also be uploaded by site administrator to your PyPI registry as well.

CPD - watsonx Orchestrate ADK compatability chart

Below are the supported versions of the ADK that should be used with each version of CPD.
CPD Expected Release DateCPD VersionADK VersionCPD Support Of Non-air gapped ADKCPD Support of air gaped ADK
30 June, 20255.2.01.6.2SupportedNo support
30 July, 20255.2.0.11.6.xSupportedNo support
27 August, 20255.2.11.8.xSupportedRequires custom patch from support team
29 October, 20255.2.21.12.xSupportedSupported
10 December, 20255.31.14.xSupportedSupported