feat(must-gather): add new Chart for the RHDH Must-Gather tool [RHIDP-12626] #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

openshift-merge-bot merged 36 commits into redhat-developer:main from rm3l:rhidp-12626-add-new-helm-chart-for-rhdh-must-gather-for-easier-consumption-against-supported-non-ocp-platforms

Mar 31, 2026

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ @@
     .LSOverride
     .idea
+    *.tar.gz
     # helm chart dependencies
     charts/*/charts/
     **/charts/*.tgz
@@ Expand Down @@

charts/must-gather/.helmignore

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    # Patterns to ignore when building packages.
+    # This supports shell glob matching, relative path matching, and
+    # negation (prefixed with !). Only one pattern per line.
+    .DS_Store
+    # Common VCS dirs
+    .git/
+    .gitignore
+    .bzr/
+    .bzrignore
+    .hg/
+    .hgignore
+    .svn/
+    # Common backup files
+    *.swp
+    *.bak
+    *.tmp
+    *.orig
+    *~
+    # Various IDEs
+    .project
+    .idea/
+    *.tmproj
+    .vscode/

charts/must-gather/Chart.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,38 @@
+    annotations:
+      charts.openshift.io/name: Red Hat Developer Hub Must Gather
+      charts.openshift.io/provider: Red Hat
+      charts.openshift.io/archs: x86_64
+      charts.openshift.io/supportURL: https://access.redhat.com/support
+    apiVersion: v2
+    name: rhdh-must-gather
+    description: |
+      A Helm chart for deploying the RHDH Must-Gather diagnostic tool on Kubernetes
+    type: application
+    # Application version - matches the must-gather tool version
+    appVersion: "0.2.0"
+    keywords:
+      - rhdh
+      - red-hat-developer-hub
+      - backstage
+      - diagnostics
+      - must-gather
+      - troubleshooting
+    home: https://github.com/redhat-developer/rhdh-must-gather
+    sources:
+      - https://github.com/redhat-developer/rhdh-must-gather
+    kubeVersion: ">= 1.27.0-0"
+    maintainers:
+      - name: Red Hat
+        url: https://redhat.com
+    # This is the chart version. This version number should be incremented each time you make changes
+    # to the chart and its templates, including the app version.
+    # Versions are expected to follow Semantic Versioning (https://semver.org/)
+    # Note that when this chart is published to https://github.com/openshift-helm-charts/charts
+    # it will follow the RHDH versioning 1.y.z
+    version: 0.1.0

charts/must-gather/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,151 @@
+    # Must Gather Chart for Red Hat Developer Hub (RHDH)
+    ![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square)
+    ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+    A Helm chart for deploying the RHDH Must-Gather diagnostic tool on Kubernetes
+    **Homepage:** <https://github.com/redhat-developer/rhdh-must-gather>
+    ## Maintainers
+    | Name | Email | Url |
+    | ---- | ------ | --- |
+    | Red Hat |  | <https://redhat.com> |
+    ## Source Code
+    * <https://github.com/redhat-developer/rhdh-must-gather>
+    ## Requirements
+    Kubernetes: `>= 1.27.0-0`
+    ## TL;DR
+    ```console
+    helm upgrade --install my-rhdh-must-gather rhdh-must-gather \
+      --repo https://redhat-developer.github.io/rhdh-chart \
+      --version 0.1.0
+    ```
+    Running the command again will automatically replace the previous pod and start a new gather.
+    Then follow the instructions that will be printed to retrieve the gathered data.
+    ## Running on OpenShift
+    This chart works on both Kubernetes and OpenShift.
+    But for OpenShift, we recommend using the `oc adm must-gather` command, like so:
+    ```sh
+    oc adm must-gather --image=quay.io/rhdh-community/rhdh-must-gather
+    ```
+    See the [must-gather tool README](https://github.com/redhat-developer/rhdh-must-gather#for-openshift-clusters) for more details.
+    ## Testing a Release
+    Once a Helm Release has been deployed, you can test it using the [`helm test`](https://helm.sh/docs/helm/helm_test/) command:
+    ```sh
+    helm test <release_name>
+    ```
+    This will run a simple Pod in the cluster to check that the required resources have been created.
+    You can control whether to disable this test pod or you can also customize the image it leverages.
+    See the `test.enabled` and `test.image` parameters in the [`values.yaml`](./values.yaml) file.
+    > **Tip**: Disabling the test pod will not prevent the `helm test` command from passing later on. It will simply report that no test suite is available.
+    Below are a few examples:
+    <details>
+    <summary>Disabling the test pod</summary>
+    ```sh
+    helm install <release_name> <repo> \
+      --set test.enabled=false
+    ```
+    </details>
+    <details>
+    <summary>Customizing the test pod image</summary>
+    ```sh
+    helm install <release_name> <repo> \
+      --set test.image.registry=docker.io \
+      --set test.image.repository=bitnami/kubectl \
+      --set test.image.tag=1.30.0
+    ```
+    </details>
+    ## Uninstalling the Chart
+    To uninstall/delete a Helm release named `my-rhdh-must-gather`:
+    ```console
+    helm uninstall my-rhdh-must-gather
+    ```
+    The command removes all the Kubernetes resources associated with the chart and deletes the release.
+    ## Values
+    | Key | Description | Type | Default |
+    |-----|-------------|------|---------|
+    | affinity | Affinity rules for pod scheduling | object | `{}` |
+    | dataHolder | Runs alongside the gather container and stays alive so you can exec in and retrieve the output. | object | `{"resources":{"limits":{"cpu":"100m","ephemeral-storage":"64Mi","memory":"128Mi"},"requests":{"cpu":"50m","ephemeral-storage":"32Mi","memory":"64Mi"}}}` |
+    | dataHolder.resources | Resource requests and limits for the data-holder container | object | `{"limits":{"cpu":"100m","ephemeral-storage":"64Mi","memory":"128Mi"},"requests":{"cpu":"50m","ephemeral-storage":"32Mi","memory":"64Mi"}}` |
+    | fullnameOverride |  | string | `""` |
+    | gather | Gather script configuration | object | `{"clusterInfo":false,"cmdTimeout":"30","extraArgs":[],"logLevel":"info","namespaces":[],"since":"","sinceTime":"","withHeapDumps":false,"withHelm":true,"withIngress":true,"withNamespaceInspect":true,"withOperator":true,"withOrchestrator":true,"withPlatform":true,"withRoute":true,"withSecrets":false}` |
+    | gather.cmdTimeout | Command timeout for individual kubectl/helm commands (seconds) | string | `"30"` |
+    | gather.extraArgs | Additional custom arguments to pass to the gather script | list | `[]` |
+    | gather.logLevel | Log level: info, INFO, debug, DEBUG, trace, TRACE | string | `"info"` |
+    | gather.namespaces | Example: ["rhdh-prod", "rhdh-staging"] | list | `[]` |
+    | gather.since | Relative time for log collection (e.g., "2h", "30m") | string | `""` |
+    | gather.sinceTime | Absolute timestamp for log collection (RFC3339 format) | string | `""` |
+    | gather.withOperator | Collection features (enabled by default; set to false to skip) | bool | `true` |
+    | gather.withSecrets | Optional collection features (disabled by default) | bool | `false` |
+    | image | Container image configuration | object | `{"digest":"","pullPolicy":"","registry":"quay.io","repository":"rhdh-community/rhdh-must-gather","tag":"latest"}` |
+    | image.digest | Image digest (e.g., sha256:abc123...). Can be used with or without tag. | string | `""` |
+    | image.tag | Overrides the image tag whose default is the chart appVersion. | string | `"latest"` |
+    | imagePullSecrets | Secrets for pulling images from a private registry | list | `[]` |
+    | nameOverride | Override the chart name | string | `""` |
+    | nodeSelector | Node selector for pod scheduling | object | `{}` |
+    | persistence | Persistent volume configuration for storing gathered data | object | `{"accessMode":"ReadWriteOnce","size":"1Gi","storageClass":""}` |
+    | persistence.accessMode | Access mode | string | `"ReadWriteOnce"` |
+    | persistence.size | Storage size | string | `"1Gi"` |
+    | persistence.storageClass | Storage class (empty = use cluster default) | string | `""` |
+    | podAnnotations | Pod annotations | object | `{}` |
+    | podLabels | Pod labels | object | `{}` |
+    | podSecurityContext | Pod security context | object | `{"runAsNonRoot":true,"seccompProfile":{"type":"RuntimeDefault"}}` |
+    | rbac | RBAC configuration | object | `{"create":true,"rules":{"backstages":true,"ingresses":true,"knative":true,"olm":true,"platform":true,"routes":true,"sonataflow":true},"scope":"cluster"}` |
+    | rbac.create | Create RBAC resources (Role/ClusterRole and bindings) | bool | `true` |
+    | rbac.rules | a rule here does not require disabling the corresponding gather.with* flag. | object | `{"backstages":true,"ingresses":true,"knative":true,"olm":true,"platform":true,"routes":true,"sonataflow":true}` |
+    | rbac.rules.backstages | rhdh.redhat.com — Backstage custom resources | bool | `true` |
+    | rbac.rules.ingresses | networking.k8s.io — Ingresses, NetworkPolicies | bool | `true` |
+    | rbac.rules.knative | operator.knative.dev, operator.serverless.openshift.io — Knative/Serverless | bool | `true` |
+    | rbac.rules.olm | operators.coreos.com — OLM resources (subscriptions, CSVs, etc.) | bool | `true` |
+    | rbac.rules.platform | config.openshift.io — ClusterVersions, Infrastructures (cluster scope only) | bool | `true` |
+    | rbac.rules.routes | route.openshift.io — OpenShift Routes | bool | `true` |
+    | rbac.rules.sonataflow | sonataflow.org — SonataFlow custom resources | bool | `true` |
+    | resources | Resource requests and limits for the gather container | object | `{"limits":{"cpu":"500m","ephemeral-storage":"128Mi","memory":"512Mi"},"requests":{"cpu":"100m","ephemeral-storage":"64Mi","memory":"128Mi"}}` |
+    | securityContext | Container security context | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]}}` |
+    | serviceAccount | Service account configuration | object | `{"annotations":{},"name":"","tokenExpirationSeconds":3600}` |
+    | serviceAccount.annotations | Annotations to add to the service account | object | `{}` |
+    | serviceAccount.name | If not set, a name is generated using the fullname template. | string | `""` |
+    | serviceAccount.tokenExpirationSeconds | into the gather init container (minimum 600). | int | `3600` |
+    | strategy | Deployment strategy | object | `{"type":"Recreate"}` |
+    | test | Helm test configuration | object | `{"enabled":true,"image":{"digest":"","pullPolicy":"","registry":"docker.io","repository":"bitnami/kubectl","tag":"latest"}}` |
+    | test.enabled | Enable the Helm test | bool | `true` |
+    | test.image | Image for the test pod | object | `{"digest":"","pullPolicy":"","registry":"docker.io","repository":"bitnami/kubectl","tag":"latest"}` |
+    | tolerations | Tolerations for pod scheduling | list | `[]` |

charts/must-gather/README.md.gotmpl

-Original file line number
+Diff line change
@@ -0,0 +1,93 @@
+    # Must Gather Chart for Red Hat Developer Hub (RHDH)
+    {{ template "chart.deprecationWarning" . }}
+    {{ template "chart.versionBadge" . }}
+    {{ template "chart.typeBadge" . }}
+    {{ template "chart.description" . }}
+    {{ template "chart.homepageLine" . }}
+    {{ template "chart.maintainersSection" . }}
+    {{ template "chart.sourcesSection" . }}
+    {{ template "chart.requirementsSection" . }}
+    ## TL;DR
+    ```console
+    helm upgrade --install my-rhdh-must-gather rhdh-must-gather \
+      --repo https://redhat-developer.github.io/rhdh-chart \
+      --version {{ template "chart.version" . }}
+    ```
+    Running the command again will automatically replace the previous pod and start a new gather.
+    Then follow the instructions that will be printed to retrieve the gathered data.
+    ## Running on OpenShift
+    This chart works on both Kubernetes and OpenShift.
+    But for OpenShift, we recommend using the `oc adm must-gather` command, like so:
+    ```sh
+    oc adm must-gather --image=quay.io/rhdh-community/rhdh-must-gather
+    ```
+    See the [must-gather tool README](https://github.com/redhat-developer/rhdh-must-gather#for-openshift-clusters) for more details.
+    ## Testing a Release
+    Once a Helm Release has been deployed, you can test it using the [`helm test`](https://helm.sh/docs/helm/helm_test/) command:
+    ```sh
+    helm test <release_name>
+    ```
+    This will run a simple Pod in the cluster to check that the required resources have been created.
+    You can control whether to disable this test pod or you can also customize the image it leverages.
+    See the `test.enabled` and `test.image` parameters in the [`values.yaml`](./values.yaml) file.
+    > **Tip**: Disabling the test pod will not prevent the `helm test` command from passing later on. It will simply report that no test suite is available.
+    Below are a few examples:
+    <details>
+    <summary>Disabling the test pod</summary>
+    ```sh
+    helm install <release_name> <repo> \
+      --set test.enabled=false
+    ```
+    </details>
+    <details>
+    <summary>Customizing the test pod image</summary>
+    ```sh
+    helm install <release_name> <repo> \
+      --set test.image.registry=docker.io \
+      --set test.image.repository=bitnami/kubectl \
+      --set test.image.tag=1.30.0
+    ```
+    </details>
+    ## Uninstalling the Chart
+    To uninstall/delete a Helm release named `my-rhdh-must-gather`:
+    ```console
+    helm uninstall my-rhdh-must-gather
+    ```
+    The command removes all the Kubernetes resources associated with the chart and deletes the release.
+    {{ template "chart.valuesSection" . }}

charts/must-gather/ci/default-values.yaml

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		# Default values — tests the chart with all defaults

charts/must-gather/ci/with-minimal-collection-values.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    # Minimal collection — skip optional components to speed up gathering
+    gather:
+      withOperator: false
+      withOrchestrator: false
+      withHelm: false
+      withRoute: false
+      withIngress: false
+      logLevel: "TRACE"

charts/must-gather/ci/with-namespace-rbac-values.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    # Namespace-scoped RBAC — creates a Role instead of a ClusterRole.
+    # Collection is restricted to the release namespace only;
+    # gather.namespaces is ignored in this mode.
+    rbac:
+      scope: namespace
+    gather:
+      # NOTE: this field will be ignored when rbac.scope is "namespace".
+      namespaces:
+        - "kube-system"

charts/must-gather/ci/with-namespace-scoped-values.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,6 @@
+    # Scope collection to specific namespaces
+    gather:
+      namespaces:
+        - "rhdh-prod"
+        - "rhdh-staging"
+      since: "2h"

charts/must-gather/ci/with-secrets-and-cluster-info-values.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    # Collect secrets (sanitized) and cluster-level info
+    gather:
+      withSecrets: true
+      clusterInfo: true
+      logLevel: "DEBUG"

charts/must-gather/ci/with-test-disabled-values.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    # Helm test disabled
+    test:
+      enabled: false

charts/must-gather/templates/NOTES.txt

-Original file line number
+Diff line change
@@ -0,0 +1,32 @@
+    -------------------------------------------------------------------
+    RHDH Must-Gather is now running. This might take a few minutes.
+    To check the gather logs:
+       kubectl -n {{ .Release.Namespace }} logs -l app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=gather -c gather -f
+    To retrieve the gathered diagnostic data once the gather completes:
+. Wait for the pod to be ready (gather init container completed):
+       kubectl -n {{ .Release.Namespace }} wait --for=condition=ready pod -l app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=gather --timeout=3600s
+. Download the gathered data from the data-holder container:
+       kubectl -n {{ .Release.Namespace }} exec deploy/{{ include "rhdh-must-gather.fullname" . }} -c data-holder -- tar czf - -C /must-gather . > rhdh-must-gather-output.tar.gz
+    To clean up the must-gather resources:
+       helm uninstall {{ .Release.Name }} -n {{ .Release.Namespace }}
+    Configuration used:
+      - Log level: {{ .Values.gather.logLevel | lower }}
+      - Storage size: {{ .Values.persistence.size }}
+    {{- if .Values.gather.namespaces }}
+      - Target namespaces: {{ .Values.gather.namespaces | join ", " }}
+    {{- end }}
+    {{- if .Values.gather.withSecrets }}
+      - Secrets collection: enabled (sanitized)
+    {{- end }}
+    {{- if .Values.gather.withHeapDumps }}
+      - Heap dump collection: enabled
+    {{- end }}
+    For more information, visit: https://github.com/redhat-developer/rhdh-must-gather
+    -------------------------------------------------------------------

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(must-gather): add new Chart for the RHDH Must-Gather tool [RHIDP-12626] #326

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!