Skip to content

docs(must-gather): update instructions with the wait and timeout options #361

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.

Sign up for GitHub

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 1 commit into from
Apr 17, 2026
+16 −4
Merged

docs(must-gather): update instructions with the wait and timeout options #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/must-gather/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ maintainers:
# 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.4.0
version: 0.5.0
10 changes: 8 additions & 2 deletions charts/must-gather/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Must Gather Chart for Red Hat Developer Hub (RHDH)

![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square)
![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square)
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A Helm chart for running the RHDH Must-Gather diagnostic tool on Kubernetes
Expand All @@ -27,13 +27,19 @@ Kubernetes: `>= 1.27.0-0`
```console
helm upgrade --install my-rhdh-must-gather redhat-developer-hub-must-gather \
--repo https://redhat-developer.github.io/rhdh-chart \
--version 0.4.0
--version 0.5.0 \
[--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.
Expand Down
8 changes: 7 additions & 1 deletion charts/must-gather/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,19 @@
```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" . }}
--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.
Expand Down
Loading