pulumi-kubernetes-kotlin/com.pulumi.kubernetes.helm.v3.kotlin/ReleaseArgs

ReleaseArgs

data class ReleaseArgs(val allowNullValues: Output<Boolean>? = null, val atomic: Output<Boolean>? = null, val chart: Output<String>? = null, val cleanupOnFail: Output<Boolean>? = null, val compat: Output<String>? = null, val createNamespace: Output<Boolean>? = null, val dependencyUpdate: Output<Boolean>? = null, val description: Output<String>? = null, val devel: Output<Boolean>? = null, val disableCRDHooks: Output<Boolean>? = null, val disableOpenapiValidation: Output<Boolean>? = null, val disableWebhooks: Output<Boolean>? = null, val forceUpdate: Output<Boolean>? = null, val keyring: Output<String>? = null, val lint: Output<Boolean>? = null, val manifest: Output<Map<String, Any>>? = null, val maxHistory: Output<Int>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val postrender: Output<String>? = null, val recreatePods: Output<Boolean>? = null, val renderSubchartNotes: Output<Boolean>? = null, val replace: Output<Boolean>? = null, val repositoryOpts: Output<RepositoryOptsArgs>? = null, val resetValues: Output<Boolean>? = null, val resourceNames: Output<Map<String, List<String>>>? = null, val reuseValues: Output<Boolean>? = null, val skipAwait: Output<Boolean>? = null, val skipCrds: Output<Boolean>? = null, val timeout: Output<Int>? = null, val valueYamlFiles: Output<List<AssetOrArchive>>? = null, val values: Output<Map<String, Any>>? = null, val verify: Output<Boolean>? = null, val version: Output<String>? = null, val waitForJobs: Output<Boolean>? = null) : ConvertibleToJava<ReleaseArgs>

A Release is an instance of a chart running in a Kubernetes cluster. A Chart is a Helm package. It contains all the resource definitions necessary to run an application, tool, or service inside a Kubernetes cluster. This resource models a Helm Release as if it were created by the Helm CLI. The underlying implementation embeds Helm as a library to perform the orchestration of the resources. As a result, the full spectrum of Helm features are supported natively.

Example Usage

Local Chart Directory

No Java example available.

Remote Chart

No Java example available.

Set Chart Values

No Java example available.

Deploy Chart into Namespace

No Java example available.

Depend on a Chart resource

No Java example available.

Specify Helm Chart Values in File and Code

No Java example available.

Query Kubernetes Resource Installed By Helm Chart

No Java example available.

Import

An existing Helm Release resource can be imported using its type token, name and identifier, e.g.

$ pulumi import kubernetes:helm.sh/v3:Release myRelease <namespace>/<releaseName>
Content copied to clipboard

Constructors

Link copied to clipboard
fun ReleaseArgs(allowNullValues: Output<Boolean>? = null, atomic: Output<Boolean>? = null, chart: Output<String>? = null, cleanupOnFail: Output<Boolean>? = null, compat: Output<String>? = null, createNamespace: Output<Boolean>? = null, dependencyUpdate: Output<Boolean>? = null, description: Output<String>? = null, devel: Output<Boolean>? = null, disableCRDHooks: Output<Boolean>? = null, disableOpenapiValidation: Output<Boolean>? = null, disableWebhooks: Output<Boolean>? = null, forceUpdate: Output<Boolean>? = null, keyring: Output<String>? = null, lint: Output<Boolean>? = null, manifest: Output<Map<String, Any>>? = null, maxHistory: Output<Int>? = null, name: Output<String>? = null, namespace: Output<String>? = null, postrender: Output<String>? = null, recreatePods: Output<Boolean>? = null, renderSubchartNotes: Output<Boolean>? = null, replace: Output<Boolean>? = null, repositoryOpts: Output<RepositoryOptsArgs>? = null, resetValues: Output<Boolean>? = null, resourceNames: Output<Map<String, List<String>>>? = null, reuseValues: Output<Boolean>? = null, skipAwait: Output<Boolean>? = null, skipCrds: Output<Boolean>? = null, timeout: Output<Int>? = null, valueYamlFiles: Output<List<AssetOrArchive>>? = null, values: Output<Map<String, Any>>? = null, verify: Output<Boolean>? = null, version: Output<String>? = null, waitForJobs: Output<Boolean>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ReleaseArgs

Properties

Link copied to clipboard
val allowNullValues: Output<Boolean>? = null

Whether to allow Null values in helm chart configs.

Link copied to clipboard
val atomic: Output<Boolean>? = null

If set, installation process purges chart on fail. skipAwait will be disabled automatically if atomic is used.

Link copied to clipboard
val chart: Output<String>? = null

Chart name to be installed. A path may be used.

Link copied to clipboard
val cleanupOnFail: Output<Boolean>? = null

Allow deletion of new resources created in this upgrade when upgrade fails.

Link copied to clipboard
val compat: Output<String>? = null
Link copied to clipboard
val createNamespace: Output<Boolean>? = null

Create the namespace if it does not exist.

Link copied to clipboard
val dependencyUpdate: Output<Boolean>? = null

Run helm dependency update before installing the chart.

Link copied to clipboard
val description: Output<String>? = null

Add a custom description

Link copied to clipboard
val devel: Output<Boolean>? = null

Use chart development versions, too. Equivalent to version '>0.0.0-0'. If version is set, this is ignored.

Link copied to clipboard
val disableCRDHooks: Output<Boolean>? = null

Prevent CRD hooks from running, but run other hooks. See helm install --no-crd-hook

Link copied to clipboard
val disableOpenapiValidation: Output<Boolean>? = null

If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema

Link copied to clipboard
val disableWebhooks: Output<Boolean>? = null

Prevent hooks from running.

Link copied to clipboard
val forceUpdate: Output<Boolean>? = null

Force resource update through delete/recreate if needed.

Link copied to clipboard
val keyring: Output<String>? = null

Location of public keys used for verification. Used only if verify is true

Link copied to clipboard
val lint: Output<Boolean>? = null

Run helm lint when planning.

Link copied to clipboard
val manifest: Output<Map<String, Any>>? = null

The rendered manifests as JSON. Not yet supported.

Link copied to clipboard
val maxHistory: Output<Int>? = null

Limit the maximum number of revisions saved per release. Use 0 for no limit.

Link copied to clipboard
val name: Output<String>? = null

Release name.

Link copied to clipboard
val namespace: Output<String>? = null

Namespace to install the release into.

Link copied to clipboard
val postrender: Output<String>? = null

Postrender command to run.

Link copied to clipboard
val recreatePods: Output<Boolean>? = null

Perform pods restart during upgrade/rollback.

Link copied to clipboard
val renderSubchartNotes: Output<Boolean>? = null

If set, render subchart notes along with the parent.

Link copied to clipboard
val replace: Output<Boolean>? = null

Re-use the given name, even if that name is already used. This is unsafe in production

Link copied to clipboard
val repositoryOpts: Output<RepositoryOptsArgs>? = null

Specification defining the Helm chart repository to use.

Link copied to clipboard
val resetValues: Output<Boolean>? = null

When upgrading, reset the values to the ones built into the chart.

Link copied to clipboard
val resourceNames: Output<Map<String, List<String>>>? = null

Names of resources created by the release grouped by "kind/version".

Link copied to clipboard
val reuseValues: Output<Boolean>? = null

When upgrading, reuse the last release's values and merge in any overrides. If 'resetValues' is specified, this is ignored

Link copied to clipboard
val skipAwait: Output<Boolean>? = null

By default, the provider waits until all resources are in a ready state before marking the release as successful. Setting this to true will skip such await logic.

Link copied to clipboard
val skipCrds: Output<Boolean>? = null

If set, no CRDs will be installed. By default, CRDs are installed if not already present.

Link copied to clipboard
val timeout: Output<Int>? = null

Time in seconds to wait for any individual kubernetes operation.

Link copied to clipboard
val values: Output<Map<String, Any>>? = null

Custom values set for the release.

Link copied to clipboard
val valueYamlFiles: Output<List<AssetOrArchive>>? = null

List of assets (raw yaml files). Content is read and merged with values.

Link copied to clipboard
val verify: Output<Boolean>? = null

Verify the package before installing it.

Link copied to clipboard
val version: Output<String>? = null

Specify the exact chart version to install. If this is not specified, the latest version is installed.

Link copied to clipboard
val waitForJobs: Output<Boolean>? = null

Will wait until all Jobs have been completed before marking the release as successful. This is ignored if skipAwait is enabled.