Troubleshooting

If you are using mirroring with CASE archives, skip these steps and go the next section, "Air-gapped and disconnected environments".

1. Log in to the cluster:

   oc login

2. Go to the directory where you want to store the must-gather data.

3. Collect the must-gather information. Make sure you include the quotation marks in the command.

   • To collect Cloud Pak for Integration must-gather only, run:

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c cp4i'"

   • To collect Cloud Pak for Integration must-gather with a version table, run:

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c cp4i -v True'"

   • To get additional options (help), run:

     oc adm must-gather --image=icr.io/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-h'"
     
     options:
     -h, --help          Show this help message and exit
     -n NAMESPACE, --namespace NAMESPACE
                         Namespace you want to collect the logs for, only works with -c appconnect
     -p PODNAME, --podname PODNAME
                         Pod name you want to collect logs for, only works with -c appconnect
     -c COMPONENT, --component COMPONENT
                         Capability you want to collect logs for. For ACE = appconnect, CP4I = cp4i
     -v VERSION, --version VERSION
                         To get a table of all the versions installed, set -v True
     --previous_pod_logs, PREVIOUS POD LOGS
                         To collect pod logs for terminated pods, set --previous_pod_logs True 
     -ne, --namespaced_events NAMESPACED EVENTS
                         To collect events per namespace, set -ne True                         

For environments where CASE archives are being used, the must-gather image is packaged in the Cloud Pak foundational services CASE.

1. Set the registry where your local images are mirrored:

   export LOCAL_REGISTRY=<YOUR_LOCAL_REPOSITORY>

2. Collect the must-gather information. Make sure you include the quotation marks in the command.

   • To collect Cloud Pak for Integration must-gather only, run:

     oc adm must-gather --image=${LOCAL_REGISTRY}/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c cp4i'"

   • To collect Cloud Pak for Integration must-gather with a version table, run:

     oc adm must-gather --image=${LOCAL_REGISTRY}/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-c cp4i -v True'"

   • To get additional options (help), run:

     oc adm must-gather --image=${LOCAL_REGISTRY}/cpopen/cpfs/must-gather:latest -- gather -m cp4i --params "'-h'"
     
     options:
     -h, --help         Show this help message and exit
     -n NAMESPACE, --namespace NAMESPACE
                        Namespace you want to collect the logs for, only works with -c appconnect
     -p PODNAME, --podname PODNAME
                        Pod name you want to collect logs for, only works with -c appconnect
     -c COMPONENT, --component COMPONENT
                        Capability you want to collect logs for. For ACE = appconnect, CP4I = cp4i
     -v VERSION, --version VERSION
                        To get a table of all the versions installed, set -v True
      --previous_pod_logs, PREVIOUS POD LOGS
                          To collect pod logs for terminated pods, set --previous_pod_logs True 
      -ne, --namespaced_events NAMESPACED EVENTS
                          To collect events per namespace, set -ne True             
     

   • To confirm that you have mirrored the latest available version of the must-gather tool, run:

     skopeo list-tags docker://[LOCAL_REGISTRY:5000]/cpopen/cpfs/must-gather
     {
         "Repository": "${LOCAL_REGISTRY}/cpopen/cpfs/must-gather",
         "Tags": [
             "4.5.16"
             .....
             "4.6.7",
             "4.6.8",
             "4.6.9",
             "latest"
         ]
      }

The must-gather tool collects information about the following resources:

Certificate
Clients
ConfigMaps
Cp4iServiceBindings
Cloud Pak CustomResources
Deployments
InstallPlan
Jobs
OperandRequests
PersistentVolumeClaims
Pod-Description
Pod-Logs
ReplicaSets
Routes
Services
StatefulSets
Subscriptions
CatalogSources
ServiceAccounts
Events
OperandBindInfo
OperandRegistries
OperandConfigs
Issuer

It collects information from the following namespaces:

ibm-common-services
openshift-marketplace
openshift-operator-lifecycle-manager
openshift-operators
openshift-ingress
kube-public
namespaces where product capabilities are installed

The must-gather tool collects only the name of the secrets from the listed namespaces. It doesn't collect the data in those secrets.