シンプルなバックエンド管理

まずは最も基本的な、S3バケットにファイルを置くだけの方法です。

1. 仕組み

terraform.tfstate ファイルを、指定したS3バケットに保存します。これで「共有」と「紛失リスク」が解決します。

2. 事前準備

S3バケットを手動、または別のTerraformコードであらかじめ作成しておく必要があります(今回は tf-state-bucket-12345 とします)。

作成方法ですが

  • ローカルでterraformにて作成し、あとでリモートバックエンドとして設定
  • AWSマネジメントコンソールで作成し、リモートバックエンドとして設定する(S3自体をTerraformで管理したい場合は、さらに terraform import を行う)

のどちらかの方法が取れます。

3. 記載方法

main.tf に terraform ブロックを追加し、backend "s3" を定義します。

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

  # ここがバックエンドの設定
  backend "s3" {
    bucket = "tf-state-bucket-12345" # 作成済みのバケット名
    key    = "dev/terraform.tfstate" # ファイルのパス(フォルダ構成)
    region = "ap-northeast-1"
  }
}

4. 設定の適用

バックエンドの設定を変更した際は、必ず初期化が必要です。

terraform init

5. 問題点

この方法だけだと、「排他制御(ロック)」ができません。 もしチームメンバー2人が同時に terraform apply を実行してしまうと、S3上のファイルが同時に書き換えられ、データが破損する恐れがあります。

そのため、次に説明するロック機能が有効です。