Co-Author – Anand Awasthi
Browse this page for answers to some of the frequently asked questions you might have about IBM App Connect Enterprise on Cloud Pak for Integration. Click on a question to see the answer.
For questions about this FAQ, you can add a comment to the bottom of this page.
Install and Configure
How do I install IBM Cloud Pak for Integration (CP4I ) 2019.4.1 on OCP4.2?
Refer to this blog for guidance;
Deploying IBM Cloud Pak for Integration 2019.4 on OCP 4.2
How do I pass the additional configuration or secrets to my Integration Server deployment?
If the integration server requires any configuration to be applied then you will need to use the option Download configuration package to provide the configuration prior to the helm install. Refer to the README.md inside the download on how to create the required secrets.
For detailed information, refer to section 7 of the blog;
Modernizing Integration – Migration from IIB to App Connect running on IBM Cloud Pak for Integration (CP4I)
How do I configure my MQ instance running in CP4I on OCP4.2 to accept the connections from external MQ Client apps (like MQ Explorer, RFHUtil) over SSL?
Refer to the following article;
Connecting to a Queue Manager on Cloud Pak for Integration
Development and Deployment
Can I deploy more than one bar file to an integration server?
The ACE dashboard via platform navigator allows you to deploy only one bar file per container. However, you may be able to deploy multiple BAR files by building a CI/CD pipeline. It is advisable however, to follow certain Agile Integration guidelines on how you group your application/BAR files as a unit of deployment per container instead of deploying several applications to a single integration server. This is described in the article;
Grouping integrations in a containerized environment
How do I implement a CI/CD pipeline for ACE BAR deployments in CP4I?
Refer to section 7.5 in the IBM Redbook on Agile Integration at;
I am using multi-instance integration nodes. How can I migrate them to CP4I?
At the application level it is the pods that provide high availability. Kubernetes allows you to run multiple pods (redundancy) and in the event of one of the pods or containers failing, Kubernetes will spin up a replacement pod. This way you can ensure the availability of your services at all times.
A detailed discussion on the high availability aspects is available in Section 7.7 of the IBM Redbook;
I am not able to change the User Defined Properties (UDPs) of my deployed flows
User Defined Properties have been traditionally used to control the runtime behavior of message flows. In traditional deployment, you could update the UDP value in a deployment message flow. However when you deploy the flow in a container on CP4I, any code or configuration change should create a new container replacing the existing one. When you are running multiple replicas of ACE container, your changes would not apply to all of them, leaving the state of replicas inconsistent. Also the changes would not persist when the container is recreated for any reason.
How do I configure Aggregation nodes (or in general EDA nodes) in the OpenShift environment?
Starting from Fix Pack 22.214.171.124, it is now possible to use the EDA message flow nodes without having a local queue manager, and instead direct them towards a remote queue manager using an MQ client connection. To get the maximum value from moving to a container environment, it is beneficial to be able to independently scale ACE containers from MQ queue manager containers.
For more information, refer to this blog post;
Explore the new features in App Connect Enterprise version 126.96.36.199
Migration and Upgrades
Can I migrate from OCP 3.11 to OCP 4.2?
Whilst ACE v11 is supported on OpenShift 4.2 there is no migration path from OpenShift 3.11 – i.e. you will need to start from scratch again. You can export the bar files and then re-import but there is no in-place migration as the OCP platform cannot be upgraded.
How can I update my CP4I with an ACE certified container image?
Refer to section 10. Upgrading ACE certified container image in CP4I in the following blog article;
Modernizing Integration – Migration from IIB to App Connect running on IBM Cloud Pak for Integration(CP4I)
Is there a migration guide to move existing IIB v10 Apps to ACE running in CP4I containers?
How can I rollback my deployment changes?
Can I change the image type when upgrading the Helm release? For example if previously it was ACE only and now I need to upgrade the integration server with one flow that uses MQ client or Server or vice-versa?
Yes. It is possible that the initial release of your integrations were not using MQ, it was built with an ACE-only image. However new requirements might require connecting to a Queue Manager. So when you upgrade the helm release with changes in your integration artifacts, you can choose ACE with an MQ client or ACE with an MQ server image as per the case. Similarly you may change the image to ACE only while doing the helm upgrade if MQ connectivity is not required anymore.
Troubleshooting and Serviceability
Where can I see the logs for my ACE integration server pod?
Get the list of your ACE pods using
$ oc get pods
Then for each ACE pod that you want the logs for, run the following command
$ oc logs <ace pod>
You can also view the logs in the Kibana dashboard
How do I enable trace for ACE Integration Server in CP4I, or how do I trace my integration server running in container in CP4I?
Edit the deployment of your integration server using kubectl edit deployment
Find where it says
- name: USE_QMGR value: "true"
Add the following below it
- name: MQSI_FORCE_DEBUG_TRACING
- name: MQSI_PLAINTEXT_TRACE
- name: MQSI_FORCE_TRACE_SIZE
Save the change.
How do I copy ACE Int Server Pod logs/traces out of the container?
How do I enable Logging for ACE Dashboard?
To enable debug level logging for the ACE Dashboard, run the following command;
'kubectl edit deployment acedash-ibm-ace-dashboard-icp4i-prod
CIP_SERVICES_ENDPOINT env var please add the following two additional lines
Save the changes.
How do I view ACE dashboard logs?
Run the following command;
kubectl logs <dashboard pod> -c <dashboard container>
(Note : There are 3 dashboard containers – Content server, Control UI, content server init)
How do I investigate performance issues for integration flows running in container/CP4I?
These are some of the options that you can consider to monitor the performance of your integration flows.
- Operations dashboard – for end to end (across multiple components within CP4I) tracing/view of your transaction
- Message flow Accounting & Statistics
Enable Snapshot accounting and statistics in csv format using configuration secret for integration server (i.e. by modifying the server.conf.yaml file) . This can be done by modifying your ACE config secret and then doing a helm upgrade with the new config secrets.
Once you have recreated the performance issue, copy the stats out of the ACE pod using
oc rsync <pod>:<absolute path of stats file inside the container> <local file system>
The statistics files are created under the following directory path in the Ace container.
- Check how many replicas are allocated for your integration server and whether you need to increase them further to cater to the load.
- Check Pod Resource usage using the Grafana dashboard and see if CPU usage is nearing its allocated limits.
OCP Console → Administrator → Monitoring → Dashboards
ICP4I Platform navigator → Monitoring
Select the namespace and pod from the dropdown list as shown below
Are ACE certified container images supported on CP4I or Openshift Kubernetes platform?
Yes, the ACE certified container images are fully supported on Openshift including the helm charts.
Are ACE certified container (ACEcc) images / dockerfiles supported on third party Kubernetes?
Use of ACEcc images are supported on any Kubernetes environment which uses one of the following virtualisation technologies: docker, CRI-O, containerd. The helm charts are not supported on non-openshift environments and any other configuration custom written in order to present the container image to the non-OpenShift Kubernetes system, for example operators and helm charts. Please refer to SOE (https://www.ibm.com/support/pages/node/609043) for the current support statement.
How do I stop my ACE integration server or integration flows running in CP4I?
In container world, if you do not typically control the integration server’s lifecycle, rather you would control it at the Pod/deployment level. In other words, if you do not need the integration server for some reason, you would typically remove the deployment/helm release and when you need the integration flows, you would deploy it back via a new helm release.