Helm

 

kubernetes.helm.releases
DescriptionAttribute set of helm releases
Type
attribute set of (submodule)
Default
{ }
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.apiVersions
DescriptionInform Helm about which CRDs are available in the cluster (`--api-versions` option). This is useful for charts which contain `.Capabilities.APIVersions.Has` checks. If you use `kubernetes.customTypes` to make kubenix aware of CRDs, it will include those as well by default.
Type
list of string
Default
[ ]
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.chart
DescriptionHelm chart to use
Type
package
Default
 
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.includeCRDs
DescriptionWhether to include CRDs.

Warning: Always including CRDs here is dangerous and can break CRs in your cluster as CRDs may be updated unintentionally. An interactive `helm install` NEVER updates CRDs, only installs them when they are not existing. See https://github.com/helm/community/blob/aa8e13054d91ee69857b13149a9652be09133a61/hips/hip-0011.md

Only set this to true if you know what you are doing and are manually checking the included CRDs for breaking changes whenever updating the Helm chart.
Type
boolean
Default
false
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.kubeVersion
DescriptionKubernetes version to build chart for
Type
string
Default
"1.30"
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.name
DescriptionHelm release name
Type
string
Default
"‹name›"
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.namespace
DescriptionNamespace to install helm chart to
Type
null or string
Default
null
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.noHooks
DescriptionWether to include Helm hooks.

Without this all hooks run immediately on apply since we are bypassing the Helm CLI. However, some charts only have minor validation hooks (e.g., upgrade version skew validation) and are safe to ignore.
Type
boolean
Default
false
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.objects
DescriptionGenerated kubernetes objects
Type
list of (attribute set)
Default
[ ]
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.overrideNamespace
DescriptionWhether to apply namespace override
Type
boolean
Default
true
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.overrides
DescriptionOverrides to apply to all chart resources
Type
list of unspecified value
Default
[ ]
Declared inmodules/helm.nix
kubernetes.helm.releases.<name>.values
DescriptionValues to pass to chart
Type
recursive attribute set
Default
{ }
Declared inmodules/helm.nix