helm_deployment

A Helm chart deployment.

Backend: pants.backend.experimental.helm

create_namespace

type: bool
default: False

If true, the namespace will be created if it doesn't exist.

dependencies

type: Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use ./pants dependencies or ./pants peek on this target to get the final result.

See Targets and BUILD files for more about how addresses are formed, including for generated targets. You can also run ./pants list :: to find all addresses in your project, or ./pants list dir to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description

type: str | None
default: None

A human-readable description of the target.

Use ./pants list --documented :: to see all targets with descriptions.

namespace

type: str | None
default: None

Kubernetes namespace for the given deployment.

no_hooks

type: bool
default: False

If true, none of the lifecycle hooks of the given chart will be included in the deployment.

release_name

type: str | None
default: None

Name of the release used in the deployment. If not set, the target name will be used instead.

skip_crds

type: bool
default: False

If true, then does not deploy the Custom Resource Definitions that are defined in the chart.

sources

type: Iterable[str] | None
default: ('*.yaml', '*.yml')

Helm configuration files for a given deployment.

tags

type: Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tag='integration_test' test :: to only run on targets with that tag.

timeout

type: int | None
default: None

Timeout in seconds when running a Helm deployment.

values

type: Dict[str, str] | None
default: None

Individual values to use when rendering a given deployment.

Value names should be defined using dot-syntax as in the following example:

    values={
        "nameOverride": "my_custom_name",
        "image.pullPolicy": "Always",
    },
) ```

Values can be dynamically calculated using interpolation as shown in the following example:

``` helm_deployment(
    values={
        "configmap.deployedAt": "{env.DEPLOY_TIME}",
    },
) ```

Check the Helm backend documentation on what are the options available and its caveats when making usage of dynamic values in your deployments.