The Helm command line (https://helm.sh)
Backend: <span style="color: purple"><code>pants.backend.experimental.helm</code></span> Config section: <span style="color: purple"><code>[helm]</code></span>
## Basic options
<div style="color: purple"> <h3><code>registries</code></h3> <code>--helm-registries="{'key1': val1, 'key2': val2, ...}"</code><br> <code>PANTS_HELM_REGISTRIES</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>{}</code></span>
<br>
Configure Helm OCI registries. The schema for a registry entry is as follows:
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.
</div> <br>
<div style="color: purple"> <h3><code>lint_strict</code></h3> <code>--[no-]helm-lint-strict</code><br> <code>PANTS_HELM_LINT_STRICT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>False</code></span>
<br>
Enables strict linting of Helm charts
</div> <br>
<div style="color: purple"> <h3><code>default_registry_repository</code></h3> <code>--helm-default-registry-repository=<str></code><br> <code>PANTS_HELM_DEFAULT_REGISTRY_REPOSITORY</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</code></span>
<br>
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.
</div> <br>
## Advanced options
<div style="color: purple"> <h3><code>version</code></h3> <code>--helm-version=<str></code><br> <code>PANTS_HELM_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>3.8.0</code></span>
<br>
Use this version of helmsubsystem.
</div> <br>
<div style="color: purple"> <h3><code>known_versions</code></h3> <code>--helm-known-versions="['<str>', '<str>', ...]"</code><br> <code>PANTS_HELM_KNOWN_VERSIONS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "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" ]</pre></span>
<br>
Known versions to verify downloads against.
Each element is a pipe-separated string of `version|platform|sha256|length`, where:
E.g., `3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813`.
Values are space-stripped, so pipes can be indented for readability if necessary.
</div> <br>
<div style="color: purple"> <h3><code>use_unsupported_version</code></h3> <code>--helm-use-unsupported-version=<UnsupportedVersionUsage></code><br> <code>PANTS_HELM_USE_UNSUPPORTED_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">one of: <code>error, warning</code></span><br> <span style="color: green">default: <code>error</code></span>
<br>
What action to take in case the requested version of helmsubsystem is not supported.
Supported helmsubsystem versions: unspecified
</div> <br>
<div style="color: purple"> <h3><code>url_template</code></h3> <code>--helm-url-template=<str></code><br> <code>PANTS_HELM_URL_TEMPLATE</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>https://get.helm.sh/helm-v{version}-{platform}.tar.gz</code></span>
<br>
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.
</div> <br>
<div style="color: purple"> <h3><code>url_platform_mapping</code></h3> <code>--helm-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"</code><br> <code>PANTS_HELM_URL_PLATFORM_MAPPING</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>{ "linux_arm64": "linux-arm64", "linux_x86_64": "linux-amd64", "macos_arm64": "darwin-arm64", "macos_x86_64": "darwin-amd64" }</pre></span>
<br>
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.
</div> <br>
## Deprecated options
None