v4

type Chart ¶

type Chart struct {
	pulumi.ResourceState

	// Resources created by the Chart.
	Resources pulumi.ArrayOutput `pulumi:"resources"`
}

_Looking for the Release resource? Please use the [v3 package](/registry/packages/kubernetes/api-docs/helm/v3/release/) for production use cases, and stay tuned for an updated Release resource, coming soon._

_See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_

Chart is a component representing a collection of resources described by a Helm Chart. Helm charts are a popular packaging format for Kubernetes applications, and published to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&sort=relevance&page=1).

Chart does not use Tiller or create a Helm Release; the semantics are equivalent to running `helm template --dry-run=server` and then using Pulumi to deploy the resulting YAML manifests. This allows you to apply [Pulumi Transformations](https://www.pulumi.com/docs/concepts/options/transformations/) and [Pulumi Policies](https://www.pulumi.com/docs/using-pulumi/crossguard/) to the Kubernetes resources.

You may also want to consider the `Release` resource as an alternative method for managing helm charts. For more information about the trade-offs between these options, see: [Choosing the right Helm resource for your use case](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/choosing-the-right-helm-resource-for-your-use-case).

### Chart Resolution

The Helm Chart can be fetched from any source that is accessible to the `helm` command line. The following variations are supported:

1. By chart reference with repo prefix: `chart: "example/mariadb"` 2. By path to a packaged chart: `chart: "./nginx-1.2.3.tgz"` 3. By path to an unpacked chart directory: `chart: "./nginx"` 4. By absolute URL: `chart: "https://example.com/charts/nginx-1.2.3.tgz"` 5. By chart reference with repo URL: `chart: "nginx", repositoryOpts: { repo: "https://example.com/charts/" }` 6. By OCI registry: `chart: "oci://example.com/charts/nginx", version: "1.2.3"`

A chart reference is a convenient way of referencing a chart in a chart repository.

When you use a chart reference with a repo prefix (`example/mariadb`), Pulumi will look in Helm's local configuration for a chart repository named `example`, and will then look for a chart in that repository whose name is `mariadb`. It will install the latest stable version of that chart, unless you specify `devel` to also include development versions (alpha, beta, and release candidate releases), or supply a version number with `version`.

Use the `verify` and optional `keyring` inputs to enable Chart verification. By default, Pulumi uses the keyring at `$HOME/.gnupg/pubring.gpg`. See: [Helm Provenance and Integrity](https://helm.sh/docs/topics/provenance/).

### Chart Values

[Values files](https://helm.sh/docs/chart_template_guide/values_files/#helm) (`values.yaml`) may be supplied with the `valueYamlFiles` input, accepting [Pulumi Assets](https://www.pulumi.com/docs/concepts/assets-archives/#assets).

A map of chart values may also be supplied with the `values` input, with highest precedence. You're able to use literals, nested maps, [Pulumi outputs](https://www.pulumi.com/docs/concepts/inputs-outputs/), and Pulumi assets as values. Assets are automatically opened and converted to a string.

Note that the use of expressions (e.g. `--set service.type`) is not supported.

### Chart Dependency Resolution

For unpacked chart directories, Pulumi automatically rebuilds the dependencies if dependencies are missing and a `Chart.lock` file is present (see: [Helm Dependency Build](https://helm.sh/docs/helm/helm_dependency_build/)). Use the `dependencyUpdate` input to have Pulumi update the dependencies (see: [Helm Dependency Update](https://helm.sh/docs/helm/helm_dependency_update/)).

### Templating

The `Chart` resource renders the templates from your chart and then manages the resources directly with the Pulumi Kubernetes provider. A default namespace is applied based on the `namespace` input, the provider's configured namespace, and the active Kubernetes context. Use the `skipCrds` option to skip installing the Custom Resource Definition (CRD) objects located in the chart's `crds/` special directory.

Use the `postRenderer` input to pipe the rendered manifest through a [post-rendering command](https://helm.sh/docs/topics/advanced/#post-rendering).

### Resource Ordering

Sometimes resources must be applied in a specific order. For example, a namespace resource must be created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.

Pulumi uses heuristics to determine which order to apply and delete objects within the Chart. Pulumi also waits for each object to be fully reconciled, unless `skipAwait` is enabled.

Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource. The annotation accepts a list of resource references, delimited by commas.

Note that references to resources outside the Chart aren't supported.

**Resource reference**

A resource reference is a string that uniquely identifies a resource.

It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.

| Resource Scope | Format | | :--------------- | :--------------------------------------------- | | namespace-scoped | `<group>/namespaces/<namespace>/<kind>/<name>` | | cluster-scoped | `<group>/<kind>/<name>` |

For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).

## Example Usage ### Local Chart Directory ```go package main

import (

helmv4 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v4"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := helmv4.NewChart(ctx, "nginx", &helmv4.ChartArgs{
			Chart: pulumi.String("./nginx"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Repository Chart ```go package main

import (

helmv4 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v4"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := helmv4.NewChart(ctx, "nginx", &helmv4.ChartArgs{
			Chart: pulumi.String("nginx"),
			RepositoryOpts: &helmv4.RepositoryOptsArgs{
				Repo: pulumi.String("https://charts.bitnami.com/bitnami"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### OCI Chart ```go package main

import (

helmv4 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v4"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := helmv4.NewChart(ctx, "nginx", &helmv4.ChartArgs{
			Chart:   pulumi.String("oci://registry-1.docker.io/bitnamicharts/nginx"),
			Version: pulumi.String("16.0.7"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Chart Values ```go package main

import (

helmv4 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v4"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := helmv4.NewChart(ctx, "nginx", &helmv4.ChartArgs{
			Chart: pulumi.String("nginx"),
			RepositoryOpts: &helmv4.RepositoryOptsArgs{
				Repo: pulumi.String("https://charts.bitnami.com/bitnami"),
			},
			ValueYamlFiles: pulumi.AssetOrArchiveArray{
				pulumi.NewFileAsset("./values.yaml"),
			},
			Values: pulumi.Map{
				"service": pulumi.Map{
					"type": pulumi.String("ClusterIP"),
				},
				"notes": pulumi.NewFileAsset("./notes.txt"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Chart Namespace ```go package main

import (

corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/core/v1"
helmv4 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v4"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ns, err := corev1.NewNamespace(ctx, "nginx", &corev1.NamespaceArgs{
			Metadata: &metav1.ObjectMetaArgs{Name: pulumi.String("nginx")},
		})
		if err != nil {
			return err
		}
		_, err = helmv4.NewChart(ctx, "nginx", &helmv4.ChartArgs{
            Namespace: ns.Metadata.Name(),
			Chart:     pulumi.String("nginx"),
			RepositoryOpts: &helmv4.RepositoryOptsArgs{
				Repo: pulumi.String("https://charts.bitnami.com/bitnami"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func NewChart(ctx *pulumi.Context,
	name string, args *ChartArgs, opts ...pulumi.ResourceOption) (*Chart, error)

func (*Chart) ElementType() reflect.Type

func (i *Chart) ToChartOutput() ChartOutput

func (i *Chart) ToChartOutputWithContext(ctx context.Context) ChartOutput

type ChartArgs ¶

type ChartArgs struct {
	// Chart name to be installed. A path may be used.
	Chart pulumi.StringInput
	// Run helm dependency update before installing the chart.
	DependencyUpdate pulumi.BoolPtrInput
	// Use chart development versions, too. Equivalent to version '>0.0.0-0'. If `version` is set, this is ignored.
	Devel pulumi.BoolPtrInput
	// Location of public keys used for verification. Used only if `verify` is true
	Keyring pulumi.AssetOrArchiveInput
	// Release name.
	Name pulumi.StringPtrInput
	// Namespace for the release.
	Namespace pulumi.StringPtrInput
	// Use insecure HTTP for the chart download instead of HTTPS.
	PlainHttp pulumi.BoolPtrInput
	// Specification defining the post-renderer to use.
	PostRenderer PostRendererPtrInput
	// Specification defining the Helm chart repository to use.
	RepositoryOpts RepositoryOptsPtrInput
	// An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
	ResourcePrefix pulumi.StringPtrInput
	// 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.
	SkipAwait pulumi.BoolPtrInput
	// If set, no CRDs will be installed. By default, CRDs are installed if not already present.
	SkipCrds pulumi.BoolPtrInput
	// List of assets (raw yaml files). Content is read and merged with values.
	ValueYamlFiles pulumi.AssetOrArchiveArrayInput
	// Custom values set for the release.
	Values pulumi.MapInput
	// Verify the chart's integrity.
	Verify pulumi.BoolPtrInput
	// Specify the chart version to install. If this is not specified, the latest version is installed.
	Version pulumi.StringPtrInput
}

The set of arguments for constructing a Chart resource.

func (ChartArgs) ElementType() reflect.Type

type ChartArray ¶

type ChartArray []ChartInput

func (ChartArray) ElementType() reflect.Type

func (i ChartArray) ToChartArrayOutput() ChartArrayOutput

func (i ChartArray) ToChartArrayOutputWithContext(ctx context.Context) ChartArrayOutput

type ChartArrayInput ¶

type ChartArrayInput interface {
	pulumi.Input

	ToChartArrayOutput() ChartArrayOutput
	ToChartArrayOutputWithContext(context.Context) ChartArrayOutput
}

ChartArrayInput is an input type that accepts ChartArray and ChartArrayOutput values. You can construct a concrete instance of `ChartArrayInput` via:

ChartArray{ ChartArgs{...} }

type ChartArrayOutput ¶

type ChartArrayOutput struct{ *pulumi.OutputState }

func (ChartArrayOutput) ElementType() reflect.Type

func (o ChartArrayOutput) Index(i pulumi.IntInput) ChartOutput

func (o ChartArrayOutput) ToChartArrayOutput() ChartArrayOutput

func (o ChartArrayOutput) ToChartArrayOutputWithContext(ctx context.Context) ChartArrayOutput

type ChartInput ¶

type ChartInput interface {
	pulumi.Input

	ToChartOutput() ChartOutput
	ToChartOutputWithContext(ctx context.Context) ChartOutput
}

type ChartMap ¶

type ChartMap map[string]ChartInput

func (ChartMap) ElementType() reflect.Type

func (i ChartMap) ToChartMapOutput() ChartMapOutput

func (i ChartMap) ToChartMapOutputWithContext(ctx context.Context) ChartMapOutput

type ChartMapInput ¶

type ChartMapInput interface {
	pulumi.Input

	ToChartMapOutput() ChartMapOutput
	ToChartMapOutputWithContext(context.Context) ChartMapOutput
}

ChartMapInput is an input type that accepts ChartMap and ChartMapOutput values. You can construct a concrete instance of `ChartMapInput` via:

ChartMap{ "key": ChartArgs{...} }

type ChartMapOutput ¶

type ChartMapOutput struct{ *pulumi.OutputState }

func (ChartMapOutput) ElementType() reflect.Type

func (o ChartMapOutput) MapIndex(k pulumi.StringInput) ChartOutput

func (o ChartMapOutput) ToChartMapOutput() ChartMapOutput

func (o ChartMapOutput) ToChartMapOutputWithContext(ctx context.Context) ChartMapOutput

type ChartOutput ¶

type ChartOutput struct{ *pulumi.OutputState }

func (ChartOutput) ElementType() reflect.Type

func (o ChartOutput) Resources() pulumi.ArrayOutput

func (o ChartOutput) ToChartOutput() ChartOutput

func (o ChartOutput) ToChartOutputWithContext(ctx context.Context) ChartOutput

type PostRenderer ¶

type PostRenderer struct {
	// Arguments to pass to the post-renderer command.
	Args []string `pulumi:"args"`
	// Path to an executable to be used for post rendering.
	Command string `pulumi:"command"`
}

Specification defining the post-renderer to use.

type PostRendererArgs ¶

type PostRendererArgs struct {
	// Arguments to pass to the post-renderer command.
	Args pulumi.StringArrayInput `pulumi:"args"`
	// Path to an executable to be used for post rendering.
	Command pulumi.StringInput `pulumi:"command"`
}

Specification defining the post-renderer to use.

func (PostRendererArgs) ElementType() reflect.Type

func (i PostRendererArgs) ToPostRendererOutput() PostRendererOutput

func (i PostRendererArgs) ToPostRendererOutputWithContext(ctx context.Context) PostRendererOutput

func (i PostRendererArgs) ToPostRendererPtrOutput() PostRendererPtrOutput

func (i PostRendererArgs) ToPostRendererPtrOutputWithContext(ctx context.Context) PostRendererPtrOutput

type PostRendererInput ¶

type PostRendererInput interface {
	pulumi.Input

	ToPostRendererOutput() PostRendererOutput
	ToPostRendererOutputWithContext(context.Context) PostRendererOutput
}

PostRendererInput is an input type that accepts PostRendererArgs and PostRendererOutput values. You can construct a concrete instance of `PostRendererInput` via:

PostRendererArgs{...}

type PostRendererOutput ¶

type PostRendererOutput struct{ *pulumi.OutputState }

Specification defining the post-renderer to use.

func (o PostRendererOutput) Args() pulumi.StringArrayOutput

func (o PostRendererOutput) Command() pulumi.StringOutput

func (PostRendererOutput) ElementType() reflect.Type

func (o PostRendererOutput) ToPostRendererOutput() PostRendererOutput

func (o PostRendererOutput) ToPostRendererOutputWithContext(ctx context.Context) PostRendererOutput

func (o PostRendererOutput) ToPostRendererPtrOutput() PostRendererPtrOutput

func (o PostRendererOutput) ToPostRendererPtrOutputWithContext(ctx context.Context) PostRendererPtrOutput

type PostRendererPtrInput ¶

type PostRendererPtrInput interface {
	pulumi.Input

	ToPostRendererPtrOutput() PostRendererPtrOutput
	ToPostRendererPtrOutputWithContext(context.Context) PostRendererPtrOutput
}

PostRendererPtrInput is an input type that accepts PostRendererArgs, PostRendererPtr and PostRendererPtrOutput values. You can construct a concrete instance of `PostRendererPtrInput` via:

        PostRendererArgs{...}

or:

        nil

func PostRendererPtr(v *PostRendererArgs) PostRendererPtrInput

type PostRendererPtrOutput ¶

type PostRendererPtrOutput struct{ *pulumi.OutputState }

func (o PostRendererPtrOutput) Args() pulumi.StringArrayOutput

func (o PostRendererPtrOutput) Command() pulumi.StringPtrOutput

func (o PostRendererPtrOutput) Elem() PostRendererOutput

func (PostRendererPtrOutput) ElementType() reflect.Type

func (o PostRendererPtrOutput) ToPostRendererPtrOutput() PostRendererPtrOutput

func (o PostRendererPtrOutput) ToPostRendererPtrOutputWithContext(ctx context.Context) PostRendererPtrOutput

type RepositoryOpts ¶

type RepositoryOpts struct {
	// The Repository's CA File
	CaFile pulumi.AssetOrArchive `pulumi:"caFile"`
	// The repository's cert file
	CertFile pulumi.AssetOrArchive `pulumi:"certFile"`
	// The repository's cert key file
	KeyFile pulumi.AssetOrArchive `pulumi:"keyFile"`
	// Password for HTTP basic authentication
	Password *string `pulumi:"password"`
	// Repository where to locate the requested chart. If it's a URL the chart is installed without installing the repository.
	Repo *string `pulumi:"repo"`
	// Username for HTTP basic authentication
	Username *string `pulumi:"username"`
}

Specification defining the Helm chart repository to use.

type RepositoryOptsArgs ¶

type RepositoryOptsArgs struct {
	// The Repository's CA File
	CaFile pulumi.AssetOrArchiveInput `pulumi:"caFile"`
	// The repository's cert file
	CertFile pulumi.AssetOrArchiveInput `pulumi:"certFile"`
	// The repository's cert key file
	KeyFile pulumi.AssetOrArchiveInput `pulumi:"keyFile"`
	// Password for HTTP basic authentication
	Password pulumi.StringPtrInput `pulumi:"password"`
	// Repository where to locate the requested chart. If it's a URL the chart is installed without installing the repository.
	Repo pulumi.StringPtrInput `pulumi:"repo"`
	// Username for HTTP basic authentication
	Username pulumi.StringPtrInput `pulumi:"username"`
}

Specification defining the Helm chart repository to use.

func (RepositoryOptsArgs) ElementType() reflect.Type

func (i RepositoryOptsArgs) ToRepositoryOptsOutput() RepositoryOptsOutput

func (i RepositoryOptsArgs) ToRepositoryOptsOutputWithContext(ctx context.Context) RepositoryOptsOutput

func (i RepositoryOptsArgs) ToRepositoryOptsPtrOutput() RepositoryOptsPtrOutput

func (i RepositoryOptsArgs) ToRepositoryOptsPtrOutputWithContext(ctx context.Context) RepositoryOptsPtrOutput

type RepositoryOptsInput ¶

type RepositoryOptsInput interface {
	pulumi.Input

	ToRepositoryOptsOutput() RepositoryOptsOutput
	ToRepositoryOptsOutputWithContext(context.Context) RepositoryOptsOutput
}

RepositoryOptsInput is an input type that accepts RepositoryOptsArgs and RepositoryOptsOutput values. You can construct a concrete instance of `RepositoryOptsInput` via:

RepositoryOptsArgs{...}

type RepositoryOptsOutput ¶

type RepositoryOptsOutput struct{ *pulumi.OutputState }

Specification defining the Helm chart repository to use.

func (o RepositoryOptsOutput) CaFile() pulumi.AssetOrArchiveOutput

func (o RepositoryOptsOutput) CertFile() pulumi.AssetOrArchiveOutput

func (RepositoryOptsOutput) ElementType() reflect.Type

func (o RepositoryOptsOutput) KeyFile() pulumi.AssetOrArchiveOutput

func (o RepositoryOptsOutput) Password() pulumi.StringPtrOutput

func (o RepositoryOptsOutput) Repo() pulumi.StringPtrOutput

func (o RepositoryOptsOutput) ToRepositoryOptsOutput() RepositoryOptsOutput

func (o RepositoryOptsOutput) ToRepositoryOptsOutputWithContext(ctx context.Context) RepositoryOptsOutput

func (o RepositoryOptsOutput) ToRepositoryOptsPtrOutput() RepositoryOptsPtrOutput

func (o RepositoryOptsOutput) ToRepositoryOptsPtrOutputWithContext(ctx context.Context) RepositoryOptsPtrOutput

func (o RepositoryOptsOutput) Username() pulumi.StringPtrOutput

type RepositoryOptsPtrInput ¶

type RepositoryOptsPtrInput interface {
	pulumi.Input

	ToRepositoryOptsPtrOutput() RepositoryOptsPtrOutput
	ToRepositoryOptsPtrOutputWithContext(context.Context) RepositoryOptsPtrOutput
}

RepositoryOptsPtrInput is an input type that accepts RepositoryOptsArgs, RepositoryOptsPtr and RepositoryOptsPtrOutput values. You can construct a concrete instance of `RepositoryOptsPtrInput` via:

        RepositoryOptsArgs{...}

or:

        nil

func RepositoryOptsPtr(v *RepositoryOptsArgs) RepositoryOptsPtrInput

type RepositoryOptsPtrOutput ¶

type RepositoryOptsPtrOutput struct{ *pulumi.OutputState }

func (o RepositoryOptsPtrOutput) CaFile() pulumi.AssetOrArchiveOutput

func (o RepositoryOptsPtrOutput) CertFile() pulumi.AssetOrArchiveOutput

func (o RepositoryOptsPtrOutput) Elem() RepositoryOptsOutput

func (RepositoryOptsPtrOutput) ElementType() reflect.Type

func (o RepositoryOptsPtrOutput) KeyFile() pulumi.AssetOrArchiveOutput

func (o RepositoryOptsPtrOutput) Password() pulumi.StringPtrOutput

func (o RepositoryOptsPtrOutput) Repo() pulumi.StringPtrOutput

func (o RepositoryOptsPtrOutput) ToRepositoryOptsPtrOutput() RepositoryOptsPtrOutput

func (o RepositoryOptsPtrOutput) ToRepositoryOptsPtrOutputWithContext(ctx context.Context) RepositoryOptsPtrOutput

func (o RepositoryOptsPtrOutput) Username() pulumi.StringPtrOutput