Create a must-gather for the operator

.chloggen/3149-add-must-gather.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# 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: operator
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Add a must gather utility to help troubleshoot"
+
+# One or more tracking issues related to the change
+issues: [3149]
+
+# (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: "The new utility was added to the operator container so it can be run without adding any new container. It can be run from the /must-gather path"

.github/workflows/publish-images.yaml

@@ -47,7 +47,7 @@ jobs:
           for platform in $(echo $PLATFORMS | tr "," "\n"); do
             arch=${platform#*/}
             echo "Building manager for $arch"
-            make manager ARCH=$arch
+            make manager must-gather ARCH=$arch
           done
 
       - name: Docker meta

Dockerfile

@@ -15,6 +15,7 @@ COPY --from=certificates /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-ce
 
 # Copy binary built on the host
 COPY bin/manager_${TARGETARCH} manager
+COPY bin/must-gather_${TARGETARCH} must-gather
 
 USER 65532:65532
 

Makefile

@@ -143,6 +143,9 @@ ci: generate fmt vet test ensure-generate-is-noop
 manager: generate
 	CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(ARCH) go build -o bin/manager_${ARCH} -ldflags "${COMMON_LDFLAGS} ${OPERATOR_LDFLAGS}" main.go
 
+must-gather:
+	CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(ARCH) go build -o bin/must-gather_${ARCH} -ldflags "${COMMON_LDFLAGS} ${OPERATOR_LDFLAGS}" ./cmd/gather/main.go
+
 # Build target allocator binary
 .PHONY: targetallocator
 targetallocator:
@@ -331,7 +334,7 @@ scorecard-tests: operator-sdk
 # buildx is used to ensure same results for arm based systems (m1/2 chips)
 .PHONY: container
 container: GOOS = linux
-container: manager
+container: manager must-gather
 	docker build --load -t ${IMG} .
 
 # Push the container image, used only for local dev purposes

cmd/gather/README.md

@@ -0,0 +1,29 @@
+# OpenTelemetry Operator Must-Gather
+
+The OpenTelemetry Operator `must-gather` tool is designed to collect comprehensive information about OpenTelemetry components within an OpenShift cluster.
+This utility extends the functionality of [OpenShift must-gather](https://github.com/openshift/must-gather) by specifically targeting and retrieving data related to the OpenTelemetry Operator, helping in diagnostics and troubleshooting.
+
+## What is a Must-Gather?
+
+The `must-gather` tool is a utility that collects logs, cluster information, and resource configurations related to a specific operator or application in an OpenShift cluster. It helps cluster administrators and developers diagnose issues by providing a snapshot of the cluster's state related to the targeted component. More information [in the official documentation](https://docs.openshift.com/container-platform/4.16/support/gathering-cluster-data.html).
+
+## Usage
+
+To run the must-gather tool for the OpenTelemetry Operator, use one of the following commands, depending on how you want to source the image and the namespace where the operator is deployed.
+
+### Using the image from the Operator deployment
+
+If you want to use the image directly from the existing OpenTelemetry Operator deployment, run the following command:
+
+```sh
+oc adm must-gather --image=$(oc -n opentelemetry-operator-system get deployment.apps/opentelemetry-operator-controller-manager -o jsonpath='{.spec.template.spec.containers[?(@.name == "manager")].image}') -- /must-gather --namespace opentelemetry-operator-system
+```
+
+### Using the image from a local machine
+
+You can use the image in your machine with the following command:
+```sh
+docker run --entrypoint=/must-gather <operator-image> --help
+```
+
+Note that you can use this utility too to gather information about the objects deployed by the OpenTelemetry Operator if you don't use OpenShift.