Skip to main content
Version: 2.16.x (deprecated)

helm_deployment

A Helm chart deployment.

Backend: pants.backend.experimental.helm

tags​

field.type_hint
required

Arbitrary strings to describe a target.

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

description​

field.type_hint
required

A human-readable description of the target.

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

release_name​

field.type_hint
required

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

dependencies​

field.type_hint
required

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 scie-pants-linux-x86_64 dependencies or scie-pants-linux-x86_64 peek on this target to get the final result.

See https://www.pantsbuild.org/v2.16/docs/targets for more about how addresses are formed, including for generated targets. You can also run scie-pants-linux-x86_64 list :: to find all addresses in your project, or scie-pants-linux-x86_64 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.

sources​

field.type_hint
default: ('*.yaml', '*.yml')

Helm configuration files for a given deployment.

namespace​

field.type_hint
required

Kubernetes namespace for the given deployment.

skip_crds​

field.type_hint
default: False

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

values​

field.type_hint
required

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

create_namespace​

field.type_hint
default: False

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

no_hooks​

field.type_hint
default: False

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

timeout​

field.type_hint
required

Timeout in seconds when running a Helm deployment.

post_renderers​

field.type_hint
required

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.