IBM watsonx Orchestrate

https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base
Admin
IBM watsonx Orchestrate is an AI-powered platform for building and deploying intelligent agents and...
Tokens:1,461,120
Snippets:9,352
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install dependencies and start token-exchange server

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=platform-integration-genesys

Run these commands in the reference implementation directory to install dependencies and start the server. The server must be reachable over HTTPS at a public URL.

```plaintext
npm install
node src/server.js
```

--------------------------------

### Run IAM setup (example)

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=operations-offline-backup-restore

Example of the offline-backup-restore.sh setup-iam-policies command with specific values for regions, cluster, bucket, OpenSearch domain, and IAM user.

```plaintext
./offline-backup-restore.sh setup-iam-policies \
  --source-region eu-north-1 \
  --dest-region eu-west-1 \
  --source-cluster wxo-prod-eks \
  --s3-bucket wxo-velero-backups \
  --source-opensearch-domain wxo-prod-opensearch \
  --opensearch-trusted-principal-arn arn:aws:iam::123456789012:user/wxo.backup.operator \
  --attach-user wxo.backup.operator
```

--------------------------------

### Example: Deploy with cert-manager already installed (skip cert-manager)

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=eks-installation-steps

Example command with concrete values for a cluster where cert-manager is already installed. Uses the --skip-components cert-manager flag and example namespaces, storage classes, registry host, and domain.

```plaintext-ibm
./wxo-cli deploy \
  --instance-namespace swhub-latest-in \
  --operator-namespace swhub-latest-op \
  --block-storage-class fsx-high-iops-5120 \
  --file-storage-class fsx-high-iops-5120 \
  --image-pull-prefix cp.icr.io \
  --domain wxo.example.com \
  --skip-components cert-manager
```

--------------------------------

### Example: Deploy without cert-manager installed (standard command)

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=eks-installation-steps

Example command with concrete values for a cluster where cert-manager is not installed. Uses example namespaces, storage classes, registry host, and domain.

```plaintext-ibm
./wxo-cli deploy \
  --instance-namespace wxo-in \
  --operator-namespace wxo-op \
  --block-storage-class fsx-high-iops-5120 \
  --file-storage-class fsx-high-iops-5120 \
  --image-pull-prefix cp.icr.io \
  --domain wxo.example.com
```

--------------------------------

### Example output for healthy WatsonxOrchestrate and WoComponentServices

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=troubleshooting-wxo-cli-installation-failures

Example output for a healthy installation. Shows READY True, DEPLOYED 28/28, VERIFIED 28/28, RECONCILE_PROGRESS 100%, and COMPONENTSTATUS LiteInstallComplete.

```plaintext
NAME                                       VERSION   PATCH_VERSION   READY   DEPLOYING_COMPONENT   DEPLOYED   VERIFIED   INSTALLMODE   QUIESCE        RECONCILE_PROGRESS   AGE
watsonxorchestrate.wo.watsonx.ibm.com/wo   1.0.0     GA (1.0.0)      True    All Deployed          28/28      28/28      agentic       NOT_QUIESCED   100%                 20d

NAME                                                            VERSION   READY   DEPLOYED   COMPONENTSTATUS       UPGRADE   AGE
wocomponentservices.wo.watsonx.ibm.com/wo-components-services   1.0.0     true    18         LiteInstallComplete   false     20d
```

--------------------------------

### String.startsWith() example

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=reference-expression-language-methods-actions

Returns true if the string starts with the specified substring. The example checks if ${step_297} starts with 'What'.

```plaintext-ibm
${step_297}.startsWith('What')
```

--------------------------------

### Set up instance with wxo-cli setup-instance

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=orchestrate-installing-watsonx-wxo-cli

Creates Zen metastore Secret/ConfigMap and ingress resources for the instance namespace. Must run before precheck and apply-cluster-scope. Requires --image-pull-prefix for PostgreSQL setup pod.

```plaintext-ibm
./wxo-cli setup-instance \
  --instance-namespace wxo-instance \
  --platform           openshift \
  --image-pull-prefix  cp.icr.io
```

--------------------------------

### wxo setup-instance

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=references-wxo-cli-command-reference

Creates the Zen metastore Secret and ConfigMap and the ingress resources for the instance namespace. Run this command before precheck.

```APIDOC
## wxo setup-instance

### Description
Creates the Zen metastore Secret and ConfigMap and the ingress resources for the instance namespace. Run this command before `precheck`.

### Command
`wxo setup-instance`

### Parameters

#### Flags
- `--instance-namespace` (string) - Required - Instance namespace (for example, `wxo-instance`)
- `--domain` (string) - Required - External hostname (for example, `wxo.example.com`)
- `--ingress-class-name` (string) - Required - Ingress class name (for example, `alb`)
- `--alb-scheme` (string) - Optional - ALB scheme — `internet-facing` (public) or `internal` (private)
- `--alb-certificate-arn` (string) - Optional - ACM certificate ARN for the ALB HTTPS listener
- `--image-pull-prefix` (string) - Required - Registry prefix for the Zen metastore initialization pod, which connects to the external Aurora PostgreSQL database. Use your private registry host and prefix, or `cp.icr.io` for online installs

```

--------------------------------

### Configure kubeconfig and verify cluster access

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=kubernetes-installing-watsonx-orchestrate-amazon-eks

Run these commands from the bastion host to configure the kubeconfig for the target EKS cluster and verify access by listing secrets in the instance namespace. The kubectl get secret command must return secrets from the target cluster before starting the installation.

```plaintext
aws eks update-kubeconfig \
  --region <AWS_REGION> \
  --name <EKS_CLUSTER_NAME>

kubectl get secret -n <INSTANCE_NAMESPACE>
```

--------------------------------

### setup-iam-policies example with exported inputs

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=operations-online-backup-restore

Example command using exported base principal credentials and packaged policy defaults. Replace wxo.backup.operator with the base IAM user, or use --attach-role or --attach-current-role for a role. Use --skip-execution-policy to prepare only service roles.

```plaintext-ibm
./online-backup-restore.sh setup-iam-policies \
  --source-region "$AWS_REGION" \
  --source-cluster "$CLUSTER_NAME" \
  --tenant-namespace "$INSTANCE_NAMESPACE" \
  --s3-bucket "$BAR_BUCKET" \
  --s3-source-bucket "$SOURCE_APP_S3_BUCKET" \
  --s3-replica-bucket "$TARGET_APP_S3_BUCKET" \
  --source-opensearch-domain "$SOURCE_OPENSEARCH_DOMAIN" \
  --target-opensearch-domain "$TARGET_OPENSEARCH_DOMAIN" \
  --opensearch-snapshot-role-name "$OPENSEARCH_SNAPSHOT_ROLE_NAME" \
  --opensearch-snapshot-policy-name SnapshotS3 \
  --opensearch-client-inline-policy-name SnapshotClient \
  --opensearch-snapshot-base-path "opensearch-manual/$INSTANCE_NAMESPACE" \
  --s3-replication-role-name "$S3_REPLICATION_ROLE_NAME" \
  --s3-replication-policy-name S3Replication \
  --msk-replicator-role-name "$MSK_REPLICATOR_ROLE_NAME" \
  --attach-user wxo.backup.operator
```

--------------------------------

### Example apply-cluster-scope without cert-manager skip

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=eks-installation-steps

Example command for applying cluster-scope when cert-manager is not installed. Uses example values for namespaces, storage classes, image pull prefix, and domain.

```plaintext-ibm
./wxo-cli apply-cluster-scope \
  --instance-namespace swhub-latest-in \
  --operator-namespace swhub-latest-op \
  --block-storage-class fsx-high-iops-5120 \
  --file-storage-class fsx-high-iops-5120 \
  --image-pull-prefix cp.icr.io \
  --domain wxo.example.com
```

--------------------------------

### Example apply-cluster-scope with cert-manager skip

Source: https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=eks-installation-steps

Example command for applying cluster-scope when cert-manager is already installed. Uses example values for namespaces, storage classes, image pull prefix, and domain.

```plaintext-ibm
./wxo-cli apply-cluster-scope \
  --instance-namespace swhub-latest-in \
  --operator-namespace swhub-latest-op \
  --block-storage-class fsx-high-iops-5120 \
  --file-storage-class fsx-high-iops-5120 \
  --image-pull-prefix cp.icr.io \
  --domain wxo.example.com \
  --skip-components cert-manager
```
Tokens:
Raw