HelmRelease API reference

Packages:

helm.toolkit.fluxcd.io/v2beta1

Package v2beta1 contains API Schema definitions for the helm v2beta1 API group

Resource Types:

HelmRelease

HelmRelease is the Schema for the helmreleases API

Field Description
apiVersion
string
helm.toolkit.fluxcd.io/v2beta1
kind
string
HelmRelease
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
HelmReleaseSpec


chart
HelmChartTemplate

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

interval
Kubernetes meta/v1.Duration

Interval at which to reconcile the Helm release.

kubeConfig
KubeConfig
(Optional)

KubeConfig for reconciling the HelmRelease on a remote cluster.

suspend
bool
(Optional)

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

releaseName
string
(Optional)

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

targetNamespace
string
(Optional)

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

dependsOn
[]Runtime dependency.CrossNamespaceDependencyReference
(Optional)

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

timeout
Kubernetes meta/v1.Duration
(Optional)

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
int
(Optional)

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

install
Install
(Optional)

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

upgrade
Upgrade
(Optional)

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

test
Test
(Optional)

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

rollback
Rollback
(Optional)

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

uninstall
Uninstall
(Optional)

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

valuesFrom
[]ValuesReference

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

values
Kubernetes pkg/apis/apiextensions/v1.JSON
(Optional)

Values holds the values for this Helm release.

status
HelmReleaseStatus

CrossNamespaceObjectReference

(Appears on: HelmChartTemplateSpec)

CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level.

Field Description
apiVersion
string
(Optional)

APIVersion of the referent.

kind
string

Kind of the referent.

name
string

Name of the referent.

namespace
string
(Optional)

Namespace of the referent.

DeploymentAction

DeploymentAction defines a consistent interface for Install and Upgrade.

HelmChartTemplate

(Appears on: HelmReleaseSpec)

HelmChartTemplate defines the template from which the controller will generate a v1beta1.HelmChart object in the same namespace as the referenced v1beta1.Source.

Field Description
spec
HelmChartTemplateSpec

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



chart
string

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

version
string
(Optional)

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

sourceRef
CrossNamespaceObjectReference

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

interval
Kubernetes meta/v1.Duration
(Optional)

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

valuesFile
string
(Optional)

Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Ignored when omitted.

HelmChartTemplateSpec

(Appears on: HelmChartTemplate)

HelmChartTemplateSpec defines the template from which the controller will generate a v1beta1.HelmChartSpec object.

Field Description
chart
string

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

version
string
(Optional)

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

sourceRef
CrossNamespaceObjectReference

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

interval
Kubernetes meta/v1.Duration
(Optional)

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

valuesFile
string
(Optional)

Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Ignored when omitted.

HelmReleaseSpec

(Appears on: HelmRelease)

HelmReleaseSpec defines the desired state of a Helm release.

Field Description
chart
HelmChartTemplate

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

interval
Kubernetes meta/v1.Duration

Interval at which to reconcile the Helm release.

kubeConfig
KubeConfig
(Optional)

KubeConfig for reconciling the HelmRelease on a remote cluster.

suspend
bool
(Optional)

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

releaseName
string
(Optional)

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

targetNamespace
string
(Optional)

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

dependsOn
[]Runtime dependency.CrossNamespaceDependencyReference
(Optional)

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

timeout
Kubernetes meta/v1.Duration
(Optional)

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
int
(Optional)

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

install
Install
(Optional)

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

upgrade
Upgrade
(Optional)

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

test
Test
(Optional)

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

rollback
Rollback
(Optional)

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

uninstall
Uninstall
(Optional)

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

valuesFrom
[]ValuesReference

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

values
Kubernetes pkg/apis/apiextensions/v1.JSON
(Optional)

Values holds the values for this Helm release.

HelmReleaseStatus

(Appears on: HelmRelease)

HelmReleaseStatus defines the observed state of a HelmRelease.

Field Description
observedGeneration
int64
(Optional)

ObservedGeneration is the last observed generation.

ReconcileRequestStatus
github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

(Members of ReconcileRequestStatus are embedded into this type.)

conditions
[]github.com/fluxcd/pkg/apis/meta.Condition
(Optional)

Conditions holds the conditions for the HelmRelease.

lastAppliedRevision
string
(Optional)

LastAppliedRevision is the revision of the last successfully applied source.

lastAttemptedRevision
string
(Optional)

LastAttemptedRevision is the revision of the last reconciliation attempt.

lastAttemptedValuesChecksum
string
(Optional)

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

lastReleaseRevision
int
(Optional)

LastReleaseRevision is the revision of the last successful Helm release.

helmChart
string
(Optional)

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

failures
int64
(Optional)

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

installFailures
int64
(Optional)

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

upgradeFailures
int64
(Optional)

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

Install

(Appears on: HelmReleaseSpec)

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

Field Description
timeout
Kubernetes meta/v1.Duration
(Optional)

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
InstallRemediation
(Optional)

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

disableWait
bool
(Optional)

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

disableHooks
bool
(Optional)

DisableHooks prevents hooks from running during the Helm install action.

disableOpenAPIValidation
bool
(Optional)

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

replace
bool
(Optional)

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
bool
(Optional)

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

InstallRemediation

(Appears on: Install)

InstallRemediation holds the configuration for Helm install remediation.

Field Description
retries
int
(Optional)

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
bool
(Optional)

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

remediateLastFailure
bool
(Optional)

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

KubeConfig

(Appears on: HelmReleaseSpec)

KubeConfig references a Kubernetes secret that contains a kubeconfig file.

Field Description
secretRef
Kubernetes core/v1.LocalObjectReference

SecretRef holds the name to a secret that contains a ‘value’ key with the kubeconfig file as the value. It must be in the same namespace as the HelmRelease. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific cmd-path auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling the HelmRelease.

Remediation

Remediation defines a consistent interface for InstallRemediation and UpgradeRemediation.

RemediationStrategy (string alias)

(Appears on: UpgradeRemediation)

RemediationStrategy returns the strategy to use to remediate a failed install or upgrade.

Rollback

(Appears on: HelmReleaseSpec)

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

Field Description
timeout
Kubernetes meta/v1.Duration
(Optional)

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
bool
(Optional)

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

disableHooks
bool
(Optional)

DisableHooks prevents hooks from running during the Helm rollback action.

recreate
bool
(Optional)

Recreate performs pod restarts for the resource if applicable.

force
bool
(Optional)

Force forces resource updates through a replacement strategy.

cleanupOnFail
bool
(Optional)

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

Test

(Appears on: HelmReleaseSpec)

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

Field Description
enable
bool
(Optional)

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

timeout
Kubernetes meta/v1.Duration
(Optional)

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

ignoreFailures
bool
(Optional)

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’.

Uninstall

(Appears on: HelmReleaseSpec)

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

Field Description
timeout
Kubernetes meta/v1.Duration
(Optional)

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
bool
(Optional)

DisableHooks prevents hooks from running during the Helm rollback action.

keepHistory
bool
(Optional)

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

Upgrade

(Appears on: HelmReleaseSpec)

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

Field Description
timeout
Kubernetes meta/v1.Duration
(Optional)

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
UpgradeRemediation
(Optional)

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

disableWait
bool
(Optional)

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

disableHooks
bool
(Optional)

DisableHooks prevents hooks from running during the Helm upgrade action.

disableOpenAPIValidation
bool
(Optional)

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

force
bool
(Optional)

Force forces resource updates through a replacement strategy.

preserveValues
bool
(Optional)

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
bool
(Optional)

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

UpgradeRemediation

(Appears on: Upgrade)

UpgradeRemediation holds the configuration for Helm upgrade remediation.

Field Description
retries
int
(Optional)

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
bool
(Optional)

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

remediateLastFailure
bool
(Optional)

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

strategy
RemediationStrategy
(Optional)

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

ValuesReference

(Appears on: HelmReleaseSpec)

ValuesReference contains a reference to a resource containing Helm values, and optionally the key they can be found at.

Field Description
kind
string

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

name
string

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

valuesKey
string
(Optional)

ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to ‘values.yaml’.

targetPath
string
(Optional)

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
bool
(Optional)

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.

This page was automatically generated with gen-crd-api-reference-docs