helm-controller/docs/api/helmrelease.md

HelmRelease API reference

Packages:

• helm.toolkit.fluxcd.io/v2alpha1

helm.toolkit.fluxcd.io/v2alpha1

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

Resource Types:

• HelmRelease

HelmRelease

HelmRelease is the Schema for the helmreleases API

Field	Description
apiVersion string	helm.toolkit.fluxcd.io/v2alpha1
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 Helm chart name, version and repository. interval Kubernetes meta/v1.Duration Interval at which to reconcile the Helm release. suspend bool (Optional) Suspend tells the reconciler 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 []string (Optional) DependsOn may contain a list of HelmReleases 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 release. Use ‘0’ for an unlimited number of revisions; defaults to ‘10’. install Install (Optional) Install holds the configuration for Helm install actions for this release. upgrade Upgrade (Optional) Upgrade holds the configuration for Helm upgrade actions for this release. test Test (Optional) Test holds the configuration for Helm test actions for this release. rollback Rollback (Optional) Rollback holds the configuration for Helm rollback actions for this release. uninstall Uninstall (Optional) Uninstall holds the configuration for Helm uninstall actions for this release. valuesFrom []ValuesReference ValuesFrom holds references to resources containing Helm values, and information about how they should be merged. values k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON (Optional) Values holds the values for this Helm release.
status HelmReleaseStatus

Condition

(Appears on: HelmReleaseStatus)

Condition contains condition information for a HelmRelease.

Field	Description
type string	Type of the condition, one of (‘Ready’, ‘Install’, ‘Upgrade’, ‘Test’, ‘Rollback’, ‘Uninstall’).
status Kubernetes core/v1.ConditionStatus	Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the timestamp corresponding to the last status change of this condition.
reason string	Reason is a brief machine readable explanation for the condition’s last transition.
message string	(Optional) Message is a human readable description of the details of the last transition, complementing reason.

CrossNamespaceObjectReference

(Appears on: HelmChartTemplate)

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.

HelmChartTemplate

(Appears on: HelmReleaseSpec)

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

Field	Description
name string	Name of the Helm chart, as made available by the referenced Helm repository.
version string	(Optional) Version semver expression, defaults to latest when omitted.
sourceRef CrossNamespaceObjectReference	The name and namespace of the source HelmRepository the chart is available at.
interval Kubernetes meta/v1.Duration	(Optional) Interval at which to check the Helm repository for chart updates. Defaults to ‘HelmReleaseSpec.Interval’.

HelmReleaseSpec

(Appears on: HelmRelease)

HelmReleaseSpec defines the desired state of HelmRelease.

Field	Description
chart HelmChartTemplate	Chart defines the Helm chart name, version and repository.
interval Kubernetes meta/v1.Duration	Interval at which to reconcile the Helm release.
suspend bool	(Optional) Suspend tells the reconciler 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 []string	(Optional) DependsOn may contain a list of HelmReleases 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 release. Use ‘0’ for an unlimited number of revisions; defaults to ‘10’.
install Install	(Optional) Install holds the configuration for Helm install actions for this release.
upgrade Upgrade	(Optional) Upgrade holds the configuration for Helm upgrade actions for this release.
test Test	(Optional) Test holds the configuration for Helm test actions for this release.
rollback Rollback	(Optional) Rollback holds the configuration for Helm rollback actions for this release.
uninstall Uninstall	(Optional) Uninstall holds the configuration for Helm uninstall actions for this release.
valuesFrom []ValuesReference	ValuesFrom holds references to resources containing Helm values, and information about how they should be merged.
values k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional) Values holds the values for this Helm release.

HelmReleaseStatus

(Appears on: HelmRelease)

HelmReleaseStatus defines the observed state of HelmRelease

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last reconciled generation.
conditions []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. It is reset after a successful reconciliation.

Install

(Appears on: HelmReleaseSpec)

Install holds the configuration for Helm install actions.

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

Rollback

(Appears on: HelmReleaseSpec)

Rollback holds the configuration for Helm rollback actions.

Field	Description
enable bool	(Optional) Enable enables Helm rollback actions for this release after an Helm install or upgrade action failure.
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.

Field	Description
enable bool	(Optional) Enable enables Helm test actions for this release 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’.

Uninstall

(Appears on: HelmReleaseSpec)

Uninstall holds the configuration for Helm uninstall actions.

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.

Unsortable ([][]string alias)

Upgrade

(Appears on: HelmReleaseSpec)

Upgrade holds the configuration for Helm upgrade actions.

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’.
maxRetries int	(Optional) MaxRetries is the number of retries that should be attempted on failures before bailing. Defaults to ‘0’, a negative integer equals to unlimited retries.
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.

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 key in the referent the values can be found at. Defaults to ‘values.yaml’.

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