Skip to main content

Understanding State and Remote State in Terraform

Terraform Best Practice

Terraform operates in a declarative manner, where you define your desired infrastructure in configuration files (.tf), and Terraform ensures it matches the actual state of your infrastructure, tracked in the terraform.tfstate file.

Key Components

  • Configuration Files (.tf): Describe the resources you want (e.g., EC2 instances, VPCs).
  • State File (terraform.tfstate): Stores the current state of your infrastructure and maps your configurations to real resources in the cloud.

Issues with Local State

Using local state can be problematic, especially for team or CI/CD workflows:

  1. State Loss or Corruption: If your state file is stored locally and lost or corrupted, Terraform may mistakenly recreate infrastructure, leading to errors.
  2. Version Control Issues: Storing state in version control (e.g., Git) can cause conflicts, duplicate resources, and other errors, especially in multi-user or automated environments.

Solution: Remote State

To address these issues, remote state storage is recommended for better collaboration, security, and reliability.

Benefits of Remote State

  • Centralized Access: Multiple team members can access the same state file.
  • State Locking: Prevents race conditions and simultaneous updates.
  • Backup and Versioning: Remote storage like S3 offers versioning, so you can roll back if needed.

Using AWS S3 + DynamoDB for Remote State

A popular remote state solution involves storing the state in AWS S3 and using DynamoDB for locking to prevent concurrent modifications.

  • S3: Reliable, scalable storage for the state file, with versioning for rollback.
  • DynamoDB: Manages locks to ensure only one process modifies the state at a time.

Example: Configuring Terraform with S3 and DynamoDB

terraform {
  backend "s3" {
    bucket         = "my-terraform-state-bucket"
    key            = "path/to/statefile.tfstate"
    region         = "us-east-1"
    encrypt        = true
    dynamodb_table = "my-terraform-locks"
    acl            = "bucket-owner-full-control"
  }
}

Steps to Set Up Remote State with Locking

  1. Create an S3 bucket to store the state file.
  2. Create a DynamoDB table for state locking.
  3. Update your Terraform config to point to the remote backend.
  4. Run terraform init to initialize and configure the remote state.

Terraform Workflow with Remote State

  1. Initialize with terraform init to set up the remote backend.
  2. Apply Changes using terraform apply. Terraform will retrieve the state from S3 and use DynamoDB for locking.
  3. Collaborate safely with multiple team members, avoiding conflicts and ensuring consistency.

Conclusion

Using remote state with state locking (e.g., via S3 and DynamoDB) is essential for team-based workflows, CI/CD pipelines, and large-scale infrastructure management. It ensures safe collaboration, prevents errors, and provides security and versioning for your state files.

Comments