Skip to main content
Version: 2.24 (prerelease)

helm_deployment

A Helm chart deployment.

Backend: pants.backend.experimental.helm

chart​

str
required

The address of the helm_chart or helm_artifact that will be used for this deployment.

dependencies​

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 https://www.pantsbuild.org/2.24/docs/using-pants/key-concepts/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​

str | None
default: None

A human-readable description of the target.

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

enable_dns​

bool
default: False

Enables DNS lookups when using the getHostByName template function.

kubeconform_ignore_missing_schemas​

bool | None
default: None
backend: pants.backend.experimental.helm.check.kubeconform

Whether to fail if there are missing schemas for custom resources.

kubeconform_ignore_sources​

Iterable[str] | None
default: None
backend: pants.backend.experimental.helm.check.kubeconform

Regular expression patterns specifying paths to ignore.

kubeconform_kubernetes_version​

str | None
default: None
backend: pants.backend.experimental.helm.check.kubeconform

Kubernetes version to use for the validation.

kubeconform_reject_kinds​

Iterable[str] | None
default: None
backend: pants.backend.experimental.helm.check.kubeconform

List of kinds or GVKs to reject.

kubeconform_skip_kinds​

Iterable[str] | None
default: None
backend: pants.backend.experimental.helm.check.kubeconform

List of kinds or GVKs to ignore.

kubeconform_strict​

bool | None
default: None
backend: pants.backend.experimental.helm.check.kubeconform

Run Kubeconform in strict mode.

namespace​

str | None
default: None

Kubernetes namespace for the given deployment.

no_hooks​

bool
default: False

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

post_renderers​

Iterable[str] | None
default: None

List of runnable targets to be used to post-process the helm chart after being rendered by Helm.

This is equivalent to the same post-renderer feature already available in Helm with the difference that this supports a list of executables instead of a single one.

When more than one post-renderer is given, they will be combined into a single one in which the input of each of them would be output of the previous one.

release_name​

str | None
default: None

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

skip_crds​

bool
default: False

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

skip_kubeconform​

bool
default: False
backend: pants.backend.experimental.helm.check.kubeconform

If set to true, do not run any kubeconform checking in this Helm target when running pants check.

sources​

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

Helm configuration files for a given deployment.

tags​

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​

int | None
default: None

Timeout in seconds when running a Helm deployment.

values​

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:

helm_deployment(
    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": f"{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.