Skip to main content
Version: 2.11 (deprecated)

download-terraform

Terraform (https://terraform.io)

Backend: pants.backend.experimental.terraform

Config section: [download-terraform]

Basic options​

None

Advanced options​

known_versions​

--download-terraform-known-versions="['<str>', '<str>', ...]"
PANTS_DOWNLOAD_TERRAFORM_KNOWN_VERSIONS
pants.toml
[download-terraform]
known_versions = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "1.0.7|macos_arm64 |cbab9aca5bc4e604565697355eed185bb699733811374761b92000cc188a7725|32071346",
  "1.0.7|macos_x86_64|80ae021d6143c7f7cbf4571f65595d154561a2a25fd934b7a8ccc1ebf3014b9b|33020029",
  "1.0.7|linux_x86_64|bc79e47649e2529049a356f9e60e06b47462bf6743534a10a4c16594f443be7b|32671441"
]

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.

url_platform_mapping​

--download-terraform-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_DOWNLOAD_TERRAFORM_URL_PLATFORM_MAPPING
pants.toml
[download-terraform.url_platform_mapping]
key1 = val1
key2 = val2
...
default: 
{
  "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.

url_template​

--download-terraform-url-template=<str>
PANTS_DOWNLOAD_TERRAFORM_URL_TEMPLATE
pants.toml
[download-terraform]
url_template = <str>
default: https://releases.hashicorp.com/terraform/{version}/terraform_{version}_{platform}.zip

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-&#123;version&#125;-&#123;platform&#125;.zip.

use_unsupported_version​

--download-terraform-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_DOWNLOAD_TERRAFORM_USE_UNSUPPORTED_VERSION
pants.toml
[download-terraform]
use_unsupported_version = <UnsupportedVersionUsage>
one of: error, warning
default: error

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

Supported terraform versions: unspecified

version​

--download-terraform-version=<str>
PANTS_DOWNLOAD_TERRAFORM_VERSION
pants.toml
[download-terraform]
version = <str>
default: 1.0.7

Use this version of terraform.

Deprecated options​

None

None