Chart class
{{% notes type="info" %}} A newer version of this resource is available as kubernetes.helm.sh/v4.Chart. See the corresponding blog post for more information. {{% /notes %}}
Chart is a component representing a collection of resources described by an arbitrary Helm Chart.
The Helm Chart can be fetched from any source that is accessible to the helm command line. Values in the values.yml file can be overridden using ChartOpts.values (equivalent to --set or having multiple values.yml files). Objects can be transformed arbitrarily by supplying callbacks to ChartOpts.transformations.
The Chart resource renders the templates from your chart and then manage them directly with the Pulumi Kubernetes provider.
Chart does not use Tiller. The Chart specified is copied and expanded locally; the semantics are equivalent to running helm template and then using Pulumi to manage the resulting YAML manifests. Any values that would be retrieved in-cluster are assigned fake values, and none of Tiller's server-side validity testing is executed.
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
This resource is provided for the following languages: Node.js (JavaScript, TypeScript), Python, Go, and .NET (C#, F#, VB).
{{% examples %}}
Example Usage
{{% example %}}
Local Chart Directory
import * as k8s from "@pulumi/kubernetes";
const nginxIngress = new k8s.helm.v3.Chart("nginx-ingress", {
path: "./nginx-ingress",
});
from pulumi_kubernetes.helm.v3 import Chart, LocalChartOpts
nginx_ingress = Chart(
"nginx-ingress",
LocalChartOpts(
path="./nginx-ingress",
),
)
using System.Threading.Tasks;
using Pulumi;
using Pulumi.Kubernetes.Helm;
using Pulumi.Kubernetes.Helm.V3;
class HelmStack : Stack
{
public HelmStack()
{
var nginx = new Chart("nginx-ingress", new LocalChartArgs
{
Path = "./nginx-ingress",
});
}
}
package main
import (
"github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := helm.NewChart(ctx, "nginx-ingress", helm.ChartArgs{
Path: pulumi.String("./nginx-ingress"),
})
if err != nil {
return err
}
return nil
})
}
{{% /example %}} {{% example %}}
Remote Chart
import * as k8s from "@pulumi/kubernetes";
const nginxIngress = new k8s.helm.v3.Chart("nginx-ingress", {
chart: "nginx-ingress",
version: "1.24.4",
fetchOpts:{
repo: "https://charts.helm.sh/stable",
},
});
from pulumi_kubernetes.helm.v3 import Chart, ChartOpts, FetchOpts
nginx_ingress = Chart(
"nginx-ingress",
ChartOpts(
chart="nginx-ingress",
version="1.24.4",
fetch_opts=FetchOpts(
repo="https://charts.helm.sh/stable",
),
),
)
using System.Threading.Tasks;
using Pulumi;
using Pulumi.Kubernetes.Helm;
using Pulumi.Kubernetes.Helm.V3;
class HelmStack : Stack
{
public HelmStack()
{
var nginx = new Chart("nginx-ingress", new ChartArgs
{
Chart = "nginx-ingress",
Version = "1.24.4",
FetchOptions = new ChartFetchArgs
{
Repo = "https://charts.helm.sh/stable"
}
});
}
}
package main
import (
"github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := helm.NewChart(ctx, "nginx-ingress", helm.ChartArgs{
Chart: pulumi.String("nginx-ingress"),
Version: pulumi.String("1.24.4"),
FetchArgs: helm.FetchArgs{
Repo: pulumi.String("https://charts.helm.sh/stable"),
},
})
if err != nil {
return err
}
return nil
})
}
{{% /example %}} {{% example %}}
Set Chart Values
import * as k8s from "@pulumi/kubernetes";
const nginxIngress = new k8s.helm.v3.Chart("nginx-ingress", {
chart: "nginx-ingress",
version: "1.24.4",
fetchOpts:{
repo: "https://charts.helm.sh/stable",
},
values: {
controller: {
metrics: {
enabled: true,
}
}
},
});
from pulumi_kubernetes.helm.v3 import Chart, ChartOpts, FetchOpts
nginx_ingress = Chart(
"nginx-ingress",
ChartOpts(
chart="nginx-ingress",
version="1.24.4",
fetch_opts=FetchOpts(
repo="https://charts.helm.sh/stable",
),
values={
"controller": {
"metrics": {
"enabled": True,
},
},
},
),
)
using System.Collections.Generic;
using System.Threading.Tasks;
using Pulumi;
using Pulumi.Kubernetes.Helm;
using Pulumi.Kubernetes.Helm.V3;
class HelmStack : Stack
{
public HelmStack()
{
var values = new Dictionary<string, object>
{
["controller"] = new Dictionary<string, object>
{
["metrics"] = new Dictionary<string, object>
{
["enabled"] = true
}
},
};
var nginx = new Chart("nginx-ingress", new ChartArgs
{
Chart = "nginx-ingress",
Version = "1.24.4",
FetchOptions = new ChartFetchArgs
{
Repo = "https://charts.helm.sh/stable"
},
Values = values,
});
}
}
package main
import (
"github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := helm.NewChart(ctx, "nginx-ingress", helm.ChartArgs{
Chart: pulumi.String("nginx-ingress"),
Version: pulumi.String("1.24.4"),
FetchArgs: helm.FetchArgs{
Repo: pulumi.String("https://charts.helm.sh/stable"),
},
Values: pulumi.Map{
"controller": pulumi.Map{
"metrics": pulumi.Map{
"enabled": pulumi.Bool(true),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
{{% /example %}} {{% example %}}
Deploy Chart into Namespace
import * as k8s from "@pulumi/kubernetes";
const nginxIngress = new k8s.helm.v3.Chart("nginx-ingress", {
chart: "nginx-ingress",
version: "1.24.4",
namespace: "test-namespace",
fetchOpts:{
repo: "https://charts.helm.sh/stable",
},
});
from pulumi_kubernetes.helm.v3 import Chart, ChartOpts, FetchOpts
nginx_ingress = Chart(
"nginx-ingress",
ChartOpts(
chart="nginx-ingress",
version="1.24.4",
namespace="test-namespace",
fetch_opts=FetchOpts(
repo="https://charts.helm.sh/stable",
),
),
)
using System.Threading.Tasks;
using Pulumi;
using Pulumi.Kubernetes.Helm;
using Pulumi.Kubernetes.Helm.V3;
class HelmStack : Stack
{
public HelmStack()
{
var nginx = new Chart("nginx-ingress", new ChartArgs
{
Chart = "nginx-ingress",
Version = "1.24.4",
Namespace = "test-namespace",
FetchOptions = new ChartFetchArgs
{
Repo = "https://charts.helm.sh/stable"
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := helm.NewChart(ctx, "nginx-ingress", helm.ChartArgs{
Chart: pulumi.String("nginx-ingress"),
Version: pulumi.String("1.24.4"),
Namespace: pulumi.String("test-namespace"),
FetchArgs: helm.FetchArgs{
Repo: pulumi.String("https://charts.helm.sh/stable"),
},
})
if err != nil {
return err
}
return nil
})
}
{{% /example %}} {{% example %}}
Depend on a Chart resource
import * as k8s from "@pulumi/kubernetes";
const nginxIngress = new k8s.helm.v3.Chart("nginx-ingress", {
chart: "nginx-ingress",
version: "1.24.4",
namespace: "test-namespace",
fetchOpts:{
repo: "https://charts.helm.sh/stable",
},
});
// Create a ConfigMap depending on the Chart. The ConfigMap will not be created until after all of the Chart
// resources are ready. Note the use of the `ready` attribute; depending on the Chart resource directly will not work.
new k8s.core.v1.ConfigMap("foo", {
metadata: { namespace: namespaceName },
data: {foo: "bar"}
}, {dependsOn: nginxIngress.ready})
import pulumi
from pulumi_kubernetes.core.v1 import ConfigMap, ConfigMapInitArgs
from pulumi_kubernetes.helm.v3 import Chart, ChartOpts, FetchOpts
nginx_ingress = Chart(
"nginx-ingress",
ChartOpts(
chart="nginx-ingress",
version="1.24.4",
namespace="test-namespace",
fetch_opts=FetchOpts(
repo="https://charts.helm.sh/stable",
),
),
)
# Create a ConfigMap depending on the Chart. The ConfigMap will not be created until after all of the Chart
# resources are ready. Note the use of the `ready` attribute; depending on the Chart resource directly will not work.
ConfigMap("foo", ConfigMapInitArgs(data={"foo": "bar"}), opts=pulumi.ResourceOptions(depends_on=nginx_ingress.ready))
using System.Threading.Tasks;
using Pulumi;
using Pulumi.Kubernetes.Core.V1;
using Pulumi.Kubernetes.Helm;
using Pulumi.Kubernetes.Helm.V3;
class HelmStack : Stack
{
public HelmStack()
{
var nginx = new Chart("nginx-ingress", new ChartArgs
{
Chart = "nginx-ingress",
Version = "1.24.4",
Namespace = "test-namespace",
FetchOptions = new ChartFetchArgs
{
Repo = "https://charts.helm.sh/stable"
},
});
// Create a ConfigMap depending on the Chart. The ConfigMap will not be created until after all of the Chart
// resources are ready. Note the use of the `Ready()` method; depending on the Chart resource directly will
// not work.
new ConfigMap("foo", new Pulumi.Kubernetes.Types.Inputs.Core.V1.ConfigMapArgs
{
Data = new InputMap<string>
{
{"foo", "bar"}
},
}, new CustomResourceOptions
{
DependsOn = nginx.Ready(),
});
}
}
package main
import (
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/core/v1"
"github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := helm.NewChart(ctx, "nginx-ingress", helm.ChartArgs{
Chart: pulumi.String("nginx-ingress"),
Version: pulumi.String("1.24.4"),
Namespace: pulumi.String("test-namespace"),
FetchArgs: helm.FetchArgs{
Repo: pulumi.String("https://charts.helm.sh/stable"),
},
})
if err != nil {
return err
}
// Create a ConfigMap depending on the Chart. The ConfigMap will not be created until after all of the Chart
// resources are ready. Note the use of the `Ready` attribute, which is used with `DependsOnInputs` rather than
// `DependsOn`. Depending on the Chart resource directly, or using `DependsOn` will not work.
_, err = corev1.NewConfigMap(ctx, "cm", &corev1.ConfigMapArgs{
Data: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
}, pulumi.DependsOnInputs(chart.Ready))
if err != nil {
return err
}
return nil
})
}
{{% /example %}} {{% example %}}
Chart with Transformations
import * as k8s from "@pulumi/kubernetes";
const nginxIngress = new k8s.helm.v3.Chart("nginx-ingress", {
chart: "nginx-ingress",
version: "1.24.4",
fetchOpts:{
repo: "https://charts.helm.sh/stable",
},
transformations: [
// Make every service private to the cluster, i.e., turn all services into ClusterIP instead of LoadBalancer.
(obj: any, opts: pulumi.CustomResourceOptions) => {
if (obj.kind === "Service" && obj.apiVersion === "v1") {
if (obj.spec && obj.spec.type && obj.spec.type === "LoadBalancer") {
obj.spec.type = "ClusterIP";
}
}
},
// Set a resource alias for a previous name.
(obj: any, opts: pulumi.CustomResourceOptions) => {
if (obj.kind === "Deployment") {
opts.aliases = [{ name: "oldName" }]
}
},
// Omit a resource from the Chart by transforming the specified resource definition to an empty List.
(obj: any, opts: pulumi.CustomResourceOptions) => {
if (obj.kind === "Pod" && obj.metadata.name === "test") {
obj.apiVersion = "v1"
obj.kind = "List"
}
},
],
});
from pulumi_kubernetes.helm.v3 import Chart, ChartOpts, FetchOpts
# Make every service private to the cluster, i.e., turn all services into ClusterIP instead of LoadBalancer.
def make_service_private(obj, opts):
if obj["kind"] == "Service" and obj["apiVersion"] == "v1":
try:
t = obj["spec"]["type"]
if t == "LoadBalancer":
obj["spec"]["type"] = "ClusterIP"
except KeyError:
pass
# Set a resource alias for a previous name.
def alias(obj, opts):
if obj["kind"] == "Deployment":
opts.aliases = ["oldName"]
# Omit a resource from the Chart by transforming the specified resource definition to an empty List.
def omit_resource(obj, opts):
if obj["kind"] == "Pod" and obj["metadata"]["name"] == "test":
obj["apiVersion"] = "v1"
obj["kind"] = "List"
nginx_ingress = Chart(
"nginx-ingress",
ChartOpts(
chart="nginx-ingress",
version="1.24.4",
fetch_opts=FetchOpts(
repo="https://charts.helm.sh/stable",
),
transformations=[make_service_private, alias, omit_resource],
),
)
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Threading.Tasks;
using Pulumi;
using Pulumi.Kubernetes.Helm;
using Pulumi.Kubernetes.Helm.V3;
class HelmStack : Stack
{
public HelmStack()
{
var nginx = new Chart("nginx-ingress", new ChartArgs
{
Chart = "nginx-ingress",
Version = "1.24.4",
FetchOptions = new ChartFetchArgs
{
Repo = "https://charts.helm.sh/stable"
},
Transformations =
{
LoadBalancerToClusterIP,
ResourceAlias,
OmitTestPod,
}
});
// Make every service private to the cluster, i.e., turn all services into ClusterIP instead of LoadBalancer.
ImmutableDictionary<string, object> LoadBalancerToClusterIP(ImmutableDictionary<string, object> obj, CustomResourceOptions opts)
{
if ((string)obj["kind"] == "Service" && (string)obj["apiVersion"] == "v1")
{
var spec = (ImmutableDictionary<string, object>)obj["spec"];
if (spec != null && (string)spec["type"] == "LoadBalancer")
{
return obj.SetItem("spec", spec.SetItem("type", "ClusterIP"));
}
}
return obj;
}
// Set a resource alias for a previous name.
ImmutableDictionary<string, object> ResourceAlias(ImmutableDictionary<string, object> obj, CustomResourceOptions opts)
{
if ((string)obj["kind"] == "Deployment")
{
opts.Aliases.Add(new Alias { Name = "oldName" });
}
return obj;
}
// Omit a resource from the Chart by transforming the specified resource definition to an empty List.
ImmutableDictionary<string, object> OmitTestPod(ImmutableDictionary<string, object> obj, CustomResourceOptions opts)
{
var metadata = (ImmutableDictionary<string, object>)obj["metadata"];
if ((string)obj["kind"] == "Pod" && (string)metadata["name"] == "test")
{
return new Dictionary<string, object>
{
["apiVersion"] = "v1",
["kind"] = "List",
["items"] = new Dictionary<string, object>(),
}.ToImmutableDictionary();
}
return obj;
}
}
}
package main
import (
"github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/helm/v3"
"github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/yaml"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := helm.NewChart(ctx, "nginx-ingress", helm.ChartArgs{
Chart: pulumi.String("nginx-ingress"),
Version: pulumi.String("1.24.4"),
FetchArgs: helm.FetchArgs{
Repo: pulumi.String("https://charts.helm.sh/stable"),
},
Transformations: []yaml.Transformation{
// Make every service private to the cluster, i.e., turn all services into ClusterIP
// instead of LoadBalancer.
func(state map[string]interface{}, opts ...pulumi.ResourceOption) {
if state["kind"] == "Service" {
spec := state["spec"].(map[string]interface{})
spec["type"] = "ClusterIP"
}
},
// Set a resource alias for a previous name.
func(state map[string]interface{}, opts ...pulumi.ResourceOption) {
if state["kind"] == "Deployment" {
aliases := pulumi.Aliases([]pulumi.Alias{
{
Name: pulumi.String("oldName"),
},
})
opts = append(opts, aliases)
}
},
// Omit a resource from the Chart by transforming the specified resource definition
// to an empty List.
func(state map[string]interface{}, opts ...pulumi.ResourceOption) {
name := state["metadata"].(map[string]interface{})["name"]
if state["kind"] == "Pod" && name == "test" {
state["apiVersion"] = "core/v1"
state["kind"] = "List"
}
},
},
})
if err != nil {
return err
}
return nil
})
}
{{% /example %}} {{% /examples %}}
Constructors
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
-
resources
↔ Output<
String?> -
Resources created by the Chart.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
registerOutputs(
[Map< String, dynamic> ? outputs]) → void -
Registers component outputs with the engine.
inherited
-
registerOutputsAsync(
Future< Map< outputs) → Future<String, dynamic> >void> -
Async variant of
registerOutputs.inherited -
registerOutputsOutput(
Output< Map< outputs) → voidString, dynamic> > -
Registers an already-computed output map.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited