HelmRelease API reference

APIVersion of the referent.

Kind of the referent.

Name of the referent.

Namespace of the referent.

ObjectMeta holds the template for metadata like labels and annotations.

Spec holds the template for the v1beta2.HelmChartSpec for this HelmRelease.

Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

The name or path the Helm chart is available at in the SourceRef.

Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted.

The name and namespace of the v1beta2.Source the chart is available at.

Interval at which to check the v1beta2.Source for updates. Defaults to ‘HelmReleaseSpec.Interval’.

Determines what enables the creation of a new artifact. Valid values are (‘ChartVersion’, ‘Revision’). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.

Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted.

Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted.

Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic. This field is only supported for OCI sources. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified.

Provider specifies the technology used to sign the OCI Helm chart.

SecretRef specifies the Kubernetes Secret containing the trusted public keys.

Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease.

Interval at which to reconcile the Helm release.

KubeConfig for reconciling the HelmRelease on a remote cluster. When used in combination with HelmReleaseSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the –default-service-account flag is set, its value will be used as a controller level fallback for when HelmReleaseSpec.ServiceAccountName is empty.

Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false.

ReleaseName used for the Helm release. Defaults to a composition of ‘[TargetNamespace-]Name’.

TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease.

StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease.

DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled.

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to ‘5m0s’.

MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use ‘0’ for an unlimited number of revisions; defaults to ‘10’.

The name of the Kubernetes service account to impersonate when reconciling this HelmRelease.

PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action.

This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm’s CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks.

If not set, it defaults to true.

Install holds the configuration for Helm install actions for this HelmRelease.

Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.

Test holds the configuration for Helm test actions for this HelmRelease.

Rollback holds the configuration for Helm rollback actions for this HelmRelease.

Uninstall holds the configuration for Helm uninstall actions for this HelmRelease.

ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged.

Values holds the values for this Helm release.

PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition.

ObservedGeneration is the last observed generation.

(Members of ReconcileRequestStatus are embedded into this type.)

Conditions holds the conditions for the HelmRelease.

LastAppliedRevision is the revision of the last successfully applied source.

LastAttemptedRevision is the revision of the last reconciliation attempt.

LastAttemptedValuesChecksum is the SHA1 checksum of the values of the last reconciliation attempt.

LastReleaseRevision is the revision of the last successful Helm release.

HelmChart is the namespaced name of the HelmChart resource created by the controller for the HelmRelease.

Failures is the reconciliation failure count against the latest desired state. It is reset after a successful reconciliation.

InstallFailures is the install failure count against the latest desired state. It is reset after a successful reconciliation.

UpgradeFailures is the upgrade failure count against the latest desired state. It is reset after a successful reconciliation.

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm install action. Defaults to ‘HelmReleaseSpec.Timeout’.

Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action.

DisableWait disables the waiting for resources to be ready after a Helm install has been performed.

DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed.

DisableHooks prevents hooks from running during the Helm install action.

DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema.

Replace tells the Helm install action to re-use the ‘ReleaseName’, but only if that name is a deleted release which remains in the history.

SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present.

Deprecated use CRD policy (crds) attribute with value Skip instead.

CRDs upgrade CRDs from the Helm Chart’s crds directory according to the CRD upgrade policy provided here. Valid values are Skip, Create or CreateReplace. Default is Create and if omitted CRDs are installed but not updated.

Skip: do neither install nor replace (update) any CRDs.

Create: new CRDs are created, existing CRDs are neither updated nor deleted.

CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted.

By default, CRDs are applied (installed) during Helm install action. With this option users can opt-in to CRD replace existing CRDs on Helm install actions, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.

CreateNamespace tells the Helm install action to create the HelmReleaseSpec.TargetNamespace if it does not exist yet. On uninstall, the namespace will not be garbage collected.

Retries is the number of retries that should be attempted on failures before bailing. Remediation, using an uninstall, is performed between each attempt. Defaults to ‘0’, a negative integer equals to unlimited retries.

IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to ‘Test.IgnoreFailures’.

RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to ‘false’.

Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.

Strategic merge patches, defined as inline YAML objects.

JSON 6902 patches, defined as inline YAML objects.

Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.

Kustomization to apply as PostRenderer.

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm rollback action. Defaults to ‘HelmReleaseSpec.Timeout’.

DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed.

DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed.

DisableHooks prevents hooks from running during the Helm rollback action.

Recreate performs pod restarts for the resource if applicable.

Force forces resource updates through a replacement strategy.

CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails.

Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed.

Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to ‘HelmReleaseSpec.Timeout’.

IgnoreFailures tells the controller to skip remediation when the Helm tests are run but fail. Can be overwritten for tests run after install or upgrade actions in ‘Install.IgnoreTestFailures’ and ‘Upgrade.IgnoreTestFailures’.

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm uninstall action. Defaults to ‘HelmReleaseSpec.Timeout’.

DisableHooks prevents hooks from running during the Helm rollback action.

KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history.

DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed.

DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed.

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm upgrade action. Defaults to ‘HelmReleaseSpec.Timeout’.

Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action.

DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed.

DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed.

DisableHooks prevents hooks from running during the Helm upgrade action.

DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema.

Force forces resource updates through a replacement strategy.

PreserveValues will make Helm reuse the last release’s values and merge in overrides from ‘Values’. Setting this flag makes the HelmRelease non-declarative.

CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails.

CRDs upgrade CRDs from the Helm Chart’s crds directory according to the CRD upgrade policy provided here. Valid values are Skip, Create or CreateReplace. Default is Skip and if omitted CRDs are neither installed nor upgraded.

Skip: do neither install nor replace (update) any CRDs.

Create: new CRDs are created, existing CRDs are neither updated nor deleted.

CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted.

By default, CRDs are not applied during Helm upgrade action. With this option users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.

Retries is the number of retries that should be attempted on failures before bailing. Remediation, using ‘Strategy’, is performed between each attempt. Defaults to ‘0’, a negative integer equals to unlimited retries.

IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to ‘Test.IgnoreFailures’.

RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to ‘false’ unless ‘Retries’ is greater than 0.

Strategy to use for failure remediation. Defaults to ‘rollback’.

Kind of the values referent, valid values are (‘Secret’, ‘ConfigMap’).

Name of the values referent. Should reside in the same namespace as the referring resource.

ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to ‘values.yaml’. When set, must be a valid Data Key, consisting of alphanumeric characters, ‘-’, ‘_’ or ‘.’.

TargetPath is the YAML dot notation path the value should be merged at. When set, the ValuesKey is expected to be a single flat value. Defaults to ‘None’, which results in the values getting merged at the root.

Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.