v3¶

class pulumi_kubernetes.helm.v3.BaseChartOpts(namespace=None, values=None, transformations=None, resource_prefix=None)¶

BaseChartOpts is a bag of common configuration options for a Helm chart.

Parameters

• namespace (Optional[pulumi.Input[str]]) – Optional namespace to install chart resources into.

• values (Optional[pulumi.Inputs]) – Optional overrides for chart values.

• Optional[pulumi.ResourceOptions]]]] transformations (Optional[List[Tuple[Callable,) – Optional list 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.

• resource_prefix (Optional[str]) – An optional prefix for the auto-generated resource names. Example: A resource created with resource_prefix=”foo” would produce a resource named “foo-resourceName”.

namespace: Optional[pulumi.Input[str]] = None¶

Optional namespace to install chart resources into.

values: Optional[pulumi.Inputs] = None¶

Optional overrides for chart values.

transformations: Optional[List[Callable]] = None¶

Optional list 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.

resource_prefix: Optional[str] = None¶

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

class pulumi_kubernetes.helm.v3.Chart(release_name, config, opts=None)¶

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 an instance of the specified Helm chart.

Parameters

• release_name (str) – Name of the Chart (e.g., nginx-ingress).

• LocalChartOpts] config (Union[ChartOpts,) – Configuration options for the Chart.

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

resources: pulumi.Output[dict] = None¶

Kubernetes resources contained in this Chart.

get_resource(group_version_kind, name, namespace=None) → pulumi.output.Output[pulumi.resource.CustomResource][pulumi.resource.CustomResource]¶

get_resource returns a resource defined by a built-in Kubernetes group/version/kind and name. For example: get_resource("apps/v1/Deployment", "nginx")

Parameters

• group_version_kind (str) – Group/Version/Kind of the resource, e.g., apps/v1/Deployment

• name (str) – Name of the resource to retrieve

• namespace (str) – Optional namespace of the resource to retrieve

class pulumi_kubernetes.helm.v3.ChartOpts(chart, namespace=None, values=None, transformations=None, resource_prefix=None, repo=None, version=None, fetch_opts=None)¶

ChartOpts is a bag of configuration options for a remote Helm chart.

Parameters

• chart (pulumi.Input[str]) – 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”

• namespace (Optional[pulumi.Input[str]]) – Optional namespace to install chart resources into.

• values (Optional[pulumi.Inputs]) – Optional overrides for chart values.

• Optional[pulumi.ResourceOptions]]]] transformations (Optional[List[Tuple[Callable,) – Optional list 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.

• resource_prefix (Optional[str]) – An optional prefix for the auto-generated resource names. Example: A resource created with resource_prefix=”foo” would produce a resource named “foo-resourceName”.

• repo (Optional[pulumi.Input[str]]) – The repository name of the chart to deploy. Example: “stable”

• version (Optional[pulumi.Input[str]]) – The version of the chart to deploy. If not provided, the latest version will be deployed.

• fetch_opts (Optional[pulumi.Input[FetchOpts]]) – Additional options to customize the fetching of the Helm chart.

chart: pulumi.Input[str] = None¶

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”

repo: Optional[pulumi.Input[str]] = None¶

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

version: Optional[pulumi.Input[str]] = None¶

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

fetch_opts: Optional[pulumi.Input[FetchOpts]] = None¶

Additional options to customize the fetching of the Helm chart.

class pulumi_kubernetes.helm.v3.FetchOpts(version=None, ca_file=None, cert_file=None, key_file=None, destination=None, keyring=None, password=None, repo=None, untar_dir=None, username=None, home=None, devel=None, prov=None, untar=None, verify=None)¶

FetchOpts is a bag of configuration options to customize the fetching of the Helm chart.

Parameters

• version (Optional[pulumi.Input[str]]) – Specific version of a chart. If unset, the latest version is fetched.

• ca_file (Optional[pulumi.Input[str]]) – Verify certificates of HTTPS-enabled servers using this CA bundle.

• cert_file (Optional[pulumi.Input[str]]) – Identify HTTPS client using this SSL certificate file.

• key_file (Optional[pulumi.Input[str]]) – Identify HTTPS client using this SSL key file.

• destination (Optional[pulumi.Input[str]]) – Location to write the chart. If this and [tardir] are specified, tardir is appended to this (default “.”).

• keyring (Optional[pulumi.Input[str]]) – Keyring containing public keys (default “/Users//.gnupg/pubring.gpg”).

• password (Optional[pulumi.Input[str]]) – Chart repository password.

• repo (Optional[pulumi.Input[str]]) – Chart repository url where to locate the requested chart.

• untar_dir (Optional[pulumi.Input[str]]) – If [untar] is specified, this flag specifies the name of the directory into which the chart is expanded (default “.”).

• username (Optional[pulumi.Input[str]]) – Chart repository username.

• home (Optional[pulumi.Input[str]]) – Location of your Helm config. Overrides $HELM_HOME (default “/Users//.helm”).

• devel (Optional[pulumi.Input[bool]]) – Use development versions, too. Equivalent to version ‘>0.0.0-0’. If [version] is set, this is ignored.

• prov (Optional[pulumi.Input[bool]]) – Fetch the provenance file, but don’t perform verification.

• untar (Optional[pulumi.Input[bool]]) – If set to false, will leave the chart as a tarball after downloading.

• verify (Optional[pulumi.Input[bool]]) – Verify the package against its signature.

version: Optional[pulumi.Input[str]] = None¶

Specific version of a chart. If unset, the latest version is fetched.

ca_file: Optional[pulumi.Input[str]] = None¶

Verify certificates of HTTPS-enabled servers using this CA bundle.

cert_file: Optional[pulumi.Input[str]] = None¶

Identify HTTPS client using this SSL certificate file.

key_file: Optional[pulumi.Input[str]] = None¶

Identify HTTPS client using this SSL key file.

destination: Optional[pulumi.Input[str]] = None¶

Location to write the chart. If this and [tardir] are specified, tardir is appended to this (default “.”).

keyring: Optional[pulumi.Input[str]] = None¶

Keyring containing public keys (default “/Users/alex/.gnupg/pubring.gpg”).

password: Optional[pulumi.Input[str]] = None¶

Chart repository password.

repo: Optional[pulumi.Input[str]] = None¶

Chart repository url where to locate the requested chart.

untar_dir: Optional[pulumi.Input[str]] = None¶

If [untar] is specified, this flag specifies the name of the directory into which the chart is expanded (default “.”).

username: Optional[pulumi.Input[str]] = None¶

Chart repository username.

home: Optional[pulumi.Input[str]] = None¶

Location of your Helm config. Overrides $HELM_HOME (default “/Users/alex/.helm”).

devel: Optional[pulumi.Input[bool]] = None¶

Use development versions, too. Equivalent to version ‘>0.0.0-0’. If [version] is set, this is ignored.

prov: Optional[pulumi.Input[bool]] = None¶

Fetch the provenance file, but don’t perform verification.

untar: Optional[pulumi.Input[bool]] = None¶

If set to false, will leave the chart as a tarball after downloading.

verify: Optional[pulumi.Input[bool]] = None¶

Verify the package against its signature.

class pulumi_kubernetes.helm.v3.LocalChartOpts(path, namespace=None, values=None, transformations=None, resource_prefix=None)¶

LocalChartOpts is a bag of configuration options for a local Helm chart.

Parameters

• path (pulumi.Input[str]) – The path to the chart directory which contains the Chart.yaml file.

• namespace (Optional[pulumi.Input[str]]) – Optional namespace to install chart resources into.

• values (Optional[pulumi.Inputs]) – Optional overrides for chart values.

• Optional[pulumi.ResourceOptions]]]] transformations (Optional[List[Tuple[Callable,) – Optional list 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.

• resource_prefix (Optional[str]) – An optional prefix for the auto-generated resource names. Example: A resource created with resource_prefix=”foo” would produce a resource named “foo-resourceName”.

path: pulumi.Input[str] = None¶

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

class pulumi_kubernetes.helm.v3.TextIO¶

Typed version of the return of open() in text mode.

pulumi_kubernetes.helm.v3.get_version()¶

Returns the Semver-formatted version of the package containing this file.

pulumi_kubernetes.helm.v3.mkdtemp(suffix=None, prefix=None, dir=None)¶

User-callable function to create and return a unique temporary directory. The return value is the pathname of the directory.

Arguments are as for mkstemp, except that the ‘text’ argument is not accepted.

The directory is readable, writable, and searchable only by the creating user.

Caller is responsible for deleting the directory when done with it.

pulumi_kubernetes.helm.v3.mkstemp(suffix=None, prefix=None, dir=None, text=False)¶

User-callable function to create and return a unique temporary file. The return value is a pair (fd, name) where fd is the file descriptor returned by os.open, and name is the filename.

If ‘suffix’ is not None, the file name will end with that suffix, otherwise there will be no suffix.

If ‘prefix’ is not None, the file name will begin with that prefix, otherwise a default prefix is used.

If ‘dir’ is not None, the file will be created in that directory, otherwise a default directory is used.

If ‘text’ is specified and true, the file is opened in text mode. Else (the default) the file is opened in binary mode. On some operating systems, this makes no difference.

If any of ‘suffix’, ‘prefix’ and ‘dir’ are not None, they must be the same type. If they are bytes, the returned name will be bytes; str otherwise.

The file is readable and writable only by the creating user ID. If the operating system uses permission bits to indicate whether a file is executable, the file is executable by no one. The file descriptor is not inherited by children of this process.

Caller is responsible for deleting the file when done with it.