The Helm command line (https://helm.sh)

Backend: pants.backend.experimental.helm
Config section: [helm]

Basic options

registries

--helm-registries="{'key1': val1, 'key2': val2, ...}"

PANTS_HELM_REGISTRIES

default: {}

Configure Helm OCI registries. The schema for a registry entry is as follows:

{
    "registry-alias": {
        "address": "oci://registry-domain:port",
        "default": bool,
    },
    ...
}

If no registries are provided in either a helm_chart target, then all default addresses will be used, if any.

The helm_chart.registries may be provided with a list of registry addresses and registry alias prefixed with @ to be used instead of the defaults.

A configured registry is marked as default either by setting default = true or with an alias of "default".

Registries also participate in resolving third party Helm charts uplodaded to those registries.


lint_strict

--[no-]helm-lint-strict

PANTS_HELM_LINT_STRICT

default: False

Enables strict linting of Helm charts


default_registry_repository

--helm-default-registry-repository=<str>

PANTS_HELM_DEFAULT_REGISTRY_REPOSITORY

default: None

Default location where to push Helm charts in the available registries when no specific one has been given.

If no registry repository is given, charts will be pushed to the root of the OCI registry.


Advanced options

version

--helm-version=<str>

PANTS_HELM_VERSION

default: 3.8.0

Use this version of helmsubsystem.


known_versions

--helm-known-versions="['<str>', '<str>', ...]"

PANTS_HELM_KNOWN_VERSIONS

default:
[
  "3.8.0|linux_arm64 |23e08035dc0106fe4e0bd85800fd795b2b9ecd9f32187aa16c49b0a917105161|12324642",
  "3.8.0|linux_x86_64|8408c91e846c5b9ba15eb6b1a5a79fc22dd4d33ac6ea63388e5698d1b2320c8b|13626774",
  "3.8.0|macos_arm64 |751348f1a4a876ffe089fd68df6aea310fd05fe3b163ab76aa62632e327122f3|14078604",
  "3.8.0|macos_x86_64|532ddd6213891084873e5c2dcafa577f425ca662a6594a3389e288fc48dc2089|14318316"
]

Known versions to verify downloads against.

Each element is a pipe-separated string of version|platform|sha256|length, where:

- `version` is the version string
- `platform` is one of [linux_arm64,linux_x86_64,macos_arm64,macos_x86_64],
- `sha256` is the 64-character hex representation of the expected sha256
digest of the download file, as emitted by `shasum -a 256`
- `length` is the expected length of the download file in bytes, as emitted by
`wc -c`

E.g., 3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813.

Values are space-stripped, so pipes can be indented for readability if necessary.


use_unsupported_version

--helm-use-unsupported-version=<UnsupportedVersionUsage>

PANTS_HELM_USE_UNSUPPORTED_VERSION

one of: error, warning
default: error

What action to take in case the requested version of helmsubsystem is not supported.

Supported helmsubsystem versions: unspecified


url_template

--helm-url-template=<str>

PANTS_HELM_URL_TEMPLATE

default: https://get.helm.sh/helm-v{version}-{platform}.tar.gz

URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a file:$abspath URL (e.g. file:/this/is/absolute, possibly by templating the buildroot in a config file).

Use {version} to have the value from --version substituted, and {platform} to have a value from --url-platform-mapping substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.


url_platform_mapping

--helm-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"

PANTS_HELM_URL_PLATFORM_MAPPING

default:
{
  "linux_arm64": "linux-arm64",
  "linux_x86_64": "linux-amd64",
  "macos_arm64": "darwin-arm64",
  "macos_x86_64": "darwin-amd64"
}

A dictionary mapping platforms to strings to be used when generating the URL to download the tool.

In --url-template, anytime the {platform} string is used, Pants will determine the current platform, and substitute {platform} with the respective value from your dictionary.

For example, if you define {"macos_x86_64": "apple-darwin", "linux_x86_64": "unknown-linux"}, and run Pants on Linux with an intel architecture, then {platform} will be substituted in the --url-template option with unknown-linux.


tailor

--[no-]helm-tailor

PANTS_HELM_TAILOR

default: True

If true, add helm_chart targets with the tailor goal.


Deprecated options

None


Did this page help you?