diff --git a/charts/must-gather/Chart.yaml b/charts/must-gather/Chart.yaml index e834306b..557edadb 100644 --- a/charts/must-gather/Chart.yaml +++ b/charts/must-gather/Chart.yaml @@ -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 diff --git a/charts/must-gather/README.md b/charts/must-gather/README.md index 45e5a397..4ac87dab 100644 --- a/charts/must-gather/README.md +++ b/charts/must-gather/README.md @@ -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 @@ -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. diff --git a/charts/must-gather/README.md.gotmpl b/charts/must-gather/README.md.gotmpl index 64f0ceb4..45df3a8f 100644 --- a/charts/must-gather/README.md.gotmpl +++ b/charts/must-gather/README.md.gotmpl @@ -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.