Chart

Chart is a component representing a collection of resources described by an arbitrary Helm Chart.

The 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.

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.

Create a Chart Resource

new Chart(name: string, args?: ChartOpts, opts?: ComponentResourceOptions);

def Chart(resource_name, config, opts=None);

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

public Chart(string name, ChartArgs? args = null, ComponentResourceOptions? opts = null)

name string: The unique name of the resource.
args ChartOpts: The arguments to resource properties.
opts ComponentResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ChartArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ChartArgs: The arguments to resource properties.
opts ComponentResourceOptions: Bag of options to control resource's behavior.

Chart Resource Properties

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

Inputs

The Chart resource accepts the following input properties:

Chart string

The name of the chart to deploy. If [repo] is provided, this chart name will be prefixed by the repo name. Example: repo: “stable”, chart: “nginx-ingress” -> “stable/nginx-ingress” Example: chart: “stable/nginx-ingress” -> “stable/nginx-ingress”

Required if specifying ChartOpts for a remote chart.

FetchOpts FetchOptsArgs

Additional options to customize the fetching of the Helm chart.

Namespace string

The optional namespace to install chart resources into.

Path string

The path to the chart directory which contains the Chart.yaml file.

Required if specifying LocalChartOpts.

Repo string

The repository name of the chart to deploy. Example: “stable”.

Used only when specifying options for a remote chart.

ResourcePrefix string

An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix=“foo” would produce a resource named “foo-resourceName”.

Transformations List<object>

Optional array of transformations to apply to resources that will be created by this chart prior to creation. Allows customization of the chart behaviour without directly modifying the chart itself.

Values Dictionary<string, object>

Overrides for chart values.

Version string

The version of the chart to deploy. If not provided, the latest version will be deployed.

Chart string

Required if specifying ChartOpts for a remote chart.

FetchOpts FetchOpts

Additional options to customize the fetching of the Helm chart.

Namespace string

The optional namespace to install chart resources into.

Path string

The path to the chart directory which contains the Chart.yaml file.

Required if specifying LocalChartOpts.

Repo string

The repository name of the chart to deploy. Example: “stable”.

Used only when specifying options for a remote chart.

ResourcePrefix string

An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix=“foo” would produce a resource named “foo-resourceName”.

Transformations []interface{}

Optional array of transformations to apply to resources that will be created by this chart prior to creation. Allows customization of the chart behaviour without directly modifying the chart itself.

Values map[string]interface{}

Overrides for chart values.

Version string

The version of the chart to deploy. If not provided, the latest version will be deployed.

chart string

Required if specifying ChartOpts for a remote chart.

fetchOpts FetchOpts

Additional options to customize the fetching of the Helm chart.

namespace string

The optional namespace to install chart resources into.

path string

The path to the chart directory which contains the Chart.yaml file.

Required if specifying LocalChartOpts.

repo string

The repository name of the chart to deploy. Example: “stable”.

Used only when specifying options for a remote chart.

resourcePrefix string

An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix=“foo” would produce a resource named “foo-resourceName”.

transformations any[]

Optional array of transformations to apply to resources that will be created by this chart prior to creation. Allows customization of the chart behaviour without directly modifying the chart itself.

values {[key: string]: any}

Overrides for chart values.

version string

The version of the chart to deploy. If not provided, the latest version will be deployed.

chart str

Required if specifying ChartOpts for a remote chart.

fetch_opts Dict[FetchOpts]

Additional options to customize the fetching of the Helm chart.

namespace str

The optional namespace to install chart resources into.

path str

The path to the chart directory which contains the Chart.yaml file.

Required if specifying LocalChartOpts.

repo str

The repository name of the chart to deploy. Example: “stable”.

Used only when specifying options for a remote chart.

resource_prefix str

An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix=“foo” would produce a resource named “foo-resourceName”.

transformations List[Any]

Optional array of transformations to apply to resources that will be created by this chart prior to creation. Allows customization of the chart behaviour without directly modifying the chart itself.

values Dict[str, Any]

Overrides for chart values.

version str

The version of the chart to deploy. If not provided, the latest version will be deployed.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Resources string
Urn string: urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Id string: The provider-assigned unique ID for this managed resource.
Resources string
Urn string: urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

id string: The provider-assigned unique ID for this managed resource.
resources string
urn string: urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

id str: The provider-assigned unique ID for this managed resource.
resources str
urn str: urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Supporting Types

FetchOpts

See the input API doc for this type.

CaFile string: Verify certificates of HTTPS-enabled servers using this CA bundle.
CertFile string: Identify HTTPS client using this SSL certificate file.
Destination string: Location to write the chart. If this and tardir are specified, tardir is appended to this (default “.”).
Devel bool: Use development versions, too. Equivalent to version ‘>0.0.0-0’. If –version is set, this is ignored.
Home string: Location of your Helm config. Overrides $HELM_HOME (default “/Users/abc/.helm”).
KeyFile string: Identify HTTPS client using this SSL key file.
Keyring string: Keyring containing public keys (default “/Users/abc/.gnupg/pubring.gpg”).
Password string: Chart repository password.
Prov string: Fetch the provenance file, but don’t perform verification.
Repo string: Chart repository url where to locate the requested chart.
Untar bool: If set to false, will leave the chart as a tarball after downloading.
Untardir string: If untar is specified, this flag specifies the name of the directory into which the chart is expanded (default “.”).
Username string: Chart repository username.
Verify string: Verify the package against its signature.
Version string: Specific version of a chart. Without this, the latest version is fetched.

CaFile string: Verify certificates of HTTPS-enabled servers using this CA bundle.
CertFile string: Identify HTTPS client using this SSL certificate file.
Destination string: Location to write the chart. If this and tardir are specified, tardir is appended to this (default “.”).
Devel bool: Use development versions, too. Equivalent to version ‘>0.0.0-0’. If –version is set, this is ignored.
Home string: Location of your Helm config. Overrides $HELM_HOME (default “/Users/abc/.helm”).
KeyFile string: Identify HTTPS client using this SSL key file.
Keyring string: Keyring containing public keys (default “/Users/abc/.gnupg/pubring.gpg”).
Password string: Chart repository password.
Prov string: Fetch the provenance file, but don’t perform verification.
Repo string: Chart repository url where to locate the requested chart.
Untar bool: If set to false, will leave the chart as a tarball after downloading.
Untardir string: If untar is specified, this flag specifies the name of the directory into which the chart is expanded (default “.”).
Username string: Chart repository username.
Verify string: Verify the package against its signature.
Version string: Specific version of a chart. Without this, the latest version is fetched.

caFile string: Verify certificates of HTTPS-enabled servers using this CA bundle.
certFile string: Identify HTTPS client using this SSL certificate file.
destination string: Location to write the chart. If this and tardir are specified, tardir is appended to this (default “.”).
devel boolean: Use development versions, too. Equivalent to version ‘>0.0.0-0’. If –version is set, this is ignored.
home string: Location of your Helm config. Overrides $HELM_HOME (default “/Users/abc/.helm”).
keyFile string: Identify HTTPS client using this SSL key file.
keyring string: Keyring containing public keys (default “/Users/abc/.gnupg/pubring.gpg”).
password string: Chart repository password.
prov string: Fetch the provenance file, but don’t perform verification.
repo string: Chart repository url where to locate the requested chart.
untar boolean: If set to false, will leave the chart as a tarball after downloading.
untardir string: If untar is specified, this flag specifies the name of the directory into which the chart is expanded (default “.”).
username string: Chart repository username.
verify string: Verify the package against its signature.
version string: Specific version of a chart. Without this, the latest version is fetched.

ca_file str: Verify certificates of HTTPS-enabled servers using this CA bundle.
cert_file str: Identify HTTPS client using this SSL certificate file.
destination str: Location to write the chart. If this and tardir are specified, tardir is appended to this (default “.”).
devel bool: Use development versions, too. Equivalent to version ‘>0.0.0-0’. If –version is set, this is ignored.
home str: Location of your Helm config. Overrides $HELM_HOME (default “/Users/abc/.helm”).
key_file str: Identify HTTPS client using this SSL key file.
keyring str: Keyring containing public keys (default “/Users/abc/.gnupg/pubring.gpg”).
password str: Chart repository password.
prov str: Fetch the provenance file, but don’t perform verification.
repo str: Chart repository url where to locate the requested chart.
untar bool: If set to false, will leave the chart as a tarball after downloading.
untardir str: If untar is specified, this flag specifies the name of the directory into which the chart is expanded (default “.”).
username str: Chart repository username.
verify str: Verify the package against its signature.
version str: Specific version of a chart. Without this, the latest version is fetched.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Chart

Create a Chart Resource

Chart Resource Properties

Inputs

Outputs

Supporting Types

FetchOpts

Package Details

On This Page