Skip to content

Commit 9789c71

Browse files
author
Michael Burke
committed
Add CMA support to must-gather
1 parent b68b404 commit 9789c71

File tree

4 files changed

+202
-5
lines changed

4 files changed

+202
-5
lines changed

‎modules/gathering-data-specific-features.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ endif::from-main-support-section[]
108108

109109
[NOTE]
110110
====
111-
To collect the default `must-gather` data in addition to specific feature data, add the `--image-stream=openshift/must-gather` argument.
111+
* To collect the default `must-gather` data in addition to specific feature data, add the `--image-stream=openshift/must-gather` argument.
112+
113+
* For information on gathering data about the Custom Metrics Autoscaler, see the Additional resources section that follows.
112114
====
113115

114116
.Prerequisites

‎modules/nodes-pods-autoscaling-custom-gather.adoc

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * nodes/nodes-pods-autoscaling-custom.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="nodes-pods-autoscaling-custom-gather_{context}"]
7+
= Gathering debugging data
8+
9+
ifndef::openshift-origin[]
10+
When opening a support case, it is helpful to provide debugging information about your cluster to Red Hat Support.
11+
12+
It is recommended that you provide the following information:
13+
14+
* Data gathered using the `must-gather` tool.
15+
* The unique cluster ID.
16+
endif::openshift-origin[]
17+
18+
You can use the `must-gather` tool to collect data about the Custom Metrics Autoscaler Operator and its components, including:
19+
20+
* The `openshift-keda` namespace and its child objects.
21+
* The Custom Metric Autoscaler Operator installation objects.
22+
* The Custom Metric Autoscaler Operator CRD objects.
23+
24+
The following command runs the `must-gather` tool for the Custom Metrics Autoscaler Operator:
25+
26+
[source,terminal]
27+
----
28+
$ oc adm must-gather --image="$(oc get packagemanifests openshift-custom-metrics-autoscaler-operator \
29+
-n openshift-marketplace \
30+
-o jsonpath='{.status.channels[?(@.name=="stable")].currentCSVDesc.annotations.containerImage}')"
31+
----
32+
33+
[NOTE]
34+
====
35+
The standard {product-title} must-gather command, `oc adm must-gather`, does not collect Custom Metrics Autoscaler Operator data.
36+
====
37+
38+
39+
.Prerequisites
40+
41+
* Access to the cluster as a user with the `cluster-admin` role.
42+
* The {product-title} CLI (`oc`) installed.
43+
44+
.Procedure
45+
46+
. Navigate to the directory where you want to store the `must-gather` data.
47+
+
48+
[NOTE]
49+
====
50+
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.
51+
52+
[source,terminal]
53+
----
54+
$ oc import-image is/must-gather -n openshift
55+
----
56+
====
57+
58+
. Perform one of the following:
59+
+
60+
--
61+
* To get only the Custom Metrics Autoscaler Operator `must-gather` data, use the following command:
62+
+
63+
[source,terminal]
64+
----
65+
$ oc adm must-gather --image="$(oc get packagemanifests openshift-custom-metrics-autoscaler-operator \
66+
-n openshift-marketplace \
67+
-o jsonpath='{.status.channels[?(@.name=="stable")].currentCSVDesc.annotations.containerImage}')"
68+
----
69+
+
70+
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.
71+
72+
* To gather the default `must-gather` data in addition to the Custom Metric Autoscaler Operator information:
73+
74+
.. Use the following command to obtain the Custom Metrics Autoscaler Operator image and set it as an environment variable:
75+
+
76+
[source,terminal]
77+
----
78+
$ IMAGE="$(oc get packagemanifests openshift-custom-metrics-autoscaler-operator \
79+
-n openshift-marketplace \
80+
-o jsonpath='{.status.channels[?(@.name=="stable")].currentCSVDesc.annotations.containerImage}')"
81+
----
82+
83+
.. Use the `oc adm must-gather` with the Custom Metrics Autoscaler Operator image:
84+
+
85+
[source,terminal]
86+
----
87+
$ oc adm must-gather --image-stream=openshift/must-gather --image=${IMAGE}
88+
----
89+
--
90+
+
91+
.Example must-gather output for the Custom Metric Autoscaler:
92+
[%collapsible]
93+
====
94+
[source,terminal]
95+
----
96+
└── openshift-keda
97+
├── apps
98+
│ ├── daemonsets.yaml
99+
│ ├── deployments.yaml
100+
│ ├── replicasets.yaml
101+
│ └── statefulsets.yaml
102+
├── apps.openshift.io
103+
│ └── deploymentconfigs.yaml
104+
├── autoscaling
105+
│ └── horizontalpodautoscalers.yaml
106+
├── batch
107+
│ ├── cronjobs.yaml
108+
│ └── jobs.yaml
109+
├── build.openshift.io
110+
│ ├── buildconfigs.yaml
111+
│ └── builds.yaml
112+
├── core
113+
│ ├── configmaps.yaml
114+
│ ├── endpoints.yaml
115+
│ ├── events.yaml
116+
│ ├── persistentvolumeclaims.yaml
117+
│ ├── pods.yaml
118+
│ ├── replicationcontrollers.yaml
119+
│ ├── secrets.yaml
120+
│ └── services.yaml
121+
├── discovery.k8s.io
122+
│ └── endpointslices.yaml
123+
├── image.openshift.io
124+
│ └── imagestreams.yaml
125+
├── k8s.ovn.org
126+
│ ├── egressfirewalls.yaml
127+
│ └── egressqoses.yaml
128+
├── keda.sh
129+
│ ├── kedacontrollers
130+
│ │ └── keda.yaml
131+
│ ├── scaledobjects
132+
│ │ └── example-scaledobject.yaml
133+
│ └── triggerauthentications
134+
│ └── example-triggerauthentication.yaml
135+
├── monitoring.coreos.com
136+
│ └── servicemonitors.yaml
137+
├── networking.k8s.io
138+
│ └── networkpolicies.yaml
139+
├── openshift-keda.yaml
140+
├── pods
141+
│ ├── custom-metrics-autoscaler-operator-58bd9f458-ptgwx
142+
│ │ ├── custom-metrics-autoscaler-operator
143+
│ │ │ └── custom-metrics-autoscaler-operator
144+
│ │ │ └── logs
145+
│ │ │ ├── current.log
146+
│ │ │ ├── previous.insecure.log
147+
│ │ │ └── previous.log
148+
│ │ └── custom-metrics-autoscaler-operator-58bd9f458-ptgwx.yaml
149+
│ ├── custom-metrics-autoscaler-operator-58bd9f458-thbsh
150+
│ │ └── custom-metrics-autoscaler-operator
151+
│ │ └── custom-metrics-autoscaler-operator
152+
│ │ └── logs
153+
│ ├── keda-metrics-apiserver-65c7cc44fd-6wq4g
154+
│ │ ├── keda-metrics-apiserver
155+
│ │ │ └── keda-metrics-apiserver
156+
│ │ │ └── logs
157+
│ │ │ ├── current.log
158+
│ │ │ ├── previous.insecure.log
159+
│ │ │ └── previous.log
160+
│ │ └── keda-metrics-apiserver-65c7cc44fd-6wq4g.yaml
161+
│ └── keda-operator-776cbb6768-fb6m5
162+
│ ├── keda-operator
163+
│ │ └── keda-operator
164+
│ │ └── logs
165+
│ │ ├── current.log
166+
│ │ ├── previous.insecure.log
167+
│ │ └── previous.log
168+
│ └── keda-operator-776cbb6768-fb6m5.yaml
169+
├── policy
170+
│ └── poddisruptionbudgets.yaml
171+
└── route.openshift.io
172+
└── routes.yaml
173+
----
174+
====
175+
176+
ifndef::openshift-origin[]
177+
. Create a compressed file from the `must-gather` directory that was created in your working directory. For example, on a computer that uses a Linux
178+
operating system, run the following command:
179+
+
180+
[source,terminal]
181+
----
182+
$ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/ <1>
183+
----
184+
<1> Replace `must-gather-local.5421342344627712289/` with the actual directory name.
185+
186+
. Attach the compressed file to your support case on the link:https://access.redhat.com[Red Hat Customer Portal].
187+
endif::[]
188+

‎nodes/pods/nodes-pods-autoscaling-custom.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ include::modules/nodes-pods-autoscaling-custom-about.adoc[leveloffset=+1]
4141

4242
include::modules/nodes-pods-autoscaling-custom-install.adoc[leveloffset=+1]
4343

44-
include::modules/nodes-pods-autoscaling-custom-trigger.adoc[leveloffset=+1]
44+
include::modules/nodes-pods-autoscaling-custom-trigger.adoc[leveloffset=+1]
4545

4646
.Additional resources
4747

@@ -65,11 +65,14 @@ include::modules/nodes-pods-autoscaling-custom-pausing.adoc[leveloffset=+1]
6565

6666
include::modules/nodes-pods-autoscaling-custom-audit.adoc[leveloffset=+1]
6767

68-
////
68+
include::modules/nodes-pods-autoscaling-custom-gather.adoc[leveloffset=+1]
69+
6970
.Additional resources
7071

71-
* For information on the `oc adm must-gather` command, see xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering data about your cluster].
72-
////
72+
* xref:../../support/gathering-cluster-data.adoc#about-must-gather_gathering-cluster-data[About the must-gather tool]
73+
ifndef::openshift-origin[]
74+
* xref:../../support/gathering-cluster-data.adoc#support-get-cluster-id_gathering-cluster-data[Obtaining your cluster ID]
75+
endif::openshift-origin[]
7376
7477
include::modules/nodes-pods-autoscaling-custom-adding.adoc[leveloffset=+1]
7578

‎support/gathering-cluster-data.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ endif::openshift-origin[]
3434
// Gathering data about specific features
3535
include::modules/gathering-data-specific-features.adoc[leveloffset=+2]
3636

37+
== Additional resources
38+
39+
* xref:../nodes/pods/nodes-pods-autoscaling-custom.adoc#nodes-pods-autoscaling-custom-gather_nodes-pods-autoscaling-custom[Gathering debugging data] for the Custom Metrics Autoscaler.
40+
3741
// Gathering audit logs
3842
include::modules/gathering-data-audit-logs.adoc[leveloffset=+2]
3943

0 commit comments

Comments
 (0)