docs: add terraform lock document (#21)

oqtopus-team · Oct 9, 2024 · 20b9c1f · 20b9c1f
1 parent d09f595
commit 20b9c1f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/en/operation/deployment.md b/docs/en/operation/deployment.md
@@ -38,6 +38,12 @@ First, let's explain the procedure to deploy the infrastructure environment, suc
 aws s3api create-bucket --bucket tfstate.oqtopus-example-dev --profile example-dev --region ap-northeast-1 --create-bucket-configuration LocationConstraint=ap-northeast-1
 ```
 
+Next, create a DynamoDB table to lock the Terraform state file.
+
+```bash
+aws dynamodb create-table --table-name terraform-lock --attribute-definitions AttributeName=LockID,AttributeType=S --key-schema AttributeName=LockID,KeyType=HASH --billing-mode PAY_PER_REQUEST --profile example-dev --region ap-northeast-1
+```
+
 Next, prepare the Terraform configuration files. Create the following two files.
 
 ```hcl:infrastructure/example-dev/example-dev.tfbackend
@@ -47,6 +53,7 @@ key            = "infrastructure.tfstate"
 encrypt        = true
 profile        = "example-dev"
 region         = "ap-northeast-1"
+dynamodb_table = "terraform-lock"
 ```
 
 ```hcl:infrastructure/example-dev/terraform.tfvars
@@ -85,6 +92,7 @@ key            = "service.tfstate"
 encrypt        = true
 profile        = "example-dev"
 region         = "ap-northeast-1"
+dynamodb_table = "terraform-lock"
 ```
 
 ```hcl:service/example-dev/terraform.tfvars

diff --git a/docs/ja/operation/deployment.md b/docs/ja/operation/deployment.md
@@ -41,6 +41,12 @@ stateファイルはS3で管理されるため、S3バケットを作成する
 aws s3api create-bucket --bucket tfstate.oqtopus-example-dev --profile example-dev --region ap-northeast-1 --create-bucket-configuration LocationConstraint=ap-northeast-1
 ```
 
+次にTerraformのStateフアイルをロックするためのDynamoDBテーブルを作成します。
+
+```bash
+aws dynamodb create-table --table-name terraform-lock --attribute-definitions AttributeName=LockID,AttributeType=S --key-schema AttributeName=LockID,KeyType=HASH --billing-mode PAY_PER_REQUEST --profile example-dev --region ap-northeast-1
+```
+
 次に、terraformの設定ファイルを用意します。以下の2つのファイルを作成します。
 
 ```hcl:infrastructure/example-dev/example-dev.tfbackend
@@ -50,6 +56,7 @@ key            = "infrastructure.tfstate"
 encrypt        = true
 profile        = "example-dev"
 region         = "ap-northeast-1"
+dynamodb_table     = "terraform-lock"
 ```
 
 ```hcl:infrastructure/example-dev/terraform.tfvars
@@ -88,6 +95,7 @@ key            = "service.tfstate"
 encrypt        = true
 profile        = "example-dev"
 region         = "ap-northeast-1"
+dynamodb_table     = "terraform-lock"
 ```
 
 ```hcl:service/example-dev/terraform.tfvars