helm.v1beta1.release

"A Release is an example API type"

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of Release

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"

fn metadata.withSelfLink

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

"A ReleaseSpec defines the desired state of a Release."

fn spec.withConnectionDetails

withConnectionDetails(connectionDetails)

fn spec.withConnectionDetailsMixin

withConnectionDetailsMixin(connectionDetails)

Note: This function appends passed data to existing values

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

fn spec.withRollbackLimit

withRollbackLimit(rollbackLimit)

"RollbackRetriesLimit is max number of attempts to retry Helm deployment by rolling back the release."

obj spec.connectionDetails

fn spec.connectionDetails.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.connectionDetails.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future."

fn spec.connectionDetails.withKind

withKind(kind)

"Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.connectionDetails.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.connectionDetails.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.connectionDetails.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.connectionDetails.withSkipPartOfReleaseCheck

withSkipPartOfReleaseCheck(skipPartOfReleaseCheck)

"SkipPartOfReleaseCheck skips check for meta.helm.sh/release-name annotation."

fn spec.connectionDetails.withToConnectionSecretKey

withToConnectionSecretKey(toConnectionSecretKey)

fn spec.connectionDetails.withUid

withUid(uid)

"UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.forProvider

"ReleaseParameters are the configurable fields of a Release."

fn spec.forProvider.withInsecureSkipTLSVerify

withInsecureSkipTLSVerify(insecureSkipTLSVerify)

"InsecureSkipTLSVerify skips tls certificate checks for the chart download"

fn spec.forProvider.withNamespace

withNamespace(namespace)

"Namespace to install the release into."

fn spec.forProvider.withPatchesFrom

withPatchesFrom(patchesFrom)

"PatchesFrom describe patches to be applied to the rendered manifests."

fn spec.forProvider.withPatchesFromMixin

withPatchesFromMixin(patchesFrom)

"PatchesFrom describe patches to be applied to the rendered manifests."

Note: This function appends passed data to existing values

fn spec.forProvider.withSet

withSet(set)

fn spec.forProvider.withSetMixin

withSetMixin(set)

Note: This function appends passed data to existing values

fn spec.forProvider.withSkipCRDs

withSkipCRDs(skipCRDs)

"SkipCRDs skips installation of CRDs for the release."

fn spec.forProvider.withSkipCreateNamespace

withSkipCreateNamespace(skipCreateNamespace)

"SkipCreateNamespace won't create the namespace for the release. This requires the namespace to already exist."

fn spec.forProvider.withValues

withValues(values)

fn spec.forProvider.withValuesFrom

withValuesFrom(valuesFrom)

fn spec.forProvider.withValuesFromMixin

withValuesFromMixin(valuesFrom)

Note: This function appends passed data to existing values

fn spec.forProvider.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

fn spec.forProvider.withWait

withWait(wait)

"Wait for the release to become ready."

fn spec.forProvider.withWaitTimeout

withWaitTimeout(waitTimeout)

"WaitTimeout is the duration Helm will wait for the release to become ready. Only applies if wait is also set. Defaults to 5m."

obj spec.forProvider.chart

"A ChartSpec defines the chart spec for a Release"

fn spec.forProvider.chart.withName

withName(name)

"Name of Helm chart, required if ChartSpec.URL not set"

fn spec.forProvider.chart.withRepository

withRepository(repository)

"Repository: Helm repository URL, required if ChartSpec.URL not set"

fn spec.forProvider.chart.withUrl

withUrl(url)

"URL to chart package (typically .tgz), optional and overrides others fields in the spec"

fn spec.forProvider.chart.withVersion

withVersion(version)

"Version of Helm chart, late initialized with latest version if not set"

obj spec.forProvider.chart.pullSecretRef

"PullSecretRef is reference to the secret containing credentials to helm repository"

fn spec.forProvider.chart.pullSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.chart.pullSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.patchesFrom

"PatchesFrom describe patches to be applied to the rendered manifests."

obj spec.forProvider.patchesFrom.configMapKeyRef

"DataKeySelector defines required spec to access a key of a configmap or secret"

fn spec.forProvider.patchesFrom.configMapKeyRef.withKey

withKey(key)

fn spec.forProvider.patchesFrom.configMapKeyRef.withName

withName(name)

fn spec.forProvider.patchesFrom.configMapKeyRef.withNamespace

withNamespace(namespace)

fn spec.forProvider.patchesFrom.configMapKeyRef.withOptional

withOptional(optional)

obj spec.forProvider.patchesFrom.secretKeyRef

"DataKeySelector defines required spec to access a key of a configmap or secret"

fn spec.forProvider.patchesFrom.secretKeyRef.withKey

withKey(key)

fn spec.forProvider.patchesFrom.secretKeyRef.withName

withName(name)

fn spec.forProvider.patchesFrom.secretKeyRef.withNamespace

withNamespace(namespace)

fn spec.forProvider.patchesFrom.secretKeyRef.withOptional

withOptional(optional)

obj spec.forProvider.set

fn spec.forProvider.set.withName

withName(name)

fn spec.forProvider.set.withValue

withValue(value)

obj spec.forProvider.set.valueFrom

"ValueFromSource represents source of a value"

obj spec.forProvider.set.valueFrom.configMapKeyRef

"DataKeySelector defines required spec to access a key of a configmap or secret"

fn spec.forProvider.set.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.forProvider.set.valueFrom.configMapKeyRef.withName

withName(name)

fn spec.forProvider.set.valueFrom.configMapKeyRef.withNamespace

withNamespace(namespace)

fn spec.forProvider.set.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

obj spec.forProvider.set.valueFrom.secretKeyRef

"DataKeySelector defines required spec to access a key of a configmap or secret"

fn spec.forProvider.set.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.forProvider.set.valueFrom.secretKeyRef.withName

withName(name)

fn spec.forProvider.set.valueFrom.secretKeyRef.withNamespace

withNamespace(namespace)

fn spec.forProvider.set.valueFrom.secretKeyRef.withOptional

withOptional(optional)

obj spec.forProvider.valuesFrom

obj spec.forProvider.valuesFrom.configMapKeyRef

"DataKeySelector defines required spec to access a key of a configmap or secret"

fn spec.forProvider.valuesFrom.configMapKeyRef.withKey

withKey(key)

fn spec.forProvider.valuesFrom.configMapKeyRef.withName

withName(name)

fn spec.forProvider.valuesFrom.configMapKeyRef.withNamespace

withNamespace(namespace)

fn spec.forProvider.valuesFrom.configMapKeyRef.withOptional

withOptional(optional)

obj spec.forProvider.valuesFrom.secretKeyRef

"DataKeySelector defines required spec to access a key of a configmap or secret"

fn spec.forProvider.valuesFrom.secretKeyRef.withKey

withKey(key)

fn spec.forProvider.valuesFrom.secretKeyRef.withName

withName(name)

fn spec.forProvider.valuesFrom.secretKeyRef.withNamespace

withNamespace(namespace)

fn spec.forProvider.valuesFrom.secretKeyRef.withOptional

withOptional(optional)

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."