Fix must-gather output for omc compatibility (#4965)

* produce omc-compatible output from must-gather

* Add changelog entry for must-gather omc compatibility fix

* Collect logs from all pods in controller-manager deployment

We need to loop over the pods (in case replicas > 1)

* Update binary path to /usr/bin/gather

* Change collection dir to /must-gather

* Fix stale binary path in README and flag description in config

* Collect logs for CR pods and consolidate must-gather e2e tests

processPodsByInstance was writing pod YAML but not collecting container
logs, so collector/TA/bridge pod logs were missing from must-gather
output. Now iterates all containers and calls getPodLogs for each.

Remove the stale must-gather check from the otlp-metrics-traces e2e
test — it used the old directory layout and is fully covered by the
dedicated must-gather test.

* Fix omc log path and add pod YAML to log directory

omc expects container logs at pods/<pod>/<container>/<container>/logs/
(container name repeated twice), not pods/<pod>/<container>/logs/.
Also, omc logs discovers pods from pods/<pod>/<pod>.yaml — write pod
YAML there so omc logs can find and display them.

* must-gather: replace naive pluralFor with static lookup table

The previous implementation appended "es"/"s" based on whether the Kind
string ended in "s". This produces wrong paths for kinds like NetworkPolicy
(→ "networkpolicys" instead of "networkpolicies"), which omc cannot find.

Replace it with an explicit map covering all Kinds the tool collects.
log.Fatalf on unknown kinds ensures omissions are caught immediately
rather than silently writing to a path omc cannot parse.

* Add omc validation to must-gather e2e test

Download omc binary and verify it can parse the gathered output:
get opentelemetrycollectors, get deployments, get pods, and logs.

* Fix omc log validation by setting project before log check

omc logs defaults to the 'default' project, so it couldn't find the
gather-collector pod in the chainsaw-must-gather namespace.

Author: ozzywalsh

.chloggen/fix-must-gather.yaml

@@ -0,0 +1,19 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: bug_fix
+
+# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
+component: must-gather
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Fix must-gather output to produce omc-compatible directory layout and correct YAML serialization
+
+# One or more tracking issues related to the change
+issues: [4965]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+  Previously collected files used a per-collector directory with kind-prefixed filenames (e.g. `namespaces/<ns>/<collector-name>/deployment-<name>.yaml`),
+  which omc cannot parse. Output now follows the standard omc layout (`namespaces/<ns>/<api-group>/<resource-plural>/<name>.yaml`).
+  Also fixes missing apiVersion/kind fields in serialized YAML, incorrect default output directory, and adds collection of CRDs and OpAMPBridge resources.

cmd/gather/Dockerfile

@@ -9,8 +9,8 @@ RUN INSTALL_PKGS=" \
 WORKDIR /
 
 ARG TARGETARCH
-COPY bin/must-gather_${TARGETARCH} /usr/bin/must-gather
+COPY bin/must-gather_${TARGETARCH} /usr/bin/gather
 
 USER 65532:65532
 
-ENTRYPOINT ["/usr/bin/must-gather"]
+ENTRYPOINT ["/usr/bin/gather"]

cmd/gather/README.md

@@ -24,7 +24,7 @@ This is the recommended way to do it if you are not using OpenShift.
 If you want to use the image in a running cluster, you need to run the following command:
 
 ```sh
-oc adm must-gather --image=ghcr.io/open-telemetry/opentelemetry-operator/must-gather -- /usr/bin/must-gather --operator-namespace opentelemetry-operator-system
+oc adm must-gather --image=ghcr.io/open-telemetry/opentelemetry-operator/must-gather -- /usr/bin/gather --operator-namespace opentelemetry-operator-system
 ```
 
 ### Using it as a CLI