Running and gathering the Engineering Lifecycle Management MustGather serviceability information

The cluster administrator can run Engineering Lifecycle Management MustGather tool in the cluster. The collected serviceability information helps Jazz® administrator to work with IBM® support for the serviceability of Engineering Lifecycle Management

Serviceability is a built-in API extension for the Engineering Lifecycle Management Operator. The main aim of the tool is to give the customers or developers a standardized way to collect various platform and Engineering Lifecycle Management application-related information and configurations. This collected information can be shared with the IBM Support if requested. Based on the gathered artifacts IBM Support gets more understanding of the deployments. Also, the used configurations help to troubleshoot the reported issue. The tool is installed as part of the Engineering Lifecycle Management operator and used without having an up-and-running Engineering Lifecycle Management deployment.

Gather ELM serviceability data

Red Hat® OpenShift® UI

Go to the IBM Engineering Lifecycle Management (ELM) under the Operators/Installed Operators menu.
Either click Create instance in the Serviceability widget or go to the Serviceability tab where you can request a new instance.
On the instance creation page, you can choose to use the Form view or the YAML view.
Name your instance, enable the type of artifacts you want to be gathered, and click Create.

Red Hat OpenShift or IBM Kubernetes Service CLI

The following sample can be applied

apiVersion: elm.ibm.com/v1
kind: Serviceability
metadata:
  name: <instance-name>
  labels:
    app.kubernetes.io/created-by: ibm-elm-operator
    app.kubernetes.io/instance: <instance-name>
    app.kubernetes.io/managed-by: kustomize
    app.kubernetes.io/name: serviceability
    app.kubernetes.io/part-of: ibm-elm-operator
  namespace: <namespace>
spec:
  gatherApplicationLogs: false
  gatherApplicationSettings: false
  gatherCRDs: false
  gatherCertificatesAndConfigMaps: true
  gatherPodLogs: false
  gatherResources: false
  obfuscateSensitiveData: false

For more information, see Example YAML configurations

The following options are available on Serviceability UI.

Gather Certificates and ConfigMaps: Collects all available Certificates (except private key) and ConfigMaps from the namespace/object.

Gather Custom Resource Definitions (CRDs): Collects the list of available Custom Resource Definitions like ConfigMaps, Endpoints, Persistent Volumes and Claims, Pods, Secrets, ServiceAccounts, Services, Deployments, ReplicaSets, Roles/RoleBindings, and Routes.

Gather Resources: Collects the configurations in YAML format for all the available Pods, Deployments, DeploymentConfigs, StatefulSets, PVCs, Services, Routes, ConfigMaps, BuildConfigs, Builds, ImageStreams, CSVs, Subscriptions, InstallPlans, Ingresses.

Gather Pod logs: Collects the console or platform logs from all the reachable Pods.
Note: In case you have extra Pods or Containers that do not belong to the deployment of the Engineering Lifecycle Managementsuite gets targeted as well.

Gather Application Logs

Collects the Engineering Lifecycle Management application-specific logs from the default folder path.

Note: To use this option, you need to have an up-and-running Engineering Lifecycle Management deployment. In case it’s missing, the web-hook validator gives an error.

The default folder paths are

elm/server/conf/${app}/logs
elm/server/conf/jas/logs
elm/server/conf/rs/logs

Gather Application Settings: Collects the available configuration files from all available Engineering Lifecycle Management applications.
Note: To use this option, you need to have an up-and-running Engineering Lifecycle Management deployment. In case it’s missing, the web-hook validator gives an error.

Obfuscate sensitive data: Turning on this feature hides some of the sensitive data. The customer must review and remove extra sensitive data if its important to share with any external party (such as IBM Support). Data is collected from the Engineering Lifecycle Management application configuration files.; Note: Only sensitive identified data from the configuration files can be obfuscated. Any other external or sensitive data needs to be obfuscated or removed manually.