コンテンツにスキップ

Pants で Terraform を使う際の setup と tips

Pants で Terraform を使う際の setup と tips をまとめる。

setup

Terraform で remote module を利用するには git が必要になる。開発マシンへ git を導入済みでも、Pants から認識できないことがある。その場合は、次の設定を使う（参考: Terraform backend setup issues · Issue #20363 · pantsbuild/pants）。

pants.toml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[download-terraform]
extra_env_vars = [
  "PATH"
]

# 上記の設定でgitバイナリが見つからない場合は下記を追加してみる
[system-binaries]
system_binary_paths.add = [
    '/path/to/bin',
]

git の注意点

external data source で次のように git を使っている場合、Pants を経由しなかったら問題なく実行できていたものが、Pants を経由するとエラーが発生するようになる。これは、Pants の実行環境では.gitディレクトリがないため。

1
2
3
4
5
6
7
8
9
data "external" "git" {
  program = [
    "git",
    "log",
    "--pretty=format:{ \"sha\": \"%h\" }",
    "-1",
    "HEAD"
  ]
}

lockfile 対応

v2.22.0 時点では Terraform の lockfile をそのまま Pants で扱う。lockfile が更新されてないまま Pants から Terraform を実行するとエラーになる。その場合は、generate-lockfilesのオプションでterraform_moduleのターゲットの名前を指定して lockfile を更新すると良い。

1
2
terraform_module(name="infrastructure")
terraform_deployment(name="prod", root_module="//tf:infrastructure")

1
pants generate-lockfiles --resolve=tf:infrastructure

terraform_moduleを対象としたgenerate-lockfilesの実行では、裏側でterraform initが実行される。