IBM Cloud Pak for Integration

https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3
Admin
IBM Cloud Pak for Integration is an enterprise integration platform that provides unified...
Tokens:156,549
Snippets:2,613
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Operator Installation Status

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

This is an example output of 'oc get csv' showing the status of installed operators. 'Succeeded' indicates a successful installation.

```text
NAME                                          DISPLAY                                              VERSION   PHASE
ibm-integration-platform-navigator.v7.3.0     IBM Cloud Pak for Integration                        7.3.0     Succeeded
ibm-mq.v3.2.0                                 IBM MQ                                               3.2.0     Succeeded
```

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

### Successful Certificate Installation Output

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=cli-deploying-api-manager-subsystem-by-using

Example output showing that all certificates have been created successfully and are ready.

```text
NAME                         READY   SECRET                       AGE
analytics-ingestion-client   True    analytics-ingestion-client   70s
gateway-client-client        True    gateway-client-client        70s
ingress-ca                   True    ingress-ca                   71s
portal-admin-client          True    portal-admin-client          71s
```

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

### Example GatewayCluster Status Output

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=cli-deploying-api-gateway-subsystem-by-using

Example output from the `oc get GatewayCluster` command, indicating a successful deployment. The installation is complete when the READY status is 'True' and the SUMMARY shows all services are online.

```text
NAME         READY   SUMMARY   VERSION    RECONCILED VERSION       AGE
api-gateway   True    2/2       <version>   <version-build>         7m17s
```

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

### Example: Create ConfigMap

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=resources-using-api-kubernetes-resource

An example command demonstrating how to create a ConfigMap named 'asyncleadsapi' from a local file named 'leadsStream.yaml'.

```bash
oc create configmap asyncleadsapi --from-file=./leadsStream.yaml
```

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

### Example Patch Subscription

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-upgrading-using-cli

An example of patching a specific subscription to a new channel.

```bash
oc patch subscription ibm-integration-platform-navigator-v7.3-sc2 --patch '{"spec":{"channel":"v8.1"}}' --type=merge
```

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

### Example: View Specific Integration Runtime Pod Logs

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=dacetice-scenario-1-deploy-toolkit-integration-from-red-hat-openshift-cli

This is an example of how to view logs for a specific integration runtime pod, useful for detailed troubleshooting.

```bash
oc logs http-echo-service-ir-66c689ddc-n7xvw
```

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

### Get a list of Dashboard instances

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=upgrading-instances

This is an example of retrieving a list of `Dashboard` custom resources running on the cluster.

```bash
oc get Dashboard
```

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

### Example of Creating a ConfigMap

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=resources-using-api-kubernetes-resource

An example command demonstrating how to create a ConfigMap named 'asyncleadsapi' from a local file.

```APIDOC
## For example:
```bash
oc create configmap asyncleadsapi --from-file=./leadsStream.yaml
```
```

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

### Example Service URL

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=dacetice-scenario-2-deploy-toolkit-integration-from-app-connect-dashboard

An example of a fully constructed service URL for the simple-echo-app-http route.

```text
http://simple-echo-app-http-ace.apps.cp4i-2022-demo.cp.abc.com/Echo
```

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

### Example Subscription Edit

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=upgrading-moving-specific-catalog-sources-each-operator

An example demonstrating how to change the 'spec.source' field in a subscription's editor from 'ibm-operator-catalog' to a new, specific catalog source.

```yaml
spec:
  channel: v6.0
  installPlanApproval: Automatic
  name: ibm-integration-platform-navigator
  source: ibm-operator-catalog --> ibm-integration-platform-navigator-catalog
  sourceNamespace: openshift-marketplace
```

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

### Generate OpenShift Installation Manifests

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=compliance-configuring-fips-support-openshift

Run the `openshift-install create manifests` command to generate installation manifests based on your `install-config.yaml`.

```bash
openshift-install create manifests
```

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

### Verify cert-manager Installation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=aks-deploying-platform-ui

Check the status of the cert-manager pods to confirm a successful installation. The output should show pods with a 'Running' status.

```bash
kubectl get pods --namespace cert-manager
```

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

### Example: Invoke Service Endpoint with Specific Route

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=dacetice-scenario-1-deploy-toolkit-integration-from-red-hat-openshift-cli

This example demonstrates invoking a service using a specific route's host and port, along with the service endpoint path.

```bash
curl -X POST http://http-echo-service-http-ace-demo.apps.cp4i-2022-demo.cp.abc.com/Echo
```

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

### Validate Operator Installation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

Use 'oc get csv' to check the status of installed operators. Look for 'Succeeded' in the PHASE column.

```bash
oc get csv
```

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

### Get Helm installation values

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=administering-applying-fix-packs-between-major-releases

Retrieve the values used for the original Helm installation to confirm the 'installMode'. This value defaults to 'OwnNamespace' if not explicitly set.

```bash
helm get values ibm-integration
```

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

### Create a New Project (Namespace)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

If installing in a specific namespace, create a new project using 'oc new-project'.

```bash
oc new-project ${NAMESPACE}
```

```bash
oc new-project integration
```

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

### Install IBM MQ Catalog Source

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=images-adding-catalog-sources-openshift-cluster

Use this command to apply the catalog source for IBM MQ.

```bash
oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-mq/3.9.1/OLM/catalog-sources.yaml
```

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

### List Integration Dashboard instances

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=uninstalling-instances

Example command to list all Integration Dashboard instances across all namespaces.

```bash
oc get Dashboard --all-namespaces
```

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

### Get OperatorConditions in a Namespace

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=troubleshooting-common-issues-solutions

Use this command to find the OperatorCondition for Foundational services. Replace `<namespace>` with the actual namespace where Foundational services are installed.

```bash
oc get operatorconditions -n <namespace where Foundational services is installed.
```

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

### Get IBM Cloud Pak for Integration Platform UI Host URL

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=installation-installing-cloud

Run this command to find the host URL for the Platform UI after installation.

```bash
oc get consolelink | grep "IBM Cloud Pak for Integration"
```

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

### Example Helm List Output

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=aks-installing-operators

This is an example output of the 'helm ls' command, showing a successfully deployed 'ibm-integration' release with its associated namespace, revision, update time, status, chart, and app version.

```text
NAME                 NAMESPACE        REVISION      UPDATED                                   STATUS        CHART                      APP VERSION
ibm-integration      integration      1             2025-06-03 14:12:30.225442 +0100 BST      deployed      ibm-integration-8.2.0      16.1.3.0
```

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

### Install IBM API Connect Catalog Source

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=images-adding-catalog-sources-openshift-cluster

Use this command to apply the catalog source for IBM API Connect.

```bash
oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-apiconnect/6.2.0/OLM/catalog-sources.yaml
```

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

### Retrieve Temporary Admin Password for Cloud Pak for Integration

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=installation-installing-cloud

Use this command to get the temporary administrator password. Replace `<namespace>` with your specified installation project name.

```bash
oc get secret integration-admin-initial-temporary-credentials -n <namespace> -o jsonpath='{.data.password}' | base64 --decode
```

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

### Install IBM App Connect Catalog Source

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=images-adding-catalog-sources-openshift-cluster

Use this command to apply the catalog source for IBM App Connect.

```bash
oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-appconnect/13.0.0/OLM/catalog-sources.yaml
```

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

### Retrieve Temporary Admin Username for Cloud Pak for Integration

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=installation-installing-cloud

Use this command to get the temporary administrator username. Replace `<namespace>` with your specified installation project name.

```bash
oc get secret integration-admin-initial-temporary-credentials -n <namespace> -o jsonpath='{.data.username}' | base64 --decode
```

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

### Retrieve Aspera HSTS Instance Name

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=transfers-getting-credentials-high-speed-transfer-server

Get the name of the Aspera HSTS instance deployed in the `aspera` namespace. This command is useful if you need to reference your instance name, for example, when dealing with default credentials.

```bash
INSTANCE_NAME=`oc get IbmAsperaHsts -n aspera -o jsonpath='{.items[0].metadata.name}'`
```

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

### Install IBM Cloud Pak Foundational Services Catalog Source

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=images-adding-catalog-sources-openshift-cluster

Use this command to apply the catalog source for IBM Cloud Pak foundational services.

```bash
oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-cp-common-services/4.6.21/OLM/catalog-sources.yaml
```

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

### Install IBM DataPower Gateway Catalog Source

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=images-adding-catalog-sources-openshift-cluster

Use this command to apply the catalog source for IBM DataPower Gateway.

```bash
oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-datapower-operator/1.17.0/OLM/catalog-sources.yaml
```

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

### Check AnalyticsCluster Status

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=cli-deploying-api-analytics-subsystem-by-using

Run the `oc get AnalyticsCluster` command to monitor the deployment status of the API Analytics subsystem. The installation is complete when the READY status is 'True' and the SUMMARY indicates all services are online.

```bash
oc get AnalyticsCluster
```

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

### Check API Portal Deployment Status

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=cli-deploying-api-portal-subsystem-by-using

Monitor the status of the API Portal deployment by running the `oc get PortalCluster` command. The installation is complete when the READY status is `True` and the SUMMARY indicates all services are online.

```bash
oc get PortalCluster
```

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

### Define Platform UI instance configuration

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=aks-deploying-platform-ui

Create a YAML file (e.g., `platform-ui-instance.yaml`) to define the Platform UI instance configuration. Update `metadata.namespace` with your namespace and set `spec.license.accept` to `true` if you accept the license.

```yaml
apiVersion: integration.ibm.com/v1beta1
kind: PlatformNavigator
metadata:
  name: integration-quickstart
  namespace: integration     
spec:
  license:
    accept: false
    license: L-SJZL-NMUUCT
  replicas: 1
  version: 16.1.3
```

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

### Generic CLI Command for Drafts

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=ui-saving-drafts-instances

This is a generic command format for interacting with draft secrets using the CLI. Replace `<oc-command>` with the desired `oc` operation (e.g., `get`, `delete`). The `all-namespaces` parameter is optional and required only if operators are installed in all namespaces.

```bash
oc <oc-command> secret [--all-namespaces] --field-selector type=integration.ibm.com/draft
```

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

### Verify ibm-pak Installation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=cluster-mirroring-images-bastion-host

Command to confirm that the `ibm-pak` plug-in is installed and accessible. This verifies the installation of the IBM Catalog Management plug-in for OpenShift.

```bash
oc ibm-pak --help
```

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

### Install IBM Automation Foundation Assets Catalog Source

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=images-adding-catalog-sources-openshift-cluster

Use this command to apply the catalog source for IBM Automation foundation assets.

```bash
oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-integration-asset-repository/2.0.4/OLM/catalog-sources-linux-amd64.yaml
```

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

### Set Namespace for Operator Installation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

Export the desired namespace for operator installation. Use 'openshift-operators' for cluster-wide installations or a custom name for specific namespaces.

```bash
export NAMESPACE=<namespace_name>
```

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

### Verify Certificate Installation

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=cli-deploying-api-manager-subsystem-by-using

Check the status of the created certificates to ensure they have been successfully provisioned and are ready.

```bash
oc get certificates
```

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

### Install Docker on Red Hat Enterprise Linux

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=administering-developer-reference

Use these commands to install Docker on Red Hat Enterprise Linux. Ensure your system is up-to-date before installation.

```bash
yum check-update
yum install docker
```

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

### Set current namespace

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=administering-applying-fix-packs-between-major-releases

Configure the current context to use the specified namespace for the installation. Replace 'integration' with your actual namespace name.

```bash
kubectl config set-context --current --namespace=integration
```

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

### Upload files with expanded syntax

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=transfers-transferring-files-from-command-line

An example of the `ascli node upload` command with specific values for username, password, URL, and token type.

```bash
ascli node upload --username=asp_user --password=asp_pass --url=https://hstscluster.ibm.com --token-type=basic /path/to/test/file
```

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

### Example issuer status output

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=cli-deploying-api-connect-cluster-subsystems-ppc64le

This is an example of the expected output when validating issuer status.

```text
NAME                                      READY
my-api-connect-cluster-name-ingress-issuer   True
my-api-connect-cluster-name-self-signed      True

```

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

### Install IBM MQ Operator

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

Use this subscription object to install the IBM MQ operator.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-mq
  labels:
    backup.mq.ibm.com/component: subscription
spec:
  channel: v3.9
  name: ibm-mq
  source: ibmmq-operator-catalogsource
  sourceNamespace: openshift-marketplace
```

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

### Install IBM DataPower Gateway Operator

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

This subscription object is for installing the IBM DataPower Gateway operator.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: datapower-operator
  labels:
    backup.datapower.ibm.com/component: subscription
spec:
  channel: v1.17
  name: datapower-operator
  source: ibm-datapower-operator-catalog
  sourceNamespace: openshift-marketplace
```

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

### Configure Integration Runtime Instance

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=tutorials-tutorial-connect-api-product-integration-runtime

Set up an Integration runtime instance, specifying its name, license, BAR file URL, and the associated Configuration resource for authentication.

```text
integration-runtime-demo
CloudPakForIntegrationProduction
https://github.com/demo-test-source/demo-source/raw/refs/heads/main/api-demo/api-demo.bar
barauth-demo
```

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

### Install IBM Event Processing Operator

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

This subscription object is for installing the IBM Event Processing operator.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-eventprocessing
spec:
  channel: v1.5
  name: ibm-eventprocessing
  source: ibm-eventprocessing-catalog
  sourceNamespace: openshift-marketplace
```

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

### Install IBM Event Streams Operator

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=operators-installing-by-using-cli

This subscription object is for installing the IBM Event Streams operator.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-eventstreams
  labels:
    backup.eventstreams.ibm.com/component: subscription
spec:
  channel: v12.3
  name: ibm-eventstreams
  source: ibm-eventstreams
  sourceNamespace: openshift-marketplace
```

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

### Install Operator - All Namespaces Mode (Downloaded Chart)

Source: https://www.ibm.com/docs/en/cloud-paks/cp-integration/16.1.3?topic=aks-installing-operators

Install the IBM Cloud Pak for Integration operator in 'AllNamespaces' mode using a downloaded Helm chart. Ensure the chart path is correct.

```bash
helm install ibm-integration --set operator.installMode="AllNamespaces" ./ibm-integration-<version info>.tgz
```
Tokens:
Raw