flux v2.9.5

HelmRelease.spec.postRenderers[].kustomize.patches[].target.spec

HelmReleaseSpec defines the desired state of a Helm release.

26 fields
HelmRelease.spec.postRenderers[].kustomize.patches[].target.spec fields and descriptions
Field / TypeDescription
object

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

object

ChartRef holds a reference to a source controller resource containing the Helm chart artifact.

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.

object[]

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

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.

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.

object

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

interval
string required

Interval at which to reconcile the Helm release.

  • pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
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.

  • x-kubernetes-validations: [{"message":"exactly one of spec.kubeConfig.configMapRef or spec.kubeConfig.secretRef must be specified","rule":"has(self.configMapRef) || has(self.secretRef)"},{"message":"exactly one of spec.kubeConfig.configMapRef or spec.kubeConfig.secretRef must be specified","rule":"!has(self.configMapRef) || !has(self.secretRef)"}]
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.

postRenderStrategy
string

PostRenderStrategy defines the strategy for sending hooks to post-renderers. Valid values are 'nohooks' (hooks not sent to post-renderers, Helm 3 behavior), 'combined' (hooks and templates sent together, Helm 4 default), and 'separate' (hooks and templates sent in separate streams, Helm 4.2 opt-in). Defaults to 'combined', or 'nohooks' when the UseHelm3Defaults feature gate is enabled.

  • enum: ["nohooks","combined","separate"]
object[]

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

releaseName
string

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

  • minLength: 1
  • maxLength: 53
object

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

serviceAccountName
string

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

  • minLength: 1
  • maxLength: 253
storageNamespace
string

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

  • minLength: 1
  • maxLength: 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: 1
  • maxLength: 63
object

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

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))+$
object

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

object

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

values
any

Values holds the values for this Helm release.

  • x-kubernetes-preserve-unknown-fields: true
object[]

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

object

WaitStrategy defines Helm's wait strategy for waiting for applied resources to become ready.