Skip to main content

Helm-release

TypeComponent

Parameters

Parameter
Type
Required
DefaultDescription
intervalstringYes

Interval at which to reconcile the Helm release.

annotationsmapNo

Annotations for the workload

chartobjectNo

Chart defines the template of the v1.HelmChart that should be created for this HelmRelease. [[EmptyIf: .chartRef != null]] [[RequiredIf: .chartRef == null]]

chartRefobjectNo

ChartRef holds a reference to a source controller resource containing the Helm chart artifact. [[EmptyIf: .chart != null]] [[RequiredIf: .chart == null]]

dependsOnarrayNo

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

driftDetectionobjectNo

DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster.

installobjectNo

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

kubeConfigobjectNo

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.

labelsmapNo

Labels for the workload

maxHistoryintegerNo

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

persistentClientbooleanNo

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.

postRenderersarrayNo

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

releaseNamestringNo

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

rollbackobjectNo

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

serviceAccountNamestringNo

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

storageNamespacestringNo

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

suspendbooleanNo

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

targetNamespacestringNo

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

testobjectNo

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

timeoutstringNo

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

uninstallobjectNo

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

upgradeobjectNo

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

valuesobjectNo

Values holds the values for this Helm release. [[TextEditor: YAML]]

valuesFromarrayNo

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

Template

The following tabs display the definition's Cue template and the rendered YAML. The rendered YAML is the output of the Cue template when the definition is applied to a cluster.

helmrelease: {
type: "component"
description: "HelmRelease is the Schema for the helmreleases API"
labels: {
"componentdefinition.spectrocloud.com/type": "application"
"wl.spectrocloud.com/provider": "helm.toolkit.fluxcd.io"
"definition.spectrocloud.com/category": "Flux"
}
attributes: {
status: {
healthPolicy: {
ready: {
readyCondition: *false | bool
} & {
if context.output.status.conditions != _|_ {
for condition in context.output.status.conditions {
if condition.type == "Ready" && condition.status == "True" {
readyCondition: true
}
}
}
}
_isHealth: ready.readyCondition
isHealth: *_isHealth | bool
if context.output.metadata.annotations != _|_ {
if context.output.metadata.annotations["wl.spectrocloud.com/disable-health-check"] != _|_ {
isHealth: true
}
}
}
}
}
}

template: {
output: {
apiVersion: "helm.toolkit.fluxcd.io/v2"
kind: "HelmRelease"
metadata: {
labels: {
if parameter.labels != _|_ {
parameter.labels
}
"wl.spectrocloud.com/name": context.workloadName
"wl.spectrocloud.com/component": context.name
}
if parameter.annotations != _|_ {
annotations: parameter.annotations
}
}
spec: {
if parameter.chart != _|_ {
chart: parameter.chart
}
if parameter.chartRef != _|_ {
chartRef: parameter.chartRef
}
if parameter.dependsOn != _|_ {
dependsOn: parameter.dependsOn
}
if parameter.driftDetection != _|_ {
driftDetection: parameter.driftDetection
}
if parameter.install != _|_ {
install: parameter.install
}
interval: parameter.interval
if parameter.kubeConfig != _|_ {
kubeConfig: parameter.kubeConfig
}
if parameter.maxHistory != _|_ {
maxHistory: parameter.maxHistory
}
if parameter.persistentClient != _|_ {
persistentClient: parameter.persistentClient
}
if parameter.postRenderers != _|_ {
postRenderers: parameter.postRenderers
}
if parameter.releaseName != _|_ {
releaseName: parameter.releaseName
}
if parameter.rollback != _|_ {
rollback: parameter.rollback
}
if parameter.serviceAccountName != _|_ {
serviceAccountName: parameter.serviceAccountName
}
if parameter.storageNamespace != _|_ {
storageNamespace: parameter.storageNamespace
}
if parameter.suspend != _|_ {
suspend: parameter.suspend
}
if parameter.targetNamespace != _|_ {
targetNamespace: parameter.targetNamespace
}
if parameter.test != _|_ {
test: parameter.test
}
if parameter.timeout != _|_ {
timeout: parameter.timeout
}
if parameter.uninstall != _|_ {
uninstall: parameter.uninstall
}
if parameter.upgrade != _|_ {
upgrade: parameter.upgrade
}
if parameter.values != _|_ {
values: parameter.values
}
if parameter.valuesFrom != _|_ {
valuesFrom: parameter.valuesFrom
}
}
}

parameter: {
// +usage=Annotations for the workload
annotations?: [string]: string

// +usage=Labels for the workload
labels?: [string]: string

// +usage=Chart defines the template of the v1.HelmChart that should be created for this HelmRelease. [[EmptyIf: .chartRef != null]] [[RequiredIf: .chartRef == null]]
chart?: {

// +usage=ObjectMeta holds the template for metadata like labels and annotations.
metadata?: {

// +usage=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/
annotations?: [string]: string

// +usage=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/
labels?: [string]: string
}

// +usage=Spec holds the template for the v1.HelmChartSpec for this HelmRelease.
spec: {

// +usage=The name or path the Helm chart is available at in the SourceRef.
chart: string

// +usage=IgnoreMissingValuesFiles controls whether to silently ignore missing values files rather than failing.
ignoreMissingValuesFiles?: bool

// +usage=Interval at which to check the v1.Source for updates. Defaults to 'HelmReleaseSpec.Interval'.
interval?: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"

// +usage=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.
reconcileStrategy?: *"ChartVersion" | "Revision"

// +usage=The name and namespace of the v1.Source the chart is available at.
sourceRef: {

// +usage=APIVersion of the referent.
apiVersion?: string

// +usage=Kind of the referent.
kind: *"HelmRepository" | "GitRepository" | "Bucket"

// +usage=Name of the referent.
name: string

// +usage=Namespace of the referent.
namespace?: string
}

// +usage=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.
valuesFiles?: [...string]

// +usage=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.
verify?: {

// +usage=Provider specifies the technology used to sign the OCI Helm chart.
provider: *"cosign" | "notation"

// +usage=SecretRef specifies the Kubernetes Secret containing the trusted public keys.
secretRef?: {

// +usage=Name of the referent.
name: string
}
}

// +usage=Version semver expression, ignored for charts from v1.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted.
version?: *"*" | string
}
}

// +usage=ChartRef holds a reference to a source controller resource containing the Helm chart artifact. [[EmptyIf: .chart != null]] [[RequiredIf: .chart == null]]
chartRef?: {

// +usage=APIVersion of the referent.
apiVersion?: string

// +usage=Kind of the referent.
kind: *"OCIRepository" | "HelmChart"

// +usage=Name of the referent.
name: string

// +usage=Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.
namespace?: string
}

// +usage=DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled.
dependsOn?: [...{

// +usage=Name of the referent.
name: string

// +usage=Namespace of the referent, when not specified it acts as LocalObjectReference.
namespace?: string
}]

// +usage=DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster.
driftDetection?: {

// +usage=Ignore contains a list of rules for specifying which changes to ignore during diffing.
ignore?: [...{

// +usage=Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object.
paths!: [...string]

// +usage=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.
target?: {

// +usage=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.
annotationSelector?: string

// +usage=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
group?: string

// +usage=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
kind?: string

// +usage=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.
labelSelector?: string

// +usage=Name to match resources with.
name?: string

// +usage=Namespace to select resources from.
namespace?: string

// +usage=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
version?: string
}
}]

// +usage=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.
mode?: *"enabled" | "warn" | "disabled"
}

// +usage=Install holds the configuration for Helm install actions for this HelmRelease.
install?: {

// +usage=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.
crds?: *"Skip" | "Create" | "CreateReplace"

// +usage=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.
createNamespace?: bool

// +usage=DisableHooks prevents hooks from running during the Helm install action.
disableHooks?: bool

// +usage=DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema.
disableOpenAPIValidation?: bool

// +usage=DisableSchemaValidation prevents the Helm install action from validating the values against the JSON Schema.
disableSchemaValidation?: bool

// +usage=DisableTakeOwnership disables taking ownership of existing resources during the Helm install action. Defaults to false.
disableTakeOwnership?: bool

// +usage=DisableWait disables the waiting for resources to be ready after a Helm install has been performed.
disableWait?: bool

// +usage=DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed.
disableWaitForJobs?: bool

// +usage=Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action.
remediation?: {

// +usage=IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'.
ignoreTestFailures?: bool

// +usage=RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'.
remediateLastFailure?: bool

// +usage=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.
retries?: int
}

// +usage=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.
replace?: bool

// +usage=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.
skipCRDs?: bool

// +usage=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'.
timeout?: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
}

// +usage=Interval at which to reconcile the Helm release.
interval: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"

// +usage=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.
kubeConfig?: {

// +usage=SecretRef holds the 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'. 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.
secretRef: {

// +usage=Key in the Secret, when not specified an implementation-specific default key is used.
key?: string

// +usage=Name of the Secret.
name: string
}
}

// +usage=MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use '0' for an unlimited number of revisions; defaults to '5'.
maxHistory?: int

// +usage=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.
persistentClient?: bool

// +usage=PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition.
postRenderers?: [...{

// +usage=Kustomization to apply as PostRenderer.
kustomize?: {

// +usage=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.
images?: [...{

// +usage=Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored.
digest?: string

// +usage=Name is a tag-less image name.
name: string

// +usage=NewName is the value used to replace the original name.
newName?: string

// +usage=NewTag is the value used to replace the original tag.
newTag?: string
}]

// +usage=Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.
patches?: [...{

// +usage=Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects.
patch: string

// +usage=Target points to the resources that the patch document should be applied to.
target?: {

// +usage=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.
annotationSelector?: string

// +usage=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
group?: string

// +usage=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
kind?: string

// +usage=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.
labelSelector?: string

// +usage=Name to match resources with.
name?: string

// +usage=Namespace to select resources from.
namespace?: string

// +usage=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
version?: string
}
}]
}
}]

// +usage=ReleaseName used for the Helm release. Defaults to a composition of '[TargetNamespace-]Name'.
releaseName?: string

// +usage=Rollback holds the configuration for Helm rollback actions for this HelmRelease.
rollback?: {

// +usage=CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails.
cleanupOnFail?: bool

// +usage=DisableHooks prevents hooks from running during the Helm rollback action.
disableHooks?: bool

// +usage=DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed.
disableWait?: bool

// +usage=DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed.
disableWaitForJobs?: bool

// +usage=Force forces resource updates through a replacement strategy.
force?: bool

// +usage=Recreate performs pod restarts for the resource if applicable.
recreate?: bool

// +usage=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'.
timeout?: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
}

// +usage=The name of the Kubernetes service account to impersonate when reconciling this HelmRelease.
serviceAccountName?: string

// +usage=StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease.
storageNamespace?: string

// +usage=Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false.
suspend?: bool

// +usage=TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease.
targetNamespace?: string

// +usage=Test holds the configuration for Helm test actions for this HelmRelease.
test?: {

// +usage=Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed.
enable?: bool

// +usage=Filters is a list of tests to run or exclude from running.
filters?: [...{

// +usage=Exclude specifies whether the named test should be excluded.
exclude?: bool

// +usage=Name is the name of the test.
name: string
}]

// +usage=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'.
ignoreFailures?: bool

// +usage=Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.
timeout?: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
}

// +usage=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'.
timeout?: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"

// +usage=Uninstall holds the configuration for Helm uninstall actions for this HelmRelease.
uninstall?: {

// +usage=DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed.
deletionPropagation?: *"background" | "foreground" | "orphan"

// +usage=DisableHooks prevents hooks from running during the Helm rollback action.
disableHooks?: bool

// +usage=DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed.
disableWait?: bool

// +usage=KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history.
keepHistory?: bool

// +usage=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'.
timeout?: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
}

// +usage=Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.
upgrade?: {

// +usage=CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails.
cleanupOnFail?: bool

// +usage=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.
crds?: *"Skip" | "Create" | "CreateReplace"

// +usage=DisableHooks prevents hooks from running during the Helm upgrade action.
disableHooks?: bool

// +usage=DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema.
disableOpenAPIValidation?: bool

// +usage=DisableSchemaValidation prevents the Helm upgrade action from validating the values against the JSON Schema.
disableSchemaValidation?: bool

// +usage=DisableTakeOwnership disables taking ownership of existing resources during the Helm upgrade action. Defaults to false.
disableTakeOwnership?: bool

// +usage=DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed.
disableWait?: bool

// +usage=DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed.
disableWaitForJobs?: bool

// +usage=Force forces resource updates through a replacement strategy.
force?: bool

// +usage=PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative.
preserveValues?: bool

// +usage=Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action.
remediation?: {

// +usage=IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'.
ignoreTestFailures?: bool

// +usage=RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0.
remediateLastFailure?: bool

// +usage=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.
retries?: int

// +usage=Strategy to use for failure remediation. Defaults to 'rollback'.
strategy?: *"rollback" | "uninstall"
}

// +usage=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'.
timeout?: =~"^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
}

// +usage=Values holds the values for this Helm release. [[TextEditor: YAML]]
values?: _

// +usage=ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged.
valuesFrom?: [...{

// +usage=Kind of the values referent, valid values are ('Secret', 'ConfigMap').
kind: *"Secret" | "ConfigMap"

// +usage=Name of the values referent. Should reside in the same namespace as the referring resource.
name: string

// +usage=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.
optional?: bool

// +usage=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.
targetPath?: =~"^([a-zA-Z0-9_\\-.\\\\\\/]|\\[[0-9]{1,5}\\])+$"

// +usage=ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'.
valuesKey?: =~"^[\\-._a-zA-Z0-9]+$"
}]
}
}