Terraformのworkspaceと-var-fileで環境を分離する方法｜dev・stg・prodを1つのコードで管理する設計

この記事のポイント

・workspaceはtfstateを分離し、-var-fileはパラメータを分離する役割を担う
・2つを組み合わせることで1セットのHCLで3環境を安全に管理できる
・S3バックエンド使用時はworkspaceごとにtfstateのパスが自動で分かれる
・「workspace selectを忘れたまま apply」が最多事故パターンで対策が必要

# 現在のworkspace一覧（*が現在のworkspace）
$ terraform workspace list
* default

# dev・stg・prod workspaceを作成する
$ terraform workspace new dev
Created and switched to workspace "dev"!

$ terraform workspace new stg
$ terraform workspace new prod

# workspace一覧を再確認
$ terraform workspace list
  default
* dev
  prod
  stg

# workspaceを切り替える
$ terraform workspace select prod
Switched to workspace "prod"

# 現在のworkspaceを確認する
$ terraform workspace show
prod

# main.tf（workspace名をタグに使う例）
resource "aws_instance" "web" {
  ami           = data.aws_ami.amazon_linux.id
  instance_type = var.instance_type  # -var-fileから取得

  tags = {
    Name        = "web-${terraform.workspace}"
    Environment = terraform.workspace
  }
}

project/
├── main.tf          # リソース定義
├── variables.tf     # variable宣言
├── outputs.tf       # output定義
├── backend.tf       # バックエンド設定
└── environments/
    ├── dev.tfvars   # dev環境の変数値
    ├── stg.tfvars   # stg環境の変数値
    └── prod.tfvars  # prod環境の変数値

# variables.tf
variable "instance_type" {
  type        = string
  description = "EC2インスタンスタイプ（環境ごとに異なる）"
}

variable "db_instance_class" {
  type        = string
  description = "RDSインスタンスクラス"
}

variable "min_capacity" {
  type        = number
  description = "Auto Scalingの最小台数"
}

variable "max_capacity" {
  type        = number
  description = "Auto Scalingの最大台数"
}

variable "domain" {
  type        = string
  description = "サービスのドメイン名"
}

# environments/dev.tfvars
instance_type     = "t3.micro"
db_instance_class = "db.t3.micro"
min_capacity      = 1
max_capacity      = 2
domain            = "dev.example.com"

# environments/prod.tfvars
instance_type     = "m5.large"
db_instance_class = "db.m5.large"
min_capacity      = 3
max_capacity      = 10
domain            = "example.com"

# dev環境へのデプロイ
$ terraform workspace select dev
$ terraform plan  -var-file=environments/dev.tfvars
$ terraform apply -var-file=environments/dev.tfvars

# stg環境へのデプロイ
$ terraform workspace select stg
$ terraform plan  -var-file=environments/stg.tfvars
$ terraform apply -var-file=environments/stg.tfvars

# prod環境へのデプロイ
$ terraform workspace select prod
$ terraform plan  -var-file=environments/prod.tfvars
$ terraform apply -var-file=environments/prod.tfvars

# Makefile
ENV ?= dev

.PHONY: plan apply

plan:
	terraform workspace select $(ENV)
	terraform plan -var-file=environments/$(ENV).tfvars

apply:
	terraform workspace select $(ENV)
	terraform apply -var-file=environments/$(ENV).tfvars

# 使い方
# make plan ENV=stg
# make apply ENV=prod

# main.tf（locals活用例）
locals {
  env         = terraform.workspace
  is_prod     = terraform.workspace == "prod"
  name_prefix = "${var.project_name}-${local.env}"

  # prod環境では削除保護を有効にする
  deletion_protection = local.is_prod ? true : false
}

resource "aws_db_instance" "main" {
  identifier        = "${local.name_prefix}-db"
  instance_class    = var.db_instance_class
  deletion_protection = local.deletion_protection
  # ...省略
}

# backend.tf
terraform {
  backend "s3" {
    bucket         = "my-company-terraform-state"
    key            = "services/api/terraform.tfstate"
    region         = "ap-northeast-1"
    dynamodb_table = "terraform-state-lock"
    encrypt        = true
  }
}

# S3上でのtfstate実際のパス（workspace使用時）
# defaultワークスペース
s3://my-company-terraform-state/services/api/terraform.tfstate

# devワークスペース
s3://my-company-terraform-state/env:/dev/services/api/terraform.tfstate

# stgワークスペース
s3://my-company-terraform-state/env:/stg/services/api/terraform.tfstate

# prodワークスペース
s3://my-company-terraform-state/env:/prod/services/api/terraform.tfstate

# ~/.bashrc または ~/.zshrc に追加
tf-apply() {
  local env="${1}"
  if [ -z "${env}" ]; then
    echo "ERROR: 環境名（dev/stg/prod）を引数で指定してください"
    return 1
  fi
  echo "workspace: $(terraform workspace show) → ${env}に切り替えます"
  terraform workspace select "${env}" && \
  terraform plan  -var-file="environments/${env}.tfvars" && \
  echo "--- plan完了。applyを実行しますか？（Ctrl+Cで中断）---" && \
  read -r && \
  terraform apply -var-file="environments/${env}.tfvars"
}

# 使い方
# tf-apply prod

# .gitignore
*.tfvars
*.tfvars.json
.terraform/
terraform.tfstate
terraform.tfstate.backup
.terraform.lock.hcl

# 共通設定を先に読み、prod固有設定で上書きする
$ terraform apply \
  -var-file=environments/common.tfvars \
  -var-file=environments/prod.tfvars