DynamoDBによるロック管理

AWSを利用する場合の、最も一般的で推奨される構成です。DynamoDBを使って「今、誰かが実行中です」というロック情報を管理します。

1. 仕組み

DynamoDBによるステートロックの流れを以下に示します。

Terraformは実行開始時にDynamoDBに「ロック」を書き込み、終了時に削除します。ロックがある間は、他の人は実行できません。

2. 事前準備

ロック管理用のDynamoDBテーブルをあらかじめ作成します。制約として、パーティションキー: LockID (String) という名前である必要があります。

DynamoDBテーブルのキー名や、S3バックエンドで利用できる設定項目の一覧は、Terraform公式ドキュメントのBackend Type: s3に記載があります。

3. 記載方法

バックエンド設定に dynamodb_table を追加します。

terraform {
  backend "s3" {
    bucket = "tf-state-bucket-12345"
    key    = "dev/terraform.tfstate"
    region = "ap-northeast-1"

    # ロック用テーブルを指定
    dynamodb_table = "terraform-state-lock-tbl"
  }
}

これで、安全にチーム開発ができるようになります。