Skip to content

helm.v2beta2.helmRelease

"HelmRelease is the Schema for the helmreleases API"

Index

Fields

fn new

new(name)

new returns an instance of HelmRelease

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"HelmReleaseSpec defines the desired state of a Helm release."

fn spec.withDependsOn

withDependsOn(dependsOn)

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

fn spec.withDependsOnMixin

withDependsOnMixin(dependsOn)

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

Note: This function appends passed data to existing values

fn spec.withInterval

withInterval(interval)

"Interval at which to reconcile the Helm release."

fn spec.withMaxHistory

withMaxHistory(maxHistory)

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

fn spec.withPersistentClient

withPersistentClient(persistentClient)

"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. \n 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. \n If not set, it defaults to true."

fn spec.withPostRenderers

withPostRenderers(postRenderers)

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

fn spec.withPostRenderersMixin

withPostRenderersMixin(postRenderers)

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

Note: This function appends passed data to existing values

fn spec.withReleaseName

withReleaseName(releaseName)

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

fn spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

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

fn spec.withStorageNamespace

withStorageNamespace(storageNamespace)

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

fn spec.withSuspend

withSuspend(suspend)

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

fn spec.withTargetNamespace

withTargetNamespace(targetNamespace)

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

fn spec.withTimeout

withTimeout(timeout)

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

fn spec.withValues

withValues(values)

"Values holds the values for this Helm release."

fn spec.withValuesFrom

withValuesFrom(valuesFrom)

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

fn spec.withValuesFromMixin

withValuesFromMixin(valuesFrom)

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

Note: This function appends passed data to existing values

obj spec.chart

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

obj spec.chart.metadata

"ObjectMeta holds the template for metadata like labels and annotations."

fn spec.chart.metadata.withAnnotations

withAnnotations(annotations)

"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/"

fn spec.chart.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"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/"

Note: This function appends passed data to existing values

fn spec.chart.metadata.withLabels

withLabels(labels)

"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/"

fn spec.chart.metadata.withLabelsMixin

withLabelsMixin(labels)

"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/"

Note: This function appends passed data to existing values

obj spec.chart.spec

"Spec holds the template for the v1beta2.HelmChartSpec for this HelmRelease."

fn spec.chart.spec.withChart

withChart(chart)

"The name or path the Helm chart is available at in the SourceRef."

fn spec.chart.spec.withInterval

withInterval(interval)

"Interval at which to check the v1.Source for updates. Defaults to 'HelmReleaseSpec.Interval'."

fn spec.chart.spec.withReconcileStrategy

withReconcileStrategy(reconcileStrategy)

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

fn spec.chart.spec.withValuesFile

withValuesFile(valuesFile)

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

fn spec.chart.spec.withValuesFiles

withValuesFiles(valuesFiles)

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

fn spec.chart.spec.withValuesFilesMixin

withValuesFilesMixin(valuesFiles)

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

Note: This function appends passed data to existing values

fn spec.chart.spec.withVersion

withVersion(version)

"Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted."

obj spec.chart.spec.sourceRef

"The name and namespace of the v1.Source the chart is available at."

fn spec.chart.spec.sourceRef.withApiVersion

withApiVersion(apiVersion)

"APIVersion of the referent."

fn spec.chart.spec.sourceRef.withKind

withKind(kind)

"Kind of the referent."

fn spec.chart.spec.sourceRef.withName

withName(name)

"Name of the referent."

fn spec.chart.spec.sourceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent."

obj spec.chart.spec.verify

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

fn spec.chart.spec.verify.withProvider

withProvider(provider)

"Provider specifies the technology used to sign the OCI Helm chart."

obj spec.chart.spec.verify.secretRef

"SecretRef specifies the Kubernetes Secret containing the trusted public keys."

fn spec.chart.spec.verify.secretRef.withName

withName(name)

"Name of the referent."

obj spec.dependsOn

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

fn spec.dependsOn.withName

withName(name)

"Name of the referent."

fn spec.dependsOn.withNamespace

withNamespace(namespace)

"Namespace of the referent, when not specified it acts as LocalObjectReference."

obj spec.driftDetection

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

fn spec.driftDetection.withIgnore

withIgnore(ignore)

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

fn spec.driftDetection.withIgnoreMixin

withIgnoreMixin(ignore)

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

Note: This function appends passed data to existing values

fn spec.driftDetection.withMode

withMode(mode)

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

obj spec.driftDetection.ignore

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

fn spec.driftDetection.ignore.withPaths

withPaths(paths)

"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object."

fn spec.driftDetection.ignore.withPathsMixin

withPathsMixin(paths)

"Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object."

Note: This function appends passed data to existing values

obj spec.driftDetection.ignore.target

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

fn spec.driftDetection.ignore.target.withAnnotationSelector

withAnnotationSelector(annotationSelector)

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

fn spec.driftDetection.ignore.target.withGroup

withGroup(group)

"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"

fn spec.driftDetection.ignore.target.withKind

withKind(kind)

"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"

fn spec.driftDetection.ignore.target.withLabelSelector

withLabelSelector(labelSelector)

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

fn spec.driftDetection.ignore.target.withName

withName(name)

"Name to match resources with."

fn spec.driftDetection.ignore.target.withNamespace

withNamespace(namespace)

"Namespace to select resources from."

fn spec.driftDetection.ignore.target.withVersion

withVersion(version)

"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"

obj spec.install

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

fn spec.install.withCrds

withCrds(crds)

"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. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n 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."

fn spec.install.withCreateNamespace

withCreateNamespace(createNamespace)

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

fn spec.install.withDisableHooks

withDisableHooks(disableHooks)

"DisableHooks prevents hooks from running during the Helm install action."

fn spec.install.withDisableOpenAPIValidation

withDisableOpenAPIValidation(disableOpenAPIValidation)

"DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema."

fn spec.install.withDisableWait

withDisableWait(disableWait)

"DisableWait disables the waiting for resources to be ready after a Helm install has been performed."

fn spec.install.withDisableWaitForJobs

withDisableWaitForJobs(disableWaitForJobs)

"DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed."

fn spec.install.withReplace

withReplace(replace)

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

fn spec.install.withSkipCRDs

withSkipCRDs(skipCRDs)

"SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present. \n Deprecated use CRD policy (crds) attribute with value Skip instead."

fn spec.install.withTimeout

withTimeout(timeout)

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

obj spec.install.remediation

"Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action."

fn spec.install.remediation.withIgnoreTestFailures

withIgnoreTestFailures(ignoreTestFailures)

"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'."

fn spec.install.remediation.withRemediateLastFailure

withRemediateLastFailure(remediateLastFailure)

"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'."

fn spec.install.remediation.withRetries

withRetries(retries)

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

obj spec.kubeConfig

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

obj spec.kubeConfig.secretRef

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

fn spec.kubeConfig.secretRef.withKey

withKey(key)

"Key in the Secret, when not specified an implementation-specific default key is used."

fn spec.kubeConfig.secretRef.withName

withName(name)

"Name of the Secret."

obj spec.postRenderers

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

obj spec.postRenderers.kustomize

"Kustomization to apply as PostRenderer."

fn spec.postRenderers.kustomize.withImages

withImages(images)

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

fn spec.postRenderers.kustomize.withImagesMixin

withImagesMixin(images)

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

Note: This function appends passed data to existing values

fn spec.postRenderers.kustomize.withPatches

withPatches(patches)

"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."

fn spec.postRenderers.kustomize.withPatchesJson6902

withPatchesJson6902(patchesJson6902)

"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead."

fn spec.postRenderers.kustomize.withPatchesJson6902Mixin

withPatchesJson6902Mixin(patchesJson6902)

"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead."

Note: This function appends passed data to existing values

fn spec.postRenderers.kustomize.withPatchesMixin

withPatchesMixin(patches)

"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."

Note: This function appends passed data to existing values

fn spec.postRenderers.kustomize.withPatchesStrategicMerge

withPatchesStrategicMerge(patchesStrategicMerge)

"Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead."

fn spec.postRenderers.kustomize.withPatchesStrategicMergeMixin

withPatchesStrategicMergeMixin(patchesStrategicMerge)

"Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead."

Note: This function appends passed data to existing values

obj spec.postRenderers.kustomize.images

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

fn spec.postRenderers.kustomize.images.withDigest

withDigest(digest)

"Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored."

fn spec.postRenderers.kustomize.images.withName

withName(name)

"Name is a tag-less image name."

fn spec.postRenderers.kustomize.images.withNewName

withNewName(newName)

"NewName is the value used to replace the original name."

fn spec.postRenderers.kustomize.images.withNewTag

withNewTag(newTag)

"NewTag is the value used to replace the original tag."

obj spec.postRenderers.kustomize.patches

"Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors."

fn spec.postRenderers.kustomize.patches.withPatch

withPatch(patch)

"Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects."

obj spec.postRenderers.kustomize.patches.target

"Target points to the resources that the patch document should be applied to."

fn spec.postRenderers.kustomize.patches.target.withAnnotationSelector

withAnnotationSelector(annotationSelector)

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

fn spec.postRenderers.kustomize.patches.target.withGroup

withGroup(group)

"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"

fn spec.postRenderers.kustomize.patches.target.withKind

withKind(kind)

"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"

fn spec.postRenderers.kustomize.patches.target.withLabelSelector

withLabelSelector(labelSelector)

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

fn spec.postRenderers.kustomize.patches.target.withName

withName(name)

"Name to match resources with."

fn spec.postRenderers.kustomize.patches.target.withNamespace

withNamespace(namespace)

"Namespace to select resources from."

fn spec.postRenderers.kustomize.patches.target.withVersion

withVersion(version)

"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"

obj spec.postRenderers.kustomize.patchesJson6902

"JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead."

fn spec.postRenderers.kustomize.patchesJson6902.withPatch

withPatch(patch)

"Patch contains the JSON6902 patch document with an array of operation objects."

fn spec.postRenderers.kustomize.patchesJson6902.withPatchMixin

withPatchMixin(patch)

"Patch contains the JSON6902 patch document with an array of operation objects."

Note: This function appends passed data to existing values

obj spec.postRenderers.kustomize.patchesJson6902.patch

"Patch contains the JSON6902 patch document with an array of operation objects."

fn spec.postRenderers.kustomize.patchesJson6902.patch.withFrom

withFrom(from)

"From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."

fn spec.postRenderers.kustomize.patchesJson6902.patch.withOp

withOp(op)

"Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4"

fn spec.postRenderers.kustomize.patchesJson6902.patch.withPath

withPath(path)

"Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op."

fn spec.postRenderers.kustomize.patchesJson6902.patch.withValue

withValue(value)

"Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations."

obj spec.postRenderers.kustomize.patchesJson6902.target

"Target points to the resources that the patch document should be applied to."

fn spec.postRenderers.kustomize.patchesJson6902.target.withAnnotationSelector

withAnnotationSelector(annotationSelector)

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

fn spec.postRenderers.kustomize.patchesJson6902.target.withGroup

withGroup(group)

"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"

fn spec.postRenderers.kustomize.patchesJson6902.target.withKind

withKind(kind)

"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"

fn spec.postRenderers.kustomize.patchesJson6902.target.withLabelSelector

withLabelSelector(labelSelector)

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

fn spec.postRenderers.kustomize.patchesJson6902.target.withName

withName(name)

"Name to match resources with."

fn spec.postRenderers.kustomize.patchesJson6902.target.withNamespace

withNamespace(namespace)

"Namespace to select resources from."

fn spec.postRenderers.kustomize.patchesJson6902.target.withVersion

withVersion(version)

"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"

obj spec.rollback

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

fn spec.rollback.withCleanupOnFail

withCleanupOnFail(cleanupOnFail)

"CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails."

fn spec.rollback.withDisableHooks

withDisableHooks(disableHooks)

"DisableHooks prevents hooks from running during the Helm rollback action."

fn spec.rollback.withDisableWait

withDisableWait(disableWait)

"DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed."

fn spec.rollback.withDisableWaitForJobs

withDisableWaitForJobs(disableWaitForJobs)

"DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed."

fn spec.rollback.withForce

withForce(force)

"Force forces resource updates through a replacement strategy."

fn spec.rollback.withRecreate

withRecreate(recreate)

"Recreate performs pod restarts for the resource if applicable."

fn spec.rollback.withTimeout

withTimeout(timeout)

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

obj spec.test

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

fn spec.test.withEnable

withEnable(enable)

"Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed."

fn spec.test.withFilters

withFilters(filters)

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

fn spec.test.withFiltersMixin

withFiltersMixin(filters)

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

Note: This function appends passed data to existing values

fn spec.test.withIgnoreFailures

withIgnoreFailures(ignoreFailures)

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

fn spec.test.withTimeout

withTimeout(timeout)

"Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'."

obj spec.test.filters

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

fn spec.test.filters.withExclude

withExclude(exclude)

"Exclude specifies whether the named test should be excluded."

fn spec.test.filters.withName

withName(name)

"Name is the name of the test."

obj spec.uninstall

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

fn spec.uninstall.withDeletionPropagation

withDeletionPropagation(deletionPropagation)

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

fn spec.uninstall.withDisableHooks

withDisableHooks(disableHooks)

"DisableHooks prevents hooks from running during the Helm rollback action."

fn spec.uninstall.withDisableWait

withDisableWait(disableWait)

"DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed."

fn spec.uninstall.withKeepHistory

withKeepHistory(keepHistory)

"KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history."

fn spec.uninstall.withTimeout

withTimeout(timeout)

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

obj spec.upgrade

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

fn spec.upgrade.withCleanupOnFail

withCleanupOnFail(cleanupOnFail)

"CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails."

fn spec.upgrade.withCrds

withCrds(crds)

"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. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n 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."

fn spec.upgrade.withDisableHooks

withDisableHooks(disableHooks)

"DisableHooks prevents hooks from running during the Helm upgrade action."

fn spec.upgrade.withDisableOpenAPIValidation

withDisableOpenAPIValidation(disableOpenAPIValidation)

"DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema."

fn spec.upgrade.withDisableWait

withDisableWait(disableWait)

"DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed."

fn spec.upgrade.withDisableWaitForJobs

withDisableWaitForJobs(disableWaitForJobs)

"DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed."

fn spec.upgrade.withForce

withForce(force)

"Force forces resource updates through a replacement strategy."

fn spec.upgrade.withPreserveValues

withPreserveValues(preserveValues)

"PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative."

fn spec.upgrade.withTimeout

withTimeout(timeout)

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

obj spec.upgrade.remediation

"Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action."

fn spec.upgrade.remediation.withIgnoreTestFailures

withIgnoreTestFailures(ignoreTestFailures)

"IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'."

fn spec.upgrade.remediation.withRemediateLastFailure

withRemediateLastFailure(remediateLastFailure)

"RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0."

fn spec.upgrade.remediation.withRetries

withRetries(retries)

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

fn spec.upgrade.remediation.withStrategy

withStrategy(strategy)

"Strategy to use for failure remediation. Defaults to 'rollback'."

obj spec.valuesFrom

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

fn spec.valuesFrom.withKind

withKind(kind)

"Kind of the values referent, valid values are ('Secret', 'ConfigMap')."

fn spec.valuesFrom.withName

withName(name)

"Name of the values referent. Should reside in the same namespace as the referring resource."

fn spec.valuesFrom.withOptional

withOptional(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."

fn spec.valuesFrom.withTargetPath

withTargetPath(targetPath)

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

fn spec.valuesFrom.withValuesKey

withValuesKey(valuesKey)

"ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'."