Gathering debugging data

You can use the must-gather tool to collect data about the Custom Metrics Autoscaler Operator and its components, including the following items:

  • The openshift-keda namespace and its child objects.

  • The Custom Metric Autoscaler Operator installation objects.

  • The Custom Metric Autoscaler Operator CRD objects.

Gathering debugging data

The following command runs the must-gather tool for the Custom Metrics Autoscaler Operator:

  1. $ oc adm must-gather --image="$(oc get packagemanifests openshift-custom-metrics-autoscaler-operator \
  2. -n openshift-marketplace \
  3. -o jsonpath='{.status.channels[?(@.name=="stable")].currentCSVDesc.annotations.containerImage}')"

The standard OKD must-gather command, oc adm must-gather, does not collect Custom Metrics Autoscaler Operator data.

Prerequisites

  • Access to the cluster as a user with the cluster-admin role.

  • The OKD CLI (oc) installed.

Procedure

  1. Navigate to the directory where you want to store the must-gather data.

    If your cluster is using a restricted network, you must take additional steps. If your mirror registry has a trusted CA, you must first add the trusted CA to the cluster. For all clusters on restricted networks, you must import the default must-gather image as an image stream by running the following command.

    1. $ oc import-image is/must-gather -n openshift

  2. Perform one of the following:

    • To get only the Custom Metrics Autoscaler Operator must-gather data, use the following command:

      1. $ oc adm must-gather --image="$(oc get packagemanifests openshift-custom-metrics-autoscaler-operator \
      2. -n openshift-marketplace \
      3. -o jsonpath='{.status.channels[?(@.name=="stable")].currentCSVDesc.annotations.containerImage}')"

      The custom image for the must-gather command is pulled directly from the Operator package manifests, so that it works on any cluster where the Custom Metric Autoscaler Operator is available.

    • To gather the default must-gather data in addition to the Custom Metric Autoscaler Operator information:

      1. Use the following command to obtain the Custom Metrics Autoscaler Operator image and set it as an environment variable:

        1. $ IMAGE="$(oc get packagemanifests openshift-custom-metrics-autoscaler-operator \
        2.   -n openshift-marketplace \
        3.   -o jsonpath='{.status.channels[?(@.name=="stable")].currentCSVDesc.annotations.containerImage}')"

      2. Use the oc adm must-gather with the Custom Metrics Autoscaler Operator image:

        1. $ oc adm must-gather --image-stream=openshift/must-gather --image=${IMAGE}
  1. Example must-gather output for the Custom Metric Autoscaler:
  3. ```
  4. └── openshift-keda
  5.     ├── apps
  6.     │   ├── daemonsets.yaml
  7.     │   ├── deployments.yaml
  8.     │   ├── replicasets.yaml
  9.     │   └── statefulsets.yaml
  10.     ├── apps.openshift.io
  11.     │   └── deploymentconfigs.yaml
  12.     ├── autoscaling
  13.     │   └── horizontalpodautoscalers.yaml
  14.     ├── batch
  15.     │   ├── cronjobs.yaml
  16.     │   └── jobs.yaml
  17.     ├── build.openshift.io
  18.     │   ├── buildconfigs.yaml
  19.     │   └── builds.yaml
  20.     ├── core
  21.     │   ├── configmaps.yaml
  22.     │   ├── endpoints.yaml
  23.     │   ├── events.yaml
  24.     │   ├── persistentvolumeclaims.yaml
  25.     │   ├── pods.yaml
  26.     │   ├── replicationcontrollers.yaml
  27.     │   ├── secrets.yaml
  28.     │   └── services.yaml
  29.     ├── discovery.k8s.io
  30.     │   └── endpointslices.yaml
  31.     ├── image.openshift.io
  32.     │   └── imagestreams.yaml
  33.     ├── k8s.ovn.org
  34.     │   ├── egressfirewalls.yaml
  35.     │   └── egressqoses.yaml
  36.     ├── keda.sh
  37.     │   ├── kedacontrollers
  38.     │   │   └── keda.yaml
  39.     │   ├── scaledobjects
  40.     │   │   └── example-scaledobject.yaml
  41.     │   └── triggerauthentications
  42.     │       └── example-triggerauthentication.yaml
  43.     ├── monitoring.coreos.com
  44.     │   └── servicemonitors.yaml
  45.     ├── networking.k8s.io
  46.     │   └── networkpolicies.yaml
  47.     ├── openshift-keda.yaml
  48.     ├── pods
  49.     │   ├── custom-metrics-autoscaler-operator-58bd9f458-ptgwx
  50.     │   │   ├── custom-metrics-autoscaler-operator
  51.     │   │   │   └── custom-metrics-autoscaler-operator
  52.     │   │   │       └── logs
  53.     │   │   │           ├── current.log
  54.     │   │   │           ├── previous.insecure.log
  55.     │   │   │           └── previous.log
  56.     │   │   └── custom-metrics-autoscaler-operator-58bd9f458-ptgwx.yaml
  57.     │   ├── custom-metrics-autoscaler-operator-58bd9f458-thbsh
  58.     │   │   └── custom-metrics-autoscaler-operator
  59.     │   │       └── custom-metrics-autoscaler-operator
  60.     │   │           └── logs
  61.     │   ├── keda-metrics-apiserver-65c7cc44fd-6wq4g
  62.     │   │   ├── keda-metrics-apiserver
  63.     │   │   │   └── keda-metrics-apiserver
  64.     │   │   │       └── logs
  65.     │   │   │           ├── current.log
  66.     │   │   │           ├── previous.insecure.log
  67.     │   │   │           └── previous.log
  68.     │   │   └── keda-metrics-apiserver-65c7cc44fd-6wq4g.yaml
  69.     │   └── keda-operator-776cbb6768-fb6m5
  70.     │       ├── keda-operator
  71.     │       │   └── keda-operator
  72.     │       │       └── logs
  73.     │       │           ├── current.log
  74.     │       │           ├── previous.insecure.log
  75.     │       │           └── previous.log
  76.     │       └── keda-operator-776cbb6768-fb6m5.yaml
  77.     ├── policy
  78.     │   └── poddisruptionbudgets.yaml
  79.     └── route.openshift.io
  80.         └── routes.yaml
  81. ```