README.md.gotmpl

# 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 redhat-developer-hub-must-gather \
  --repo https://redhat-developer.github.io/rhdh-chart \
  --version {{ template "chart.version" . }} \
  [--wait --timeout=$duration]
```

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.

When using `--wait`, the `helm` command will return only when the `gather` init container has finished or the specified timeout has elapsed.

Note that the default Helm timeout when using `--wait` is **5m** (5 minutes), which may be too short for the RHDH must-gather to finish collecting diagnostic data.
Feel free to adjust accordingly.

## 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" . }}