manage setup-appconnect

Important: IBM Cloud Pak® for Data Version 4.8 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.8 reaches end of support. For more information, see Upgrading from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1.

Create the App Connect resources and secrets for watsonx Orchestrate®.

Required role
Instance administrator You must be an administrator of the projects that are associated with an instance to run this command.

Prerequisites

Before you can run this command, a cluster administrator must install the IBM App Connect in containers on the cluster. For more information, see Installing IBM App Connect in containers.

Remember: Each instance of watsonx Orchestrate requires a dedicated instance of App Connect. You must install an instance of App Connect for each instance of watsonx Orchestrate that you plan to install.

Extended description

Run the setup-appconnect command to create an App Connect instance and the secrets that watsonx Orchestrate can use to connect to the instance.

Syntax

cpd-cli manage setup-appconnect \
--components=watsonx_orchestrate \
--release=<version> \
--cpd_instance_ns=<project-name> \
--appconnect_ns=<project-name> \
--file_storage_class=<RWX-storage-class>

Arguments

The setup-appconnect command has no arguments.

Options

Option Description
--appconnect_ns The project where the App Connect operator for this instance of watsonx Orchestrate is installed.
Status
Required.
Syntax
--appconnect_ns=<project-name>
Default value
No default.
Valid values
The project where the App Connect operator for this instance of watsonx Orchestrate is installed.
--components The component for which you want to set up App Connect.
Status
Required.
Syntax
--components=watsonx_orchestrate
Default value
There is no default value.
Valid values
watsonx_orchestrate
--cpd_instance_ns The project (namespace) where IBM Cloud Pak for Data is installed.
Status
Required.
Syntax
--cpd_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
The name of an existing project on the Red Hat® OpenShift® Container Platform cluster.
--file_storage_class A storage class that supports ReadWriteMany (RWX) access.

For information about the storage classes that watsonx Orchestrate supports, see Storage requirements.

Status
Required.
Syntax
--file_storage_class=<RWX-storage-class>
Default value
No default.
Valid values
The name of a storage class that supports RWX access.
--release The release of IBM Cloud Pak for Data that is installed.
Status
Required.
Syntax
--release=<version>
Default value
No default. You must specify the release.
Valid values
  • 4.8.4
  • 4.8.5
  • 4.8.6

Table 1: Command options

Examples

Note: The following example uses the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For details, see Best practice: Setting up installation environment variables.

Create the App Connect resources for the instance of watsonx Orchestrate in the specified project
cpd-cli manage setup-appconnect \
--components=watsonx_orchestrate \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--appconnect_ns=${PROJECT_IBM_APP_CONNECT} \
--file_storage_class=${STG_CLASS_FILE}