← Recipes

阅读中文版本

Enable Terraform State Locking with S3 and DynamoDB

Configure a DynamoDB lock table so concurrent terraform runs do not corrupt the state file.

~20 mincloudterraformstate

Task

Configure terraform init -backend-config="lock_table=terraform-locks" so the cloud resource enforces the control automatically without manual console steps.

When to use this

An audit finds that terraform init -backend-config="lock_table=terraform-locks" was configured manually and drifted, leaving a resource exposed for two weeks.

Prerequisites

  • Terraform or IaC tooling installed
  • Cloud provider credentials with target permissions

Steps

1. Configure terraform init -backend-config="lock_table=terraform-locks" in the project configuration file with the recommended defaults.

terraform init -backend-config="lock_table=terraform-locks"

Expected output: The configuration is accepted and terraform init -backend-config="lock_table=terraform-locks" runs without errors on the first invocation.

2. Run the check locally to verify terraform init -backend-config="lock_table=terraform-locks" produces the expected result before pushing.

terraform plan

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so terraform init -backend-config="lock_table=terraform-locks" blocks merge on failure.

- name: Run add terraform state locking
  run: terraform validate

Expected output: Pull requests with failing terraform init -backend-config="lock_table=terraform-locks" are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Codify the control

Start by measuring the problem. Configure a DynamoDB lock table so concurrent terraform runs do not corrupt the state file. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run terraform init -backend-config=“lock_table=terraform-locks” against the current codebase and inspect the output before wiring it into CI.

terraform init -backend-config="lock_table=terraform-locks"

Detect drift

Once the gate is in place, make failures actionable. A failing terraform init -backend-config=“lock_table=terraform-locks” should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.