Troubleshoot helpers for Helm release install/upgrade failures #5101
Labels
area/helm
Helm related issues and pull requests
area/ux
In pursuit of a delightful user experience
umbrella-issue
Umbrella issue for tracking progress of a larger effort
To help users troubleshoot
HelmRelease
install and upgrade failures, we could add a new CLI command dedicated for debugging.Specification
Introduce a new command called
flux debug helmrelease
that would help solve fluxcd/helm-controller#497Debug values composition
The
flux debug helmrelease <name> --show-values
command could be used to print the final values by merging theHelmRelease
inline values from.spec.values
with the values coming from Kubernetes ConfigMaps/Secrets specified in.spec.valuesFrom
. This command could help users debug failed releases by allowing them to export the final values from cluster into a local file. Using the final values, users can run locallyhelm template --values in-cluster-values.yaml
and inspect the resulting resources.Note that the exported values may contain sensitive information extracted from Kubernetes Secrets, this should be highlighted in the command help docs to make users aware of the implications of running this command on untrusted machines. Give that the Flux CLI uses the local kubeConfig, only users with read access to the secrets will be able to run the debug command.
Debug current status
The
flux debug helmrelease <name> --show-status
command can be used to print the release status along with the upgrade history, conditions and errors messages. This command could help users debug failed releases by inspecting the status sub-resource which contains rich informations about a HelmRelease compared to theflux get helmreleaase
command which only displays the Ready condition message.Implementation
fluxcd/pkg/chartutil
fluxcd/pkg/chartutil
flux debug helmreleaase --show-values
using the shared package fromfluxcd/pkg/chartutil
flux debug helmreleaase --show-status
PS. Refactoring the chartutil into a shared package is the first step towards
flux build helmrelease
.The text was updated successfully, but these errors were encountered: