HelmRelease
helm.toolkit.fluxcd.io / v2
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
HelmReleaseSpec defines the desired state of a Helm release.
chart object
Chart defines the template of the v1.HelmChart that should be created
for this HelmRelease.
metadata object
ObjectMeta holds the template for metadata like labels and annotations.
annotations
object
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/
labels
object
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/
spec object required
Spec holds the template for the v1.HelmChartSpec for this HelmRelease.
chart
string required
The name or path the Helm chart is available at in the SourceRef.
minLength:
1maxLength:
2048
ignoreMissingValuesFiles
boolean
IgnoreMissingValuesFiles controls whether to silently ignore missing values files rather than failing.
interval
string
Interval at which to check the v1.Source for updates. Defaults to
'HelmReleaseSpec.Interval'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
reconcileStrategy
string
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.
enum:
ChartVersion, RevisionsourceRef object required
The name and namespace of the v1.Source the chart is available at.
apiVersion
string
APIVersion of the referent.
kind
string required
Kind of the referent.
enum:
HelmRepository, GitRepository, Bucket
name
string required
Name of the referent.
minLength:
1maxLength:
253
namespace
string
Namespace of the referent.
minLength:
1maxLength:
63
valuesFiles
[]string
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.
verify object
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
string required
Provider specifies the technology used to sign the OCI Helm chart.
enum:
cosign, notationsecretRef object
SecretRef specifies the Kubernetes Secret containing the
trusted public keys.
name
string required
Name of the referent.
version
string
Version semver expression, ignored for charts from v1.GitRepository and
v1beta2.Bucket sources. Defaults to latest when omitted.
chartRef object
ChartRef holds a reference to a source controller resource containing the
Helm chart artifact.
apiVersion
string
APIVersion of the referent.
kind
string required
Kind of the referent.
enum:
OCIRepository, HelmChart, ExternalArtifact
name
string required
Name of the referent.
minLength:
1maxLength:
253
namespace
string
Namespace of the referent, defaults to the namespace of the Kubernetes
resource object that contains the reference.
minLength:
1maxLength:
63commonMetadata object
CommonMetadata specifies the common labels and annotations that are
applied to all resources. Any existing label or annotation will be
overridden if its key matches a common one.
annotations
object
Annotations to be added to the object's metadata.
labels
object
Labels to be added to the object's metadata.
dependsOn []object
DependsOn may contain a DependencyReference slice with
references to HelmRelease resources that must be ready before this HelmRelease
can be reconciled.
name
string required
Name of the referent.
namespace
string
Namespace of the referent, defaults to the namespace of the HelmRelease
resource object that contains the reference.
readyExpr
string
ReadyExpr is a CEL expression that can be used to assess the readiness
of a dependency. When specified, the built-in readiness check
is replaced by the logic defined in the CEL expression.
To make the CEL expression additive to the built-in readiness check,
the feature gate `AdditiveCELDependencyCheck` must be set to `true`.
driftDetection object
DriftDetection holds the configuration for detecting and handling
differences between the manifest in the Helm storage and the resources
currently existing in the cluster.
ignore []object
Ignore contains a list of rules for specifying which changes to ignore
during diffing.
paths
[]string required
Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from
consideration in a Kubernetes object.
target object
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.
annotationSelector
string
AnnotationSelector is a string that follows the label selection expression
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
It matches with the resource annotations.
group
string
Group is the API group to select resources from.
Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources.
https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md
kind
string
Kind of the API Group to select resources from.
Together with Group and Version it is capable of unambiguously
identifying and/or selecting resources.
https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md
labelSelector
string
LabelSelector is a string that follows the label selection expression
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
It matches with the resource labels.
name
string
Name to match resources with.
namespace
string
Namespace to select resources from.
version
string
Version of the API Group to select resources from.
Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources.
https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md
mode
string
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.
enum:
enabled, warn, disabledhealthCheckExprs []object
HealthCheckExprs is a list of healthcheck expressions for evaluating the
health of custom resources using Common Expression Language (CEL).
The expressions are evaluated only when the specific Helm action
taking place has wait enabled, i.e. DisableWait is false, and the
'poller' WaitStrategy is used.
apiVersion
string required
APIVersion of the custom resource under evaluation.
current
string required
Current is the CEL expression that determines if the status
of the custom resource has reached the desired state.
failed
string
Failed is the CEL expression that determines if the status
of the custom resource has failed to reach the desired state.
inProgress
string
InProgress is the CEL expression that determines if the status
of the custom resource has not yet reached the desired state.
kind
string required
Kind of the custom resource under evaluation.
install object
Install holds the configuration for Helm install actions for this HelmRelease.
crds
string
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.
enum:
Skip, Create, CreateReplace
createNamespace
boolean
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.
disableHooks
boolean
DisableHooks prevents hooks from running during the Helm install action.
disableOpenAPIValidation
boolean
DisableOpenAPIValidation prevents the Helm install action from validating
rendered templates against the Kubernetes OpenAPI Schema.
disableSchemaValidation
boolean
DisableSchemaValidation prevents the Helm install action from validating
the values against the JSON Schema.
disableTakeOwnership
boolean
DisableTakeOwnership disables taking ownership of existing resources
during the Helm install action. Defaults to false.
disableWait
boolean
DisableWait disables the waiting for resources to be ready after a Helm
install has been performed.
disableWaitForJobs
boolean
DisableWaitForJobs disables waiting for jobs to complete after a Helm
install has been performed.
remediation object
Remediation holds the remediation configuration for when the Helm install
action for the HelmRelease fails. The default is to not perform any action.
ignoreTestFailures
boolean
IgnoreTestFailures tells the controller to skip remediation when the Helm
tests are run after an install action but fail. Defaults to
'Test.IgnoreFailures'.
remediateLastFailure
boolean
RemediateLastFailure tells the controller to remediate the last failure, when
no retries remain. Defaults to 'false'.
retries
integer
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.
replace
boolean
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.
serverSideApply
boolean
ServerSideApply enables server-side apply for resources during install.
Defaults to true (or false when UseHelm3Defaults feature gate is enabled).
skipCRDs
boolean
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.
strategy object
Strategy defines the install strategy to use for this HelmRelease.
Defaults to 'RemediateOnFailure', or 'RetryOnFailure' when the
DefaultToRetryOnFailure feature gate is enabled.
name
string required
Name of the install strategy.
enum:
RemediateOnFailure, RetryOnFailure
retryInterval
string
RetryInterval is the interval at which to retry a failed install.
Can be used only when Name is set to RetryOnFailure.
Defaults to '5m'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
timeout
string
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'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
interval
string required
Interval at which to reconcile the Helm release.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$kubeConfig object
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.
configMapRef object
ConfigMapRef holds an optional name of a ConfigMap that contains
the following keys:
- `provider`: the provider to use. One of `aws`, `azure`, `gcp`, or
`generic`. Required.
- `cluster`: the fully qualified resource name of the Kubernetes
cluster in the cloud provider API. Not used by the `generic`
provider. Required when one of `address` or `ca.crt` is not set.
- `address`: the address of the Kubernetes API server. Required
for `generic`. For the other providers, if not specified, the
first address in the cluster resource will be used, and if
specified, it must match one of the addresses in the cluster
resource.
If audiences is not set, will be used as the audience for the
`generic` provider.
- `ca.crt`: the optional PEM-encoded CA certificate for the
Kubernetes API server. If not set, the controller will use the
CA certificate from the cluster resource.
- `audiences`: the optional audiences as a list of
line-break-separated strings for the Kubernetes ServiceAccount
token. Defaults to the `address` for the `generic` provider, or
to specific values for the other providers depending on the
provider.
- `serviceAccountName`: the optional name of the Kubernetes
ServiceAccount in the same namespace that should be used
for authentication. If not specified, the controller
ServiceAccount will be used.
Mutually exclusive with SecretRef.
name
string required
Name of the referent.
secretRef object
SecretRef holds an optional name of a secret that contains a key with
the kubeconfig file as the value. If no key is set, the key will default
to 'value'. Mutually exclusive with ConfigMapRef.
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
Kubernetes resources. Supported only for the generic provider.
key
string
Key in the Secret, when not specified an implementation-specific default key is used.
name
string required
Name of the Secret.
maxHistory
integer
MaxHistory is the number of revisions saved by Helm for this HelmRelease.
Use '0' for an unlimited number of revisions; defaults to '5'.
persistentClient
boolean
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.
postRenderers []object
PostRenderers holds an array of Helm PostRenderers, which will be applied in order
of their definition.
kustomize object
Kustomization to apply as PostRenderer.
images []object
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.
digest
string
Digest is the value used to replace the original image tag.
If digest is present NewTag value is ignored.
name
string required
Name is a tag-less image name.
newName
string
NewName is the value used to replace the original name.
newTag
string
NewTag is the value used to replace the original tag.
patches []object
Strategic merge and JSON patches, defined as inline YAML objects,
capable of targeting objects based on kind, label and annotation selectors.
patch
string required
Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with
an array of operation objects.
target object
Target points to the resources that the patch document should be applied to.
annotationSelector
string
AnnotationSelector is a string that follows the label selection expression
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
It matches with the resource annotations.
group
string
Group is the API group to select resources from.
Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources.
https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md
kind
string
Kind of the API Group to select resources from.
Together with Group and Version it is capable of unambiguously
identifying and/or selecting resources.
https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md
labelSelector
string
LabelSelector is a string that follows the label selection expression
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
It matches with the resource labels.
name
string
Name to match resources with.
namespace
string
Namespace to select resources from.
version
string
Version of the API Group to select resources from.
Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources.
https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md
releaseName
string
ReleaseName used for the Helm release. Defaults to a composition of
'[TargetNamespace-]Name'.
minLength:
1maxLength:
53rollback object
Rollback holds the configuration for Helm rollback actions for this HelmRelease.
cleanupOnFail
boolean
CleanupOnFail allows deletion of new resources created during the Helm
rollback action when it fails.
disableHooks
boolean
DisableHooks prevents hooks from running during the Helm rollback action.
disableWait
boolean
DisableWait disables the waiting for resources to be ready after a Helm
rollback has been performed.
disableWaitForJobs
boolean
DisableWaitForJobs disables waiting for jobs to complete after a Helm
rollback has been performed.
force
boolean
Force forces resource updates through a replacement strategy
that avoids 3-way merge conflicts on client-side apply.
This field is ignored for server-side apply (which always
forces conflicts with other field managers).
recreate
boolean
Recreate performs pod restarts for any managed workloads.
Deprecated: This behavior was deprecated in Helm 3:
- Deprecation: https://github.com/helm/helm/pull/6463
- Removal: https://github.com/helm/helm/pull/31023
After helm-controller was upgraded to the Helm 4 SDK,
this field is no longer functional and will print a
warning if set to true. It will also be removed in a
future release.
serverSideApply
string
ServerSideApply enables server-side apply for resources during rollback.
Can be "enabled", "disabled", or "auto".
When "auto", server-side apply usage will be based on the release's previous usage.
Defaults to "auto".
enum:
enabled, disabled, auto
timeout
string
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'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
serviceAccountName
string
The name of the Kubernetes service account to impersonate
when reconciling this HelmRelease.
minLength:
1maxLength:
253
storageNamespace
string
StorageNamespace used for the Helm storage.
Defaults to the namespace of the HelmRelease.
minLength:
1maxLength:
63
suspend
boolean
Suspend tells the controller to suspend reconciliation for this HelmRelease,
it does not apply to already started reconciliations. Defaults to false.
targetNamespace
string
TargetNamespace to target when performing operations for the HelmRelease.
Defaults to the namespace of the HelmRelease.
minLength:
1maxLength:
63test object
Test holds the configuration for Helm test actions for this HelmRelease.
enable
boolean
Enable enables Helm test actions for this HelmRelease after an Helm install
or upgrade action has been performed.
filters []object
Filters is a list of tests to run or exclude from running.
exclude
boolean
Exclude specifies whether the named test should be excluded.
name
string required
Name is the name of the test.
minLength:
1maxLength:
253
ignoreFailures
boolean
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
string
Timeout is the time to wait for any individual Kubernetes operation during
the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
timeout
string
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'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$uninstall object
Uninstall holds the configuration for Helm uninstall actions for this HelmRelease.
deletionPropagation
string
DeletionPropagation specifies the deletion propagation policy when
a Helm uninstall is performed.
enum:
background, foreground, orphan
disableHooks
boolean
DisableHooks prevents hooks from running during the Helm rollback action.
disableWait
boolean
DisableWait disables waiting for all the resources to be deleted after
a Helm uninstall is performed.
keepHistory
boolean
KeepHistory tells Helm to remove all associated resources and mark the
release as deleted, but retain the release history.
timeout
string
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'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$upgrade object
Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.
cleanupOnFail
boolean
CleanupOnFail allows deletion of new resources created during the Helm
upgrade action when it fails.
crds
string
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.
enum:
Skip, Create, CreateReplace
disableHooks
boolean
DisableHooks prevents hooks from running during the Helm upgrade action.
disableOpenAPIValidation
boolean
DisableOpenAPIValidation prevents the Helm upgrade action from validating
rendered templates against the Kubernetes OpenAPI Schema.
disableSchemaValidation
boolean
DisableSchemaValidation prevents the Helm upgrade action from validating
the values against the JSON Schema.
disableTakeOwnership
boolean
DisableTakeOwnership disables taking ownership of existing resources
during the Helm upgrade action. Defaults to false.
disableWait
boolean
DisableWait disables the waiting for resources to be ready after a Helm
upgrade has been performed.
disableWaitForJobs
boolean
DisableWaitForJobs disables waiting for jobs to complete after a Helm
upgrade has been performed.
force
boolean
Force forces resource updates through a replacement strategy
that avoids 3-way merge conflicts on client-side apply.
This field is ignored for server-side apply (which always
forces conflicts with other field managers).
preserveValues
boolean
PreserveValues will make Helm reuse the last release's values and merge in
overrides from 'Values'. Setting this flag makes the HelmRelease
non-declarative.
remediation object
Remediation holds the remediation configuration for when the Helm upgrade
action for the HelmRelease fails. The default is to not perform any action.
ignoreTestFailures
boolean
IgnoreTestFailures tells the controller to skip remediation when the Helm
tests are run after an upgrade action but fail.
Defaults to 'Test.IgnoreFailures'.
remediateLastFailure
boolean
RemediateLastFailure tells the controller to remediate the last failure, when
no retries remain. Defaults to 'false' unless 'Retries' is greater than 0.
retries
integer
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.
strategy
string
Strategy to use for failure remediation. Defaults to 'rollback'.
enum:
rollback, uninstall
serverSideApply
string
ServerSideApply enables server-side apply for resources during upgrade.
Can be "enabled", "disabled", or "auto".
When "auto", server-side apply usage will be based on the release's previous usage.
Defaults to "auto".
enum:
enabled, disabled, autostrategy object
Strategy defines the upgrade strategy to use for this HelmRelease.
Defaults to 'RemediateOnFailure', or 'RetryOnFailure' when the
DefaultToRetryOnFailure feature gate is enabled.
name
string required
Name of the upgrade strategy.
enum:
RemediateOnFailure, RetryOnFailure
retryInterval
string
RetryInterval is the interval at which to retry a failed upgrade.
Can be used only when Name is set to RetryOnFailure.
Defaults to '5m'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
timeout
string
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'.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
values
object
Values holds the values for this Helm release.
valuesFrom []object
ValuesFrom holds references to resources containing Helm values for this HelmRelease,
and information about how they should be merged.
kind
string required
Kind of the values referent, valid values are ('Secret', 'ConfigMap').
enum:
Secret, ConfigMap
name
string required
Name of the values referent. Should reside in the same namespace as the
referring resource.
minLength:
1maxLength:
253
optional
boolean
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.
targetPath
string
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.
pattern:
^([a-zA-Z0-9_\-.\\\/]|\[[0-9]{1,5}\])+$maxLength:
250
valuesKey
string
ValuesKey is the data key where the values.yaml or a specific value can be
found at. Defaults to 'values.yaml'.
pattern:
^[\-._a-zA-Z0-9]+$maxLength:
253waitStrategy object
WaitStrategy defines Helm's wait strategy for waiting for applied
resources to become ready.
name
string required
Name is Helm's wait strategy for waiting for applied resources to
become ready. One of 'poller' or 'legacy'. The 'poller' strategy uses
kstatus to poll resource statuses, while the 'legacy' strategy uses
Helm v3's waiting logic.
Defaults to 'poller', or to 'legacy' when UseHelm3Defaults feature
gate is enabled.
enum:
poller, legacystatus object
HelmReleaseStatus defines the observed state of a HelmRelease.
conditions []object
Conditions holds the conditions for the HelmRelease.
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316
failures
integer
Failures is the reconciliation failure count against the latest desired
state. It is reset after a successful reconciliation.
format:
int64
helmChart
string
HelmChart is the namespaced name of the HelmChart resource created by
the controller for the HelmRelease.
history []object
History holds the history of Helm releases performed for this HelmRelease
up to the last successfully completed release.
action
string
Action is the action that resulted in this snapshot being created.
apiVersion
string
APIVersion is the API version of the Snapshot.
When the calculation method of the Digest field is changed, this
field will be used to distinguish between the old and new methods.
appVersion
string
AppVersion is the chart app version of the release object in storage.
chartName
string required
ChartName is the chart name of the release object in storage.
chartVersion
string required
ChartVersion is the chart version of the release object in
storage.
configDigest
string required
ConfigDigest is the checksum of the config (better known as
"values") of the release object in storage.
It has the format of `<algo>:<checksum>`.
deleted
string
Deleted is when the release was deleted.
format:
date-time
digest
string required
Digest is the checksum of the release object in storage.
It has the format of `<algo>:<checksum>`.
firstDeployed
string required
FirstDeployed is when the release was first deployed.
format:
date-time
lastDeployed
string required
LastDeployed is when the release was last deployed.
format:
date-time
name
string required
Name is the name of the release.
namespace
string required
Namespace is the namespace the release is deployed to.
ociDigest
string
OCIDigest is the digest of the OCI artifact associated with the release.
status
string required
Status is the current state of the release.
testHooks
object
TestHooks is the list of test hooks for the release as observed to be
run by the controller.
version
integer required
Version is the version of the release object in storage.
installFailures
integer
InstallFailures is the install failure count against the latest desired
state. It is reset after a successful reconciliation.
format:
int64inventory object
Inventory contains the list of Kubernetes resource object references
that have been applied for this release.
entries []object required
Entries of Kubernetes resource object references.
id
string required
ID is the string representation of the Kubernetes resource object's metadata,
in the format '<namespace>_<name>_<group>_<kind>'.
v
string required
Version is the API version of the Kubernetes resource object's kind.
lastAttemptedConfigDigest
string
LastAttemptedConfigDigest is the digest for the config (better known as
"values") of the last reconciliation attempt.
lastAttemptedGeneration
integer
LastAttemptedGeneration is the last generation the controller attempted
to reconcile.
format:
int64
lastAttemptedReleaseAction
string
LastAttemptedReleaseAction is the last release action performed for this
HelmRelease. It is used to determine the active retry or remediation
strategy.
enum:
install, upgrade
lastAttemptedReleaseActionDuration
string
LastAttemptedReleaseActionDuration is the duration of the last
release action performed for this HelmRelease.
lastAttemptedRevision
string
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
LastAttemptedRevisionDigest is the digest of the last reconciliation attempt.
This is only set for OCIRepository sources.
lastAttemptedValuesChecksum
string
LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last
reconciliation attempt.
Deprecated: Use LastAttemptedConfigDigest instead.
lastHandledForceAt
string
LastHandledForceAt holds the value of the most recent
force request value, so a change of the annotation value
can be detected.
lastHandledReconcileAt
string
LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
lastHandledResetAt
string
LastHandledResetAt holds the value of the most recent reset request
value, so a change of the annotation value can be detected.
lastReleaseRevision
integer
LastReleaseRevision is the revision of the last successful Helm release.
Deprecated: Use History instead.
observedCommonMetadataDigest
string
ObservedCommonMetadataDigest is the digest for the common metadata of
the last successful reconciliation attempt.
observedGeneration
integer
ObservedGeneration is the last observed generation.
format:
int64
observedPostRenderersDigest
string
ObservedPostRenderersDigest is the digest for the post-renderers of
the last successful reconciliation attempt.
storageNamespace
string
StorageNamespace is the namespace of the Helm release storage for the
current release.
minLength:
1maxLength:
63
upgradeFailures
integer
UpgradeFailures is the upgrade failure count against the latest desired
state. It is reset after a successful reconciliation.
format:
int64No matches. Try .spec.chart for an exact path