IBM Support

How to collect MustGather information for Guardium Insights troubleshooting

How To


Summary

Before opening a case with Guardium Insights (GI) support, collect MustGather information to help troubleshooting.

Objective

  1. Understand different MustGather types for GI
  2. Collect MustGather information

Steps

  • GI application depends on Red Hat OpenShift Container Platform (OCP) and IBM Common Services (ICS) layers
  • There are two types of MustGather - Guardium Insights (GI application) and Platform (OCP and ICS)
  • Typical GI cases require Guardium Insights MustGather only, however in some cases platform MustGather is also required
1. Guardium Insights MustGather
  • Developed by Guardium Insights team 
  • Collects information about GI application layer
  • Uses cp-serviceability pod in GI namespace and cpctl tool to run
How to collect
  1. Oc or cloudctl login to the GI namespace as the admin user
  2. Download cpctl tool to your workstation or bastion server
    • Repeat this step if the GI version was upgraded since the last time MustGather was run. Otherwise, skip if you already have cpctl 
    • > POD=$(oc get pod --no-headers -lrun=cp-serviceability | cut -d' ' -f1)
> oc cp $POD:/opt/bin/<operatingsystem>/cpctl ./cpctl && chmod +x ./cpctl
      • Where <operatingsystem> is linux, darwin, darwin/arm64 or windows
        • darwin/arm64 and windows are available starting in version 3.2.7
        • For windows cpctl run on Linux subsystem for Windows
  3. Ensure local cpctl is up to date with cp-serviceability pod by running:
    • ./cpctl load 
    • Starting in version 3.2.7, run ./cpctl load --no-filter
  4. Run the GI MustGather 
    • > ./cpctl diagnostics GI_mustgather --token $(oc whoami -t) --namespace <guardium_insights_namespace>
    • Starting in version 3.3.0, optionally use --mustgather_type option to narrow the data collection
      • Available types are: all, db2, risk_outlier, ingestion, sniffer. Default is all
    • Known issue - If you receive 'Error: command terminated with exit code 137' follow steps to increase pod storage.
  5. Collect the results file
    • After MustGather completion, command to download it from the pod to your local workstation is provided, for example:
    • GI mustgather execution completed. Run `oc cp staging-cp-serviceability-5bcfc94bf9-f27x8:/tmp/GI_must_gather_staging_20211020150124.tar.gz ./GI_must_gather_staging_20211020150124.tar.gz` to copy the mustgather archive into the local workstation
2. Platform MustGather 
  • Developed by IBM Common Services team, also referred to as IBM Foundational Services
  • Collects information about ICS and OCP layers 
How to collect
  1. Follow instructions provided by the IBM Common Services team:

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSWSZ5","label":"IBM Security Guardium Insights"},"ARM Category":[{"code":"a8m0z0000001gKuAAI","label":"MUST_GATHER"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
10 June 2024

UID

ibm16832174

Page Feedback