■ はじめに

https://dk521123.hatenablog.com/entry/2023/04/20/172823

において、
エラー「AlreadyExistsException: Workflow with name 'xxx-xxxx' already Exists」
について、ひとまずの回避案を提示したが、ちゃんとした解決案が分かった。
その解決案に、tfstateファイルってのが深くかかわってくるので、メモ。

【０】terraform init コマンドでの生成物について

* tfstateファイルの解説に入る前に、
　tfstateファイルを含む terraform init コマンドでの生成物について
　説明する

[1] .terraformディレクトリ

* terraformがキャッシュされたプラグインとモジュールを
　管理するディレクトリ

[2] .tfstateファイル

* Terraformによって作成された現在の構成状態を記録してあるファイル
 => ★今回のテーマ★

[3] .terraform.lock.hclファイル

* プロバイダーとモジュールの依存関係や互換性が記録

https://rurukblog.com/post/terraform-lock-hcl/

【１】tfstateファイル

* Terraformが管理しているリソースの現在の状態を表すファイル
* 形式は、JSON
* デフォルトのファイル名は、「terraform.tfstate」

https://qiita.com/masaaania/items/0ed291b267032a7699ad

１）目的

* 「terraform plan」を実行した場合、現在の状態との差分が表示されるが
　これは、tfstateファイルに記述されている現在の状態と
　HCLで記述された定義との差分で表示する
 => 詳細は、以下の公式ドキュメントを参照のこと。

https://developer.hashicorp.com/terraform/language/state/purpose

【２】tfstateファイルの管理場所

* デフォルトでは、ローカルに生成される
 => 1人で開発している場合であればローカルでもいいが（それでもダメだが）
　　複数で開発していた場合、以下の関連記事で扱ったようなエラーになる等
　　トラブルの原因になる

Terraform ～特定リソースのみデプロイする～
https://dk521123.hatenablog.com/entry/2023/04/20/172823

１）解決案

* AWSであれば、S3に置く

* 可能であれば、「Terraform Cloud」ってのもあり
　（外部サイトに繋ぐので、できない現場が多いかもしれないが）
 => 利点については、以下のサイトを参照

https://dev.classmethod.jp/articles/terraform_tfstate_management_tfc/

【３】tfstateをS3に置く

* 「backend "s3"」を指定した後に「terraform init」を実行

https://developer.hashicorp.com/terraform/language/settings/backends/s3

main.tf

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 3.27"
    }
  }

  required_version = ">= 0.14.9"

  # ★ここに注目★
  backend "s3" {
    bucket  = "your-s3-bucket"
    key     = "tf/dev/terraform.tfstate"
    region  = "us-west-2"
    encrypt = true
  }

１）State Locking（複数人での開発のために）

* DynamoDB 使うと実現可能

参考文献

https://zenn.dev/sway/articles/terraform_staple_sharestate
https://techgrowup.net/2022/04/18/terraform%E3%81%A7tfstate%E3%82%92s3%E3%81%A7%E7%AE%A1%E7%90%86%E3%81%99%E3%82%8B/
https://zenn.dev/sway/articles/terraform_staple_sharestate

プログラムの超個人的なメモ

Memo for Programming.

【Terraform】Terraform ～基本編 / tfstateファイル～

■ はじめに

目次

【０】terraform init コマンドでの生成物について

【１】tfstateファイル

１）目的

【２】tfstateファイルの管理場所

１）解決案

【３】tfstateをS3に置く

１）State Locking（複数人での開発のために）

参考文献

関連記事