Release

A Release is an instance of a chart running in a Kubernetes cluster.

A Chart is a Helm package. It contains all of the resource definitions necessary to run an application, tool, or service inside of a Kubernetes cluster.

Create a Release Resource

new Release(name: string, args: ReleaseOpts, opts?: ComponentResourceOptions);
@overload
def Release()
@overload
def Release()
func NewRelease(ctx *Context, name string, args ReleaseArgs, opts ...ResourceOption) (*Release, error)
public Release(string name, ReleaseArgs args, ComponentResourceOptions? opts = null)
name string
The unique name of the resource.
args ReleaseOpts
The arguments to resource properties.
opts ComponentResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ReleaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ReleaseArgs
The arguments to resource properties.
opts ComponentResourceOptions
Bag of options to control resource's behavior.

Release Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Release resource accepts the following input properties:

Chart string
Chart name to be installed. A path may be used.
RepositoryOpts RepositoryOptsArgs
Specification defining the Helm chart repository to use.
Values Dictionary<string, object>
Custom values set for the release.
Atomic bool
If set, installation process purges chart on fail. skipAwait will be disabled automatically if atomic is used.
CleanupOnFail bool
Allow deletion of new resources created in this upgrade when upgrade fails.
CreateNamespace bool
Create the namespace if it does not exist.
DependencyUpdate bool
Run helm dependency update before installing the chart.
Description string
Add a custom description
Devel bool
Use chart development versions, too. Equivalent to version ‘>0.0.0-0’. If version is set, this is ignored.
DisableCRDHooks bool
Prevent CRD hooks from, running, but run other hooks. See helm install –no-crd-hook
DisableOpenapiValidation bool
If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
DisableWebhooks bool
Prevent hooks from running.
ForceUpdate bool
Force resource update through delete/recreate if needed.
Keyring string
Location of public keys used for verification. Used only if verify is true
Lint bool
Run helm lint when planning.
Manifest Dictionary<string, object>
The rendered manifests as JSON. Not yet supported.
MaxHistory int
Limit the maximum number of revisions saved per release. Use 0 for no limit.
Name string
Release name.
Namespace string
Namespace to install the release into.
Postrender string
Postrender command to run.
RecreatePods bool
Perform pods restart during upgrade/rollback.
RenderSubchartNotes bool
If set, render subchart notes along with the parent.
Replace bool
Re-use the given name, even if that name is already used. This is unsafe in production
ResetValues bool
When upgrading, reset the values to the ones built into the chart.
ResourceNames Dictionary<string, ImmutableArray<string>>
Names of resources created by the release grouped by “kind/version”.
ReuseValues bool
When upgrading, reuse the last release’s values and merge in any overrides. If ‘resetValues’ is specified, this is ignored
SkipAwait bool
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.
SkipCrds bool
If set, no CRDs will be installed. By default, CRDs are installed if not already present.
Timeout int
Time in seconds to wait for any individual kubernetes operation.
ValueYamlFiles List<AssetOrArchive>
List of assets (raw yaml files). Content is read and merged with values. Not yet supported.
Verify bool
Verify the package before installing it.
Version string
Specify the exact chart version to install. If this is not specified, the latest version is installed.
WaitForJobs bool
Will wait until all Jobs have been completed before marking the release as successful. This is ignored if skipAwait is enabled.
Chart string
Chart name to be installed. A path may be used.
RepositoryOpts RepositoryOptsArgs
Specification defining the Helm chart repository to use.
Values map[string]interface{}
Custom values set for the release.
Atomic bool
If set, installation process purges chart on fail. skipAwait will be disabled automatically if atomic is used.
CleanupOnFail bool
Allow deletion of new resources created in this upgrade when upgrade fails.
CreateNamespace bool
Create the namespace if it does not exist.
DependencyUpdate bool
Run helm dependency update before installing the chart.
Description string
Add a custom description
Devel bool
Use chart development versions, too. Equivalent to version ‘>0.0.0-0’. If version is set, this is ignored.
DisableCRDHooks bool
Prevent CRD hooks from, running, but run other hooks. See helm install –no-crd-hook
DisableOpenapiValidation bool
If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
DisableWebhooks bool
Prevent hooks from running.
ForceUpdate bool
Force resource update through delete/recreate if needed.
Keyring string
Location of public keys used for verification. Used only if verify is true
Lint bool
Run helm lint when planning.
Manifest map[string]interface{}
The rendered manifests as JSON. Not yet supported.
MaxHistory int
Limit the maximum number of revisions saved per release. Use 0 for no limit.
Name string
Release name.
Namespace string
Namespace to install the release into.
Postrender string
Postrender command to run.
RecreatePods bool
Perform pods restart during upgrade/rollback.
RenderSubchartNotes bool
If set, render subchart notes along with the parent.
Replace bool
Re-use the given name, even if that name is already used. This is unsafe in production
ResetValues bool
When upgrading, reset the values to the ones built into the chart.
ResourceNames map[string][]string
Names of resources created by the release grouped by “kind/version”.
ReuseValues bool
When upgrading, reuse the last release’s values and merge in any overrides. If ‘resetValues’ is specified, this is ignored
SkipAwait bool
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.
SkipCrds bool
If set, no CRDs will be installed. By default, CRDs are installed if not already present.
Timeout int
Time in seconds to wait for any individual kubernetes operation.
ValueYamlFiles AssetOrArchive
List of assets (raw yaml files). Content is read and merged with values. Not yet supported.
Verify bool
Verify the package before installing it.
Version string
Specify the exact chart version to install. If this is not specified, the latest version is installed.
WaitForJobs bool
Will wait until all Jobs have been completed before marking the release as successful. This is ignored if skipAwait is enabled.
chart string
Chart name to be installed. A path may be used.
repositoryOpts helm.sh.v3.RepositoryOptsArgs
Specification defining the Helm chart repository to use.
values {[key: string]: any}
Custom values set for the release.
atomic boolean
If set, installation process purges chart on fail. skipAwait will be disabled automatically if atomic is used.
cleanupOnFail boolean
Allow deletion of new resources created in this upgrade when upgrade fails.
createNamespace boolean
Create the namespace if it does not exist.
dependencyUpdate boolean
Run helm dependency update before installing the chart.
description string
Add a custom description
devel boolean
Use chart development versions, too. Equivalent to version ‘>0.0.0-0’. If version is set, this is ignored.
disableCRDHooks boolean
Prevent CRD hooks from, running, but run other hooks. See helm install –no-crd-hook
disableOpenapiValidation boolean
If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
disableWebhooks boolean
Prevent hooks from running.
forceUpdate boolean
Force resource update through delete/recreate if needed.
keyring string
Location of public keys used for verification. Used only if verify is true
lint boolean
Run helm lint when planning.
manifest {[key: string]: any}
The rendered manifests as JSON. Not yet supported.
maxHistory number
Limit the maximum number of revisions saved per release. Use 0 for no limit.
name string
Release name.
namespace string
Namespace to install the release into.
postrender string
Postrender command to run.
recreatePods boolean
Perform pods restart during upgrade/rollback.
renderSubchartNotes boolean
If set, render subchart notes along with the parent.
replace boolean
Re-use the given name, even if that name is already used. This is unsafe in production
resetValues boolean
When upgrading, reset the values to the ones built into the chart.
resourceNames {[key: string]: string[]}
Names of resources created by the release grouped by “kind/version”.
reuseValues boolean
When upgrading, reuse the last release’s values and merge in any overrides. If ‘resetValues’ is specified, this is ignored
skipAwait boolean
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.
skipCrds boolean
If set, no CRDs will be installed. By default, CRDs are installed if not already present.
timeout number
Time in seconds to wait for any individual kubernetes operation.
valueYamlFiles pulumi.asset.Asset | pulumi.asset.Archive[]
List of assets (raw yaml files). Content is read and merged with values. Not yet supported.
verify boolean
Verify the package before installing it.
version string
Specify the exact chart version to install. If this is not specified, the latest version is installed.
waitForJobs boolean
Will wait until all Jobs have been completed before marking the release as successful. This is ignored if skipAwait is enabled.
chart str
Chart name to be installed. A path may be used.
repository_opts RepositoryOptsArgs
Specification defining the Helm chart repository to use.
values Mapping[str, Any]
Custom values set for the release.
atomic bool
If set, installation process purges chart on fail. skipAwait will be disabled automatically if atomic is used.
cleanup_on_fail bool
Allow deletion of new resources created in this upgrade when upgrade fails.
create_namespace bool
Create the namespace if it does not exist.
dependency_update bool
Run helm dependency update before installing the chart.
description str
Add a custom description
devel bool
Use chart development versions, too. Equivalent to version ‘>0.0.0-0’. If version is set, this is ignored.
disable_crd_hooks bool
Prevent CRD hooks from, running, but run other hooks. See helm install –no-crd-hook
disable_openapi_validation bool
If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
disable_webhooks bool
Prevent hooks from running.
force_update bool
Force resource update through delete/recreate if needed.
keyring str
Location of public keys used for verification. Used only if verify is true
lint bool
Run helm lint when planning.
manifest Mapping[str, Any]
The rendered manifests as JSON. Not yet supported.
max_history int
Limit the maximum number of revisions saved per release. Use 0 for no limit.
name str
Release name.
namespace str
Namespace to install the release into.
postrender str
Postrender command to run.
recreate_pods bool
Perform pods restart during upgrade/rollback.
render_subchart_notes bool
If set, render subchart notes along with the parent.
replace bool
Re-use the given name, even if that name is already used. This is unsafe in production
reset_values bool
When upgrading, reset the values to the ones built into the chart.
resource_names Mapping[str, Sequence[str]]
Names of resources created by the release grouped by “kind/version”.
reuse_values bool
When upgrading, reuse the last release’s values and merge in any overrides. If ‘resetValues’ is specified, this is ignored
skip_await bool
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.
skip_crds bool
If set, no CRDs will be installed. By default, CRDs are installed if not already present.
timeout int
Time in seconds to wait for any individual kubernetes operation.
value_yaml_files Archive]]
List of assets (raw yaml files). Content is read and merged with values. Not yet supported.
verify bool
Verify the package before installing it.
version str
Specify the exact chart version to install. If this is not specified, the latest version is installed.
wait_for_jobs bool
Will wait until all Jobs have been completed before marking the release as successful. This is ignored if skipAwait is enabled.

Outputs

All input properties are implicitly available as output properties. Additionally, the Release resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Status ReleaseStatus
Status of the deployed release.
Id string
The provider-assigned unique ID for this managed resource.
Status ReleaseStatus
Status of the deployed release.
id string
The provider-assigned unique ID for this managed resource.
status helm.sh.v3.ReleaseStatus
Status of the deployed release.
id str
The provider-assigned unique ID for this managed resource.
status ReleaseStatus
Status of the deployed release.

Supporting Types

ReleaseStatus

Status string
Status of the release.
AppVersion string
The version number of the application being deployed.
Chart string
The name of the chart.
Name string
Name is the name of the release.
Namespace string
Namespace is the kubernetes namespace of the release.
Revision int
Version is an int32 which represents the version of the release.
Version string
A SemVer 2 conformant version string of the chart.
Status string
Status of the release.
AppVersion string
The version number of the application being deployed.
Chart string
The name of the chart.
Name string
Name is the name of the release.
Namespace string
Namespace is the kubernetes namespace of the release.
Revision int
Version is an int32 which represents the version of the release.
Version string
A SemVer 2 conformant version string of the chart.
status string
Status of the release.
appVersion string
The version number of the application being deployed.
chart string
The name of the chart.
name string
Name is the name of the release.
namespace string
Namespace is the kubernetes namespace of the release.
revision number
Version is an int32 which represents the version of the release.
version string
A SemVer 2 conformant version string of the chart.
status str
Status of the release.
app_version str
The version number of the application being deployed.
chart str
The name of the chart.
name str
Name is the name of the release.
namespace str
Namespace is the kubernetes namespace of the release.
revision int
Version is an int32 which represents the version of the release.
version str
A SemVer 2 conformant version string of the chart.

RepositoryOpts

CaFile string
The Repository’s CA File
CertFile string
The repository’s cert file
KeyFile string
The repository’s cert key file
Password string
Password for HTTP basic authentication
Repo string
Repository where to locate the requested chart. If is a URL the chart is installed without installing the repository.
Username string
Username for HTTP basic authentication
CaFile string
The Repository’s CA File
CertFile string
The repository’s cert file
KeyFile string
The repository’s cert key file
Password string
Password for HTTP basic authentication
Repo string
Repository where to locate the requested chart. If is a URL the chart is installed without installing the repository.
Username string
Username for HTTP basic authentication
caFile string
The Repository’s CA File
certFile string
The repository’s cert file
keyFile string
The repository’s cert key file
password string
Password for HTTP basic authentication
repo string
Repository where to locate the requested chart. If is a URL the chart is installed without installing the repository.
username string
Username for HTTP basic authentication
ca_file str
The Repository’s CA File
cert_file str
The repository’s cert file
key_file str
The repository’s cert key file
password str
Password for HTTP basic authentication
repo str
Repository where to locate the requested chart. If is a URL the chart is installed without installing the repository.
username str
Username for HTTP basic authentication

Package Details

Repository
https://github.com/pulumi/pulumi-kubernetes
License
Apache-2.0