Gathering deployment information and logs from Cloud Pak for Business Automation 23.0.1 and later

How To

Summary

A command line tool to gather information such as configmaps, pods, secrets, and log files about the CP4BA resources in the target namespace.

Objective

To get the logs for each capability in your CP4BA deployment, you must run the tool and modify the command line to gather what it needs for that capability.

Steps

About oc adm must-gather

This Red Hat OpenShift command triggers a pod to execute on your Red Hat OpenShift cluster. It runs the image specified and triggers a collection script, which gathers various diagnostics. Once the diagnostics are gathered, they are compressed and sent to the client machine in a sub-folder from where the command is run. By default the pod will run in a temporary namespace prefixed with openshift-must-gather. It has access to the global pull secret only though that generally isn't an issue.

Important: For air gap installations, this image is included in the list of images downloaded for an air gap setup. Although, you might need to change the tag to that of the latest image you downloaded. Or, push the new image into your image registry.

Procedure

To run the tool from the command line, use the oc adm must-gather command from your Red Hat OpenShift Container Platform client machine and the icp4a-must-gather image tag with the following format <version>-IF<xxx>. For example:

oc adm must-gather --image=icr.io/cpopen/cp4ba/icp4a-must-gather:23.0.2-IF005 ....

where:

* <version>: is the latest version of the Cloud Pak for Business Automation such as 23.0.2, 24.0.0, etc...

* <IFxxx>: Is latest Interim FixPack for a particular version of CP4A such as IF005. Refer to this link for a complete list of CP4BA Interim Fix list. If there no IF has been released for a particular version, you can omit the “IF” in the tag.

NOTE: It is recommended to use the latest released version of the mustgather image even if you have an older version of CP4BA installed. For example, you can use the image of icp4a-must-gather:23.0.2-IF005 even if you have CP4BA 23.0.1-IF006 installed.

To gather all the logs and configurations of each capability in CP4BA (recommended), you can execute a single command:

oc adm must-gather --image=icr.io/cpopen/cp4ba/icp4a-must-gather:<version>-IF<xxx> <--run-namespace=cp4ba-namespace> -- gather -m cp4ba -n <cp4ba_namespaces>

This command gathers information about the CP4BA and Cloud Pak foundational services (CPfs) resources in the namespace. If you are running the command as a non-cluster admin, use the --run- namespace parameter with the appropriate namespace. This parameter requires OCP 4.11 or later. If the command is executed by a cluster-admin, it is optional.

The command in cp4ba mode takes about 10 - 12 minutes to complete. If you installed the CP4BA operator, use the cp4ba mode and want to collect logs on specific components/patterns:

oc adm must-gather --image=icr.io/cpopen/cp4ba/icp4a-must-gather:<version>-IF<xxx> -- gather -m cp4ba –p <option1, option2,..,>  -n <cp4ba_namespace>

For example:

oc adm must-gather --image=icr.io/cpopen/cp4ba/icp4a-must-gather:<version>-IF<xxx> -- gather -m cp4ba –p cpe,css,ban -n cp4ba-prod

Refer to the table below for more details on other components and patterns.

If you installed the Content operator, use the content mode and want to collect logs on specific components/patterns:

oc adm must-gather --image=icr.io/cpopen/cp4ba/icp4a-must-gather:<version>-IF<xxx> -- gather -m content –p <option1, option2,..,> -n <cp4ba_namespace>

Starting from 24.0.0, if you installed the Business Automation Insightsoperator (BAI standalone), use the bais mode: oc adm must-gather --image=icr.io/cpopen/cp4ba/icp4a-must-gather:24.0.0 -- gather -m bais -n <cp4ba_namespace>

For example:

oc adm must-gather --image=icr.io/cpopen/cp4ba/icp4a-must-gather:<version>-IF<xxx> -- gather -m cp4ba –p content -n cp4ba-prod

Refer to the table below for more details on other components and patterns.

Important: Some of the collections do not support multiple namespaces provided to the -n parameter. Multiple namespaces are only supported by the -p option and not the foundation collection. Cluster admin permission is also required for the broad collections that get cluster information. If the capability or component is not installed in the namespace, the command returns only the information that it can find.

Additional Information

Module	Components and Pattern(s)	What is gathered
-m cp4ba	None	All pod logs and most configurations in the namespace + ICP4ACluster CR
-m cp4ba	-p systeminfo	OCP versions, events, csv, nodes, and status of CPU and memory usage
-m cp4ba	-p operators	CP4BA operator logs, sub-operator logs (content, bts, wfps, pfs, insightsengine, and dependency operators) + systeminfo + ICP4ACluster CR
-m cp4ba	-p application	Application Engine, FNCM, BAN, Resource Registry, BAS, BTS, and operators logs/configurations + ICP4ACluster CR
-m cp4ba	-p content	FNCM, BAN, IER, ICCSAP, ADP content services (CPDS/CDRA/CDS/Viewone/Gitgateway/Mongo), and content sub-operator logs/configurations + systeminfo + ICP4ACluster CR
-m cp4ba	-p document_processing	Automation Document Processing (Content, ACA, AE, BAS, BTS, Operators) logs and configurations + systeminfo + ICP4ACluster CR
-m cp4ba	-p foundation	Automation Foundation logs/configurations + ICP4ACluster CR
-m cp4ba	-p decision	Operational Decision Manager logs/configurations + ICP4ACluster CR
-m cp4ba	-p decision_ads	Automation Decision Services logs and configurations + ICP4ACluster CR
-m cp4ba	-p workflow_runtime	Application Engine, FNCM, BAN, Resource Registry, BAML, PFS, workflow-runtime, BTS, and operators logs/configurations + ICP4ACluster CR
-m cp4ba	-p workflow_authoring	BAS, FNCM, BAN, Resource Registry, BAML, PFS, BTS, and operators logs/configurations + ICP4ACluster CR
-m cp4ba	-p wfps	Resource Registry, WPFS, WPFS, and CP4BA operators logs/configurations + ICP4ACluster CR
-m cp4ba	-p wfps_authoring
-m cp4ba or -m content	-p cpe	CPE and content sub-operator logs and configurations + systeminfo + ICP4ACluster CR or CPE and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p css	CSS and content sub-operator logs and configurations + systeminfo or CSS and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p graphql	GraphQL and content sub-operator logs and configurations + systeminfo or GraphQL and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p cmis	CMIS and content sub-operator logs and configurations + systeminfo or CMIS and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p taskmgr	Task Manager and content sub-operator logs and configurations + systeminfo or Task Manager and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p extshare	External Share and content sub-operator logs and configurations + systeminfo or External Share and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p ban	BAN and content sub-operator logs and configurations + systeminfo or BAN and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p ier	IER and content sub-operator logs and configurations + systeminfo or IER and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p iccsap	ICCSAP and content sub-operator logs and configurations + systeminfo or ICCSAP and content sub-operator logs and configurations + systeminfo + Content CR
-m cp4ba or -m content	-p bai	BAI, CP4BA operator and content sub-operator logs and configurations + systeminfo or BAI and content sub-operator logs and configurations + systeminfo + Content CR
-m content	None	FNCM, BAN, IER, ICCSAP, ADP content services (CPDS/CDRA/CDS/Viewone/Gitgateway/Mongo) and content sub-operator logs/configurations + systeminfo + Content CR
-m bais (starting from 24.0.0 only)	None	BAI opearators logs, configurations, and CPfs resources

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSBYVB","label":"IBM Cloud Pak for Business Automation"},"ARM Category":[{"code":"a8m3p000000LQWpAAO","label":"(How To Use ARM)"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Tips

Gathering deployment information and logs from Cloud Pak for Business Automation 23.0.1 and later

How To

Summary

Objective

Steps

Additional Information

Document Location

Was this topic helpful?

Document Information

UID

Share your feedback

Need support?