Apply changes requested in code review

Signed-off-by: Israel Blancas <[email protected]>

Author: Israel Blancas

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

@@ -2,7 +2,7 @@
 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
+component: instrumentation, collector
 
 # 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"
@@ -13,4 +13,13 @@ 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 is available as part of a new container image"
+subtext: |
+  The new utility is available as part of a new container image.
+
+  To use the image in a running OpenShift 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
+  ```
+
+  See the [README](https://github.com/open-telemetry/opentelemetry-operator/blob/main/cmd/gather/README.md) for more details.

.github/workflows/publish-must-gather.yaml

@@ -1,4 +1,4 @@
-name: "Publish Python Auto-Instrumentation"
+name: "Publish must-gather image"
 
 on:
   push:
@@ -24,11 +24,6 @@ jobs:
       - name: Unshallow
         run: git fetch --prune --unshallow
 
-      - name: Set env vars for the job
-        run: |
-          echo "VERSION_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
-          echo "VERSION=$(git describe --tags | sed 's/^v//')" >> $GITHUB_ENV
-
       - name: Build the binary for each supported architecture
         run: |
           for platform in $(echo $PLATFORMS | tr "," "\n"); do
@@ -42,7 +37,6 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            otel/opentelemetry-operator-must-gather
             ghcr.io/open-telemetry/opentelemetry-operator/must-gather
           tags: |
             type=semver,pattern={{version}}

cmd/gather/README.md

@@ -19,18 +19,18 @@ To run the must-gather tool for the OpenTelemetry Operator, use one of the follo
 
 ### Using the image from the Operator deployment
 
+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=<must-gather-image> -- /usr/bin/must-gather --operator-namespace opentelemetry-operator-system
+oc adm must-gather --image=ghcr.io/open-telemetry/opentelemetry-operator/must-gather -- /usr/bin/must-gather --operator-namespace opentelemetry-operator-system
 ```
 
 ### Using it as a CLI
 
 You only need to build and run:
 ```sh
 make must-gather
-./bin/must-gather --help
+./bin/must-gather_$(go env GOARCH) --help
 ```
-
-This is the recommended way to do it if you are not using OpenShift.