fluxcd
/
helm-controller
mirror of https://github.com/fluxcd/helm-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
helm-controller/docs/api/v2/helm.md

59 KiB
Raw Blame History

Helm API reference v2

Packages:

helm.toolkit.fluxcd.io/v2

Package v2 contains API Schema definitions for the helm v2beta2 API group

Resource Types:

HelmRelease

HelmRelease is the Schema for the helmreleases API

Field Description
apiVersion
string		 helm.toolkit.fluxcd.io/v2
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 		(Optional)

Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease.
chartRef
CrossNamespaceSourceReference 		(Optional)

ChartRef holds a reference to a source controller resource containing the Helm chart artifact.
interval
Kubernetes meta/v1.Duration

Interval at which to reconcile the Helm release.
kubeConfig
github.com/fluxcd/pkg/apis/meta.KubeConfigReference 		(Optional)

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
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.
storageNamespace
string 		(Optional)

StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease.
dependsOn
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference 		(Optional)

DependsOn may contain a meta.NamespacedObjectReference 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 ‘5’.
serviceAccountName
string 		(Optional)

The name of the Kubernetes service account to impersonate when reconciling this HelmRelease.
persistentClient
bool 		(Optional)

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.
driftDetection
DriftDetection 		(Optional)

DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster.
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.
postRenderers
[]PostRenderer 		(Optional)

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

CRDsPolicy (string alias)

(Appears on: Install, Upgrade)

CRDsPolicy defines the install/upgrade approach to use for CRDs when installing or upgrading a HelmRelease.

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.

CrossNamespaceSourceReference

(Appears on: HelmReleaseSpec)

CrossNamespaceSourceReference 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, defaults to the namespace of the Kubernetes resource object that contains the reference.

DriftDetection

(Appears on: HelmReleaseSpec)

DriftDetection defines the strategy for performing differential analysis and provides a way to define rules for ignoring specific changes during this process.

Field Description
mode
DriftDetectionMode 		(Optional)

Mode defines how differences should be handled between the Helm manifest and the manifest currently applied to the cluster. If not explicitly set, it defaults to DiffModeDisabled.
ignore
[]IgnoreRule 		(Optional)

Ignore contains a list of rules for specifying which changes to ignore during diffing.

DriftDetectionMode (string alias)

(Appears on: DriftDetection)

DriftDetectionMode represents the modes in which a controller can detect and handle differences between the manifest in the Helm storage and the resources currently existing in the cluster.

Filter

(Appears on: Test)

Filter holds the configuration for individual Helm test filters.

Field Description
name
string

Name is the name of the test.
exclude
bool 		(Optional)

Exclude specifies whether the named test should be excluded.

HelmChartTemplate

(Appears on: HelmReleaseSpec)

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

Field Description
metadata
HelmChartTemplateObjectMeta 		(Optional)

ObjectMeta holds the template for metadata like labels and annotations.
spec
HelmChartTemplateSpec

Spec holds the template for the v1beta2.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 v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted.
sourceRef
CrossNamespaceObjectReference

The name and namespace of the v1.Source the chart is available at.
interval
Kubernetes meta/v1.Duration 		(Optional)

Interval at which to check the v1.Source for updates. Defaults to ‘HelmReleaseSpec.Interval’.
reconcileStrategy
string 		(Optional)

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.
valuesFiles
[]string 		(Optional)

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.
valuesFile
string 		(Optional)

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

IgnoreMissingValuesFiles controls whether to silently ignore missing values files rather than failing.
verify
HelmChartTemplateVerification 		(Optional)

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.

HelmChartTemplateObjectMeta

(Appears on: HelmChartTemplate)

HelmChartTemplateObjectMeta defines the template for the ObjectMeta of a v1beta2.HelmChart.

Field Description
labels
map[string]string 		(Optional)

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
map[string]string 		(Optional)

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/

HelmChartTemplateSpec

(Appears on: HelmChartTemplate)

HelmChartTemplateSpec defines the template from which the controller will generate a v1beta2.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 v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted.
sourceRef
CrossNamespaceObjectReference

The name and namespace of the v1.Source the chart is available at.
interval
Kubernetes meta/v1.Duration 		(Optional)

Interval at which to check the v1.Source for updates. Defaults to ‘HelmReleaseSpec.Interval’.
reconcileStrategy
string 		(Optional)

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.
valuesFiles
[]string 		(Optional)

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.
valuesFile
string 		(Optional)

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

IgnoreMissingValuesFiles controls whether to silently ignore missing values files rather than failing.
verify
HelmChartTemplateVerification 		(Optional)

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.

HelmChartTemplateVerification

(Appears on: HelmChartTemplateSpec)

HelmChartTemplateVerification verifies the authenticity of an OCI Helm chart.

Field Description
provider
string

Provider specifies the technology used to sign the OCI Helm chart.
secretRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference 		(Optional)

SecretRef specifies the Kubernetes Secret containing the trusted public keys.

HelmReleaseSpec

(Appears on: HelmRelease)

HelmReleaseSpec defines the desired state of a Helm release.

Field Description
chart
HelmChartTemplate 		(Optional)

Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease.
chartRef
CrossNamespaceSourceReference 		(Optional)

ChartRef holds a reference to a source controller resource containing the Helm chart artifact.
interval
Kubernetes meta/v1.Duration

Interval at which to reconcile the Helm release.
kubeConfig
github.com/fluxcd/pkg/apis/meta.KubeConfigReference 		(Optional)

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
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.
storageNamespace
string 		(Optional)

StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease.
dependsOn
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference 		(Optional)

DependsOn may contain a meta.NamespacedObjectReference 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 ‘5’.
serviceAccountName
string 		(Optional)

The name of the Kubernetes service account to impersonate when reconciling this HelmRelease.
persistentClient
bool 		(Optional)

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.
driftDetection
DriftDetection 		(Optional)

DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster.
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.
postRenderers
[]PostRenderer 		(Optional)

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

HelmReleaseStatus

(Appears on: HelmRelease)

HelmReleaseStatus defines the observed state of a HelmRelease.

Field Description
observedGeneration
int64 		(Optional)

ObservedGeneration is the last observed generation.
lastAttemptedGeneration
int64 		(Optional)

LastAttemptedGeneration is the last generation the controller attempted to reconcile.
conditions
[]Kubernetes meta/v1.Condition 		(Optional)

Conditions holds the conditions for the HelmRelease.
helmChart
string 		(Optional)

HelmChart is the namespaced name of the HelmChart resource created by the controller for the HelmRelease.
storageNamespace
string 		(Optional)

StorageNamespace is the namespace of the Helm release storage for the current release.
history
Snapshots 		(Optional)

History holds the history of Helm releases performed for this HelmRelease up to the last successfully completed release.
lastAttemptedReleaseAction
ReleaseAction 		(Optional)

LastAttemptedReleaseAction is the last release action performed for this HelmRelease. It is used to determine the active remediation strategy.
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.
lastAppliedRevision
string 		(Optional)

LastAppliedRevision is the revision of the last successfully applied source. Deprecated: the revision can now be found in the History.
lastAttemptedRevision
string 		(Optional)

LastAttemptedRevision is the Source revision of the last reconciliation attempt. For OCIRepository sources, the 12 first characters of the digest are appended to the chart version e.g. “1.2.3+1234567890ab”.
lastAttemptedRevisionDigest
string 		(Optional)

LastAttemptedRevisionDigest is the digest of the last reconciliation attempt. This is only set for OCIRepository sources.
lastAttemptedValuesChecksum
string 		(Optional)

LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last reconciliation attempt. Deprecated: Use LastAttemptedConfigDigest instead.
lastReleaseRevision
int 		(Optional)

LastReleaseRevision is the revision of the last successful Helm release. Deprecated: Use History instead.
lastAttemptedConfigDigest
string 		(Optional)

LastAttemptedConfigDigest is the digest for the config (better known as “values”) of the last reconciliation attempt.
lastHandledForceAt
string 		(Optional)

LastHandledForceAt holds the value of the most recent force request value, so a change of the annotation value can be detected.
lastHandledResetAt
string 		(Optional)

LastHandledResetAt holds the value of the most recent reset request value, so a change of the annotation value can be detected.
ReconcileRequestStatus
github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

(Members of ReconcileRequestStatus are embedded into this type.)

IgnoreRule

(Appears on: DriftDetection)

IgnoreRule defines a rule to selectively disregard specific changes during the drift detection process.

Field Description
paths
[]string

Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object.
target
github.com/fluxcd/pkg/apis/kustomize.Selector 		(Optional)

Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Helm release.

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

DisableWaitForJobs disables waiting for jobs to complete 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.

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

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

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.

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

Kustomize

(Appears on: PostRenderer)

Kustomize Helm PostRenderer specification.

Field Description
patches
[]github.com/fluxcd/pkg/apis/kustomize.Patch 		(Optional)

Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.
patchesStrategicMerge
[]Kubernetes pkg/apis/apiextensions/v1.JSON 		(Optional)

Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead.
patchesJson6902
[]github.com/fluxcd/pkg/apis/kustomize.JSON6902Patch 		(Optional)

JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead.
images
[]github.com/fluxcd/pkg/apis/kustomize.Image 		(Optional)

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.

PostRenderer

(Appears on: HelmReleaseSpec)

PostRenderer contains a Helm PostRenderer specification.

Field Description
kustomize
Kustomize 		(Optional)

Kustomization to apply as PostRenderer.

ReleaseAction (string alias)

(Appears on: HelmReleaseStatus)

ReleaseAction is the action to perform a Helm release.

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

DisableWaitForJobs disables waiting for jobs to complete 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.

Snapshot

Snapshot captures a point-in-time copy of the status information for a Helm release, as managed by the controller.

Field Description
apiVersion
string 		(Optional)

APIVersion is the API version of the Snapshot. Provisional: when the calculation method of the Digest field is changed, this field will be used to distinguish between the old and new methods.
digest
string

Digest is the checksum of the release object in storage. It has the format of <algo>:<checksum>.
name
string

Name is the name of the release.
namespace
string

Namespace is the namespace the release is deployed to.
version
int

Version is the version of the release object in storage.
status
string

Status is the current state of the release.
chartName
string

ChartName is the chart name of the release object in storage.
chartVersion
string

ChartVersion is the chart version of the release object in storage.
configDigest
string

ConfigDigest is the checksum of the config (better known as “values”) of the release object in storage. It has the format of <algo>:<checksum>.
firstDeployed
Kubernetes meta/v1.Time

FirstDeployed is when the release was first deployed.
lastDeployed
Kubernetes meta/v1.Time

LastDeployed is when the release was last deployed.
deleted
Kubernetes meta/v1.Time 		(Optional)

Deleted is when the release was deleted.
testHooks
TestHookStatus 		(Optional)

TestHooks is the list of test hooks for the release as observed to be run by the controller.
ociDigest
string 		(Optional)

OCIDigest is the digest of the OCI artifact associated with the release.

Snapshots ([]*github.com/fluxcd/helm-controller/api/v2.Snapshot alias)

(Appears on: HelmReleaseStatus)

Snapshots is a list of Snapshot objects.

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

Filters is a list of tests to run or exclude from running.

TestHookStatus

(Appears on: Snapshot)

TestHookStatus holds the status information for a test hook as observed to be run by the controller.

Field Description
lastStarted
Kubernetes meta/v1.Time 		(Optional)

LastStarted is the time the test hook was last started.
lastCompleted
Kubernetes meta/v1.Time 		(Optional)

LastCompleted is the time the test hook last completed.
phase
string 		(Optional)

Phase the test hook was observed to be in.

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

DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed.
deletionPropagation
string 		(Optional)

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

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

DisableWaitForJobs disables waiting for jobs to complete 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.
crds
CRDsPolicy 		(Optional)

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.

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