ข้ามไปยังเนื้อหา

Worked review 2: multi-environment Terragrunt live tree

Prompt คือ: “ตั้ง Terragrunt live tree ที่มี dev กับ prod environment แต่ละอันมี network unit และ app unit ที่ depend บนมัน” สิ่งที่ตามมาคือ draft แรกแบบที่ AI assistant ส่งกลับมาให้กับ prompt แบบนี้พอดี — root.hcl ที่ใช้ร่วมกัน, terragrunt.hcl สี่ไฟล์ที่ดูสมเหตุสมผลรายตัว, และ CI snippet ที่อ่านแล้วเหมือน Terragrunt tutorial ทุกอันที่ตีพิมพ์ก่อน CLI redesign 1.1 มี bug จริง 8 ข้อ; ดู AI bug catalog สำหรับ pattern ทั่วไปเบื้องหลังแต่ละข้อ เจ็ดในแปดข้อนี้เป็น mechanics ของ Terragrunt-core ที่ไม่ขึ้นกับ provider เหมือนกันเป๊ะกับ worked review 2 ของ review ทั้งสองฝั่งก่อนหน้า — พิสูจน์สดใหม่ที่นี่ ใน repo นี้ กับ google — บวกอีกหนึ่ง bug ที่เฉพาะ backend GCS จริงๆ แทนคู่ dynamodb_table/use_lockfile ของ AWS และ use_azuread_auth ที่หายไปของ azurerm ทุกข้อที่กล่าวถึงด้านล่างพิสูจน์ด้วย terragrunt hcl validate/render/run --all/find --dag จริง กับ Terragrunt 1.1.0 และ Terraform 1.16.4 โดยใช้ backend = "local" แทน backend GCS จริง — ตามธรรมเนียมของคอร์สนี้ การพิสูจน์ offline ไม่แตะ GCP จริงเลย

# root.hcl, as generated -- realistic GCS backend (see review walk for why the proof tree below uses backend = "local" instead)
remote_state {
backend = "gcs"
generate = {
path = "backend.tf"
if_exists = "overwrite"
}
config = {
bucket = "acme-terraform-state"
project = "acme-prod-123456"
location = "US"
}
}
# live tree, as generated -- live/dev/network/terragrunt.hcl and live/prod/network/terragrunt.hcl (byte-identical)
include "root" {
path = find_in_parent_folders()
}
locals {
environment = "dev"
project = "acme-dev-123456"
region = "us-central1"
}
terraform {
source = "${get_terragrunt_dir()}/../../../modules/network"
}
inputs = {
environment = local.environment
}
# live tree, as generated -- live/dev/app/terragrunt.hcl and live/prod/app/terragrunt.hcl (byte-identical)
include "root" {
path = find_in_parent_folders()
}
dependency "network" {
config_path = "../network"
}
terraform {
source = "${get_terragrunt_dir()}/../../../modules/app"
}
inputs = {
vpc_id = dependency.network.outputs.vpc_id
}
# ci/deploy.sh, as generated -- fragment, not a collected fence
#!/usr/bin/env bash
set -euo pipefail
cd live/dev
terragrunt run-all plan --terragrunt-non-interactive
terragrunt plan-all --terragrunt-non-interactive --queue-include-dir network

อาการ — จริง รันตรง (mechanics เดียวกับ review ทั้งสองฝั่งก่อนหน้า เพราะเป็น Terragrunt-core ไม่ใช่เฉพาะ provider):

$ terragrunt plan-all --non-interactive --no-color
ERROR unknown command: "plan-all". Terragrunt no longer forwards unknown commands by default. Use 'terragrunt run -- plan-all ...' or a supported shortcut. Learn more: https://docs.terragrunt.com/migrate/cli-redesign/#use-the-new-run-command
$ terragrunt run-all plan --non-interactive --no-color
ERROR unknown command: "run-all". Terragrunt no longer forwards unknown commands by default. Use 'terragrunt run -- run-all ...' or a supported shortcut. Learn more: https://docs.terragrunt.com/migrate/cli-redesign/#use-the-new-run-command

🐛 หา bug ในโค้ดนี้

terragrunt run-all plan --terragrunt-non-interactive
terragrunt plan-all --terragrunt-non-interactive --queue-include-dir network
เฉลย

bug เดียวกับ AI bug catalog entry 16 — ทั้งสอง command เกลื่อนอยู่ใน tutorial ก่อน 1.1 และ training data ของ AI และทั้งคู่ถูกแทนที่ด้วย run --all ของ CLI redesign 1.1 วิธีแก้: terragrunt run --all --non-interactive -- plan

อาการ — จริง รันตรงกับ command run --all ที่แก้แล้ว:

$ terragrunt run --all --terragrunt-non-interactive --no-color -- plan
ERROR flag `-terragrunt-non-interactive` is not a Terragrunt flag. If this is an OpenTofu/Terraform flag, use `--` to forward it (e.g., `terragrunt run -- <command> -terragrunt-non-interactive`).

🐛 หา bug ในโค้ดนี้

terragrunt run --all --terragrunt-non-interactive --no-color -- plan
เฉลย

ทุก flag ของ Terragrunt หลุด prefix terragrunt- ใน CLI redesign เดียวกับที่แทนที่ run-all flag ที่มี prefix --terragrunt-* ถูกปฏิเสธตรงๆ ไม่ใช่ถูกเมินแบบเงียบๆ — CI script เก่าพังตั้งแต่ run แรกเลย วิธีแก้: ตัด prefix terragrunt- ออกจากทุก flag

# excerpt, as generated -- entries/03-find-in-parent-no-arg/unit/terragrunt.hcl
include "root" {
path = find_in_parent_folders()
}

อาการ — terragrunt hcl validate จริง ทั้ง 4 unit ในต้นเดียวกัน พังแบบเดียวกันพร้อมกันหมด:

$ terragrunt hcl validate --working-dir .
Error: Error in function call
on live/dev/network/terragrunt.hcl line 2, in include "root":
2: path = find_in_parent_folders()
Call to function "find_in_parent_folders" failed: ParentFileNotFoundError:
Could not find a terragrunt.hcl in any of the parent folders of
live/dev/network/terragrunt.hcl. Cause: Traversed all the way to the root..
The include configuration in live/dev/app/terragrunt.hcl must specify a 'path' parameter
... (identical for the other 3 units)
4 HCL validation error(s) found

🐛 หา bug ในโค้ดนี้

include "root" {
path = find_in_parent_folders()
}
เฉลย

find_in_parent_folders() ที่เรียกโดย ไม่มี argument เลย default ไปหาไฟล์ที่ชื่อ terragrunt.hcl เป๊ะๆ — ธรรมเนียมก่อน 1.1 root config ของคอร์สนี้ เหมือนคำแนะนำ Terragrunt ปัจจุบัน ชื่อ root.hcl เจาะจงเพื่อเลี่ยงไม่ให้ไฟล์นี้ถูกเข้าใจผิดว่าเป็น unit config ของตัวเอง วิธีแก้: find_in_parent_folders("root.hcl") ระบุชื่อไฟล์จริง

# excerpt, as generated -- entries/04-no-mock-outputs/app/terragrunt.hcl
dependency "network" {
config_path = "../network"
}

อาการ — terragrunt run --all plan จริง กับทั้งต้น สดใหม่ network ไม่เคยถูก apply เลย:

$ terragrunt run --all --non-interactive --no-color -- plan
❯❯ Run Summary 4 units
Succeeded 2
Failed 2
ERROR ... resolving dependency "network" outputs: live/dev/network/terragrunt.hcl is
a dependency of live/dev/app/terragrunt.hcl but detected no outputs. Either the target
module has not been applied yet, or the module has no outputs.
... There is no variable named "dependency".

🐛 หา bug ในโค้ดนี้

dependency "network" {
config_path = "../network"
}
เฉลย

ดู Dependencies Between Units สำหรับ mechanism เต็มรูปแบบ — นี่คือกลไก guardrail mock_outputs_allowed_terraform_commands ของบทนั้น แต่ปัญหาต้นตอเกิดก่อนหน้านั้นหนึ่งขั้น: ไม่มี mock_outputs ประกาศไว้เลย วิธีแก้: เพิ่ม mock_outputs = { vpc_id = "mock-vpc-id" } และ mock_outputs_allowed_terraform_commands = ["plan"]

อาการ — จริง บนไฟล์ที่ AI สร้างจริง:

$ diff live/dev/network/terragrunt.hcl live/prod/network/terragrunt.hcl
(no output -- the files are byte-identical)

ทั้งสองไฟล์ประกาศ environment = "dev", project = "acme-dev-123456" — รวมถึงข้างใน live/prod/network/terragrunt.hcl ด้วย

🐛 หา bug ในโค้ดนี้

live/prod/network/terragrunt.hcl
locals {
environment = "dev"
project = "acme-dev-123456"
}
เฉลย

bug เดียวกับ AI bug catalog entry 17 — terragrunt hcl validate/hcl format --check ผ่านทั้งคู่ ไม่มีอะไรเป็น HCL ที่ invalid เลย และด้วย backend = "local" สำหรับการพิสูจน์ offline ของคอร์สนี้ ไม่มีอะไรพังตอน plan ด้วย เทียบกับ backend GCS จริงที่เล็งไป project = "acme-dev-123456" จากทั้ง dev และ prod นี่คือการ deploy prod เข้า GCP project ของ dev แบบเงียบๆ วิธีแก้: ย้ายค่าที่ต้องต่างกันต่อ environment ไปไว้ env.hcl ต่อ environment แล้วให้ network/terragrunt.hcl แต่ละตัวกลายเป็นเหมือนกันกับ sibling ของมัน อ่าน include.env.locals.* แทน

include ตัวที่สองสำหรับค่าที่ share กัน ประกาศโดยไม่มี expose = true

หัวข้อที่มีชื่อว่า “include ตัวที่สองสำหรับค่าที่ share กัน ประกาศโดยไม่มี expose = true”
# excerpt, as generated -- entries/06-include-no-expose/unit/terragrunt.hcl
include "env" {
path = find_in_parent_folders("env.hcl")
merge_strategy = "no_merge"
}
inputs = {
project = include.env.locals.project
}

อาการ — terragrunt render จริง:

$ terragrunt render --format json
Error: Unsupported attribute
on unit/terragrunt.hcl line 15:
15: project = include.env.locals.project
This object does not have an attribute named "env".

🐛 หา bug ในโค้ดนี้

include "env" {
path = find_in_parent_folders("env.hcl")
merge_strategy = "no_merge"
}
เฉลย

mechanism เดียวกับ Dry Configuration with Include — expose = true คือสิ่งที่ทำให้เนื้อหาที่ parse แล้วของ include อ่านได้ผ่าน include.NAME.* วิธีแก้: เพิ่ม expose = true เข้า include block ของ env

# entries/07-remote-state-cross-env/main.tf -- @expect-error No stored state was found for the given workspace in the given backend.
data "terraform_remote_state" "prod_network" {
backend = "local"
config = {
path = "../../../prod/network/terraform.tfstate"
}
}

อาการ — terraform plan จริง:

Error: Unable to find remote state
with data.terraform_remote_state.prod_network,
on main.tf line 1, in data "terraform_remote_state" "prod_network":
1: data "terraform_remote_state" "prod_network" {
No stored state was found for the given workspace in the given backend.

🐛 หา bug ในโค้ดนี้

data "terraform_remote_state" "prod_network" {
backend = "local"
config = { path = "../../../prod/network/terraform.tfstate" }
}
เฉลย

mechanism เดียวกับ AI bug catalog entry 6 ใช้กับรูปทรงที่ Terragrunt live tree ล่อ AI assistant ให้ทำพอดี: เอื้อมไปใช้ raw Terraform terraform_remote_state data source แทนที่จะใช้ Terragrunt dependency block นอกจาก hard-fail ที่พิสูจน์ไว้ที่นี่ pattern นี้ยังข้าม mock_outputs ไปเลย ไม่มีความรู้เรื่องลำดับ run --all เลย วิธีแก้: dependency block cross-environment ที่ถูกต้อง หรือลบ reference นี้ทิ้งไปเลย

root.hcl: GCS remote_state ไม่มี prefix — สอง unit share state object เดียวกันแบบเงียบๆ

หัวข้อที่มีชื่อว่า “root.hcl: GCS remote_state ไม่มี prefix — สอง unit share state object เดียวกันแบบเงียบๆ”
# root.hcl (excerpt)
remote_state {
backend = "gcs"
config = {
bucket = "acme-terraform-state"
project = "acme-prod-123456"
location = "US"
}
}

อาการ — จริง terragrunt run -- init -backend=false กับ root.hcl นี้เป๊ะ รันจากสอง unit ต่างกัน network กับ app (ธรรมเนียมของคอร์สนี้ในการพิสูจน์ผลของ generate — ไม่ต้องมี GCS bucket จริง แค่เนื้อหา backend.tf ที่ generate ออกมาจริงก็พอ):

$ cd network && terragrunt run --non-interactive --no-color -- init -backend=false && cat backend.tf
# Generated by Terragrunt. Sig: nIlQXj57tbuaRZEa
terraform {
backend "gcs" {
bucket = "acme-terraform-state"
}
}
$ cd ../app && terragrunt run --non-interactive --no-color -- init -backend=false && cat backend.tf
# Generated by Terragrunt. Sig: nIlQXj57tbuaRZEa
terraform {
backend "gcs" {
bucket = "acme-terraform-state"
}
}

🐛 หา bug ในโค้ดนี้

remote_state {
backend = "gcs"
config = {
bucket = "acme-terraform-state"
project = "acme-prod-123456"
location = "US"
}
}
เฉลย

backend.tf ที่ generate ออกมาทั้งสองไฟล์ เหมือนกันเป๊ะ byte-ต่อ-byte พิสูจน์แล้วด้านบนด้วยการรัน init -backend=false จริงแยกกันสองครั้ง — bucket = "acme-terraform-state" แล้วไม่มีอะไรอื่นเลย project/location ควบคุมการ auto-create bucket ไม่ใช่การ address state ของ backend block เอง และไม่เคยมี prefix ตั้งไว้เลยเพื่อให้แต่ละ unit มี path ของตัวเองแบบที่ path_relative_to_include() ทำให้ key (AWS) หรือ key (azurerm) ถ้าไม่มีมัน network กับ app จะเล็งไป state object เดียวกันเป๊ะที่ bucket root แบบเงียบๆ — unit ตัวที่สองที่รัน apply จะอ่านและเขียนทับ state ของ unit ตัวแรก วิธีแก้: เพิ่ม prefix = "${path_relative_to_include()}/terraform.tfstate" เข้า remote_state.config เหมือน key ของ review ทั้งสองฝั่งก่อนหน้า

root.hcl
remote_state {
backend = "local"
generate = { path = "backend.tf", if_exists = "overwrite_terragrunt" }
config = { path = "${get_terragrunt_dir()}/terraform.tfstate" }
}
modules/network/main.tf
variable "environment" {
type = string
}
resource "terraform_data" "vpc" {
input = "vpc-${var.environment}"
}
output "vpc_id" {
value = terraform_data.vpc.id
}
modules/app/main.tf
variable "vpc_id" {
type = string
}
resource "terraform_data" "app" {
input = var.vpc_id
}
live/dev/env.hcl
locals {
environment = "dev"
project = "acme-dev-123456"
region = "us-central1"
}
live/prod/env.hcl
locals {
environment = "prod"
project = "acme-prod-654321"
region = "us-central1"
}
live/dev/network/terragrunt.hcl
include "root" {
path = find_in_parent_folders("root.hcl")
}
include "env" {
path = find_in_parent_folders("env.hcl")
expose = true
merge_strategy = "no_merge"
}
terraform {
source = "${get_terragrunt_dir()}/../../../modules/network"
}
inputs = {
environment = include.env.locals.environment
}
live/prod/network/terragrunt.hcl
include "root" {
path = find_in_parent_folders("root.hcl")
}
include "env" {
path = find_in_parent_folders("env.hcl")
expose = true
merge_strategy = "no_merge"
}
terraform {
source = "${get_terragrunt_dir()}/../../../modules/network"
}
inputs = {
environment = include.env.locals.environment
}
live/dev/app/terragrunt.hcl
include "root" {
path = find_in_parent_folders("root.hcl")
}
dependency "network" {
config_path = "../network"
mock_outputs = { vpc_id = "mock-vpc-id" }
mock_outputs_allowed_terraform_commands = ["plan"]
}
terraform {
source = "${get_terragrunt_dir()}/../../../modules/app"
}
inputs = {
vpc_id = dependency.network.outputs.vpc_id
}
live/prod/app/terragrunt.hcl
include "root" {
path = find_in_parent_folders("root.hcl")
}
dependency "network" {
config_path = "../network"
mock_outputs = { vpc_id = "mock-vpc-id" }
mock_outputs_allowed_terraform_commands = ["plan"]
}
terraform {
source = "${get_terragrunt_dir()}/../../../modules/app"
}
inputs = {
vpc_id = dependency.network.outputs.vpc_id
}

พิสูจน์จริง ทั้งต้นพร้อมกัน:

$ terragrunt hcl validate --working-dir .
(no output -- 0 errors)
$ diff live/dev/network/terragrunt.hcl live/prod/network/terragrunt.hcl
(no output -- now correctly identical; env.hcl differs instead)
$ terragrunt run --all --non-interactive --no-color --working-dir . -- plan
❯❯ Run Summary 4 units
Succeeded 4
$ terragrunt find --dag --working-dir .
live/dev/network
live/prod/network
live/dev/app
live/prod/app
#Bugวิธีแก้
1run-all/plan-all ใน CI scriptrun --all — real “unknown command” rejection ทั้งคู่ ก่อนแก้
2--terragrunt-non-interactive และ flag prefix ก่อน 1.1 อื่นๆ--non-interactive เปล่าๆ ฯลฯ — real “not a Terragrunt flag” rejection ก่อนแก้
3find_in_parent_folders() ไม่มี argument, root file ชื่อ root.hclfind_in_parent_folders("root.hcl") — real “Could not find a terragrunt.hcl” ทั้ง 4 unit ก่อนแก้
4dependency "network" ไม่มี mock_outputs เลยmock_outputs + mock_outputs_allowed_terraform_commands = ["plan"] — real run --all plan พังบน environment สดใหม่ก่อนแก้
5dev กับ prod network unit มี locals เหมือนกันเป๊ะ (รวม project)ย้ายค่าที่ต้องต่างไปไว้ env.hcl ต่อ environment; ไฟล์ unit กลายเป็นเหมือนกันแทน — diff จริงพิสูจน์ทั้ง bug และวิธีแก้
6include "env" ตัวที่สองไม่มี expose = trueเพิ่ม expose = true — real “This object does not have an attribute named env” ก่อนแก้
7terraform_remote_state อ่าน state ของ environment อื่นตรงๆ จากข้างใน moduleแทนที่ด้วย dependency block ที่ถูกต้อง (หรือลบทิ้ง) — real “No stored state was found” ก่อนแก้
8root.hcl GCS remote_state ไม่มี prefixเพิ่ม prefix = "${path_relative_to_include()}/terraform.tfstate" — พิสูจน์ด้วย unit สอง unit จริงที่ generate backend.tf เหมือนกันเป๊ะ (ความเสี่ยง state ชนกันจริง)

สี่ใน bug แปดข้อนี้ (1, 2, 3, 6) เป็น hard failure ที่ชัดทันทีระดับ CLI/HCL-evaluation เหมือนกับ review ทั้งสองฝั่งก่อนหน้า ข้อหนึ่ง (4) เป็น hard failure แต่เกิดเฉพาะ run --all plan ครั้งแรกกับ environment สดใหม่จริงๆ เท่านั้น ข้อหนึ่ง (7) เป็น hard failure เฉพาะ state ที่ไม่เคยถูก apply ที่ระดับ Terraform สองข้อที่เหลือ (5, 8) ไม่ error เลย — และ entry 8 คือ bug ข้อเดียวในบทนี้ทั้งหมดที่เฉพาะ GCS จริงๆ: แทนที่จะเป็น argument dynamodb_table ที่ deprecated (AWS) หรือ backend ที่ default ไป shared key แบบเงียบๆ (azurerm) ช่องว่างเทียบเท่าที่นี่คือ unit สองตัวที่มีโครงสร้างต่างกันจริง generate backend configuration เหมือนกันเป๊ะ — ความเสี่ยง state ชนกันจริง ที่ hcl validate ไม่มีทางสังเกตได้เลย เพราะไฟล์ที่ generate ทั้งสองไฟล์ valid สมบูรณ์รายตัว

  • “ถ้า terragrunt hcl validate ผ่าน แปลว่า multi-environment tree ปลอดภัยที่จะ deploy จริง” พิสูจน์แล้วด้านบน: hcl validate กับ network unit ที่เหมือนกันเป๊ะสองตัวคืนค่า error ศูนย์ข้อ — HCL validation ไม่มีแนวคิดเรื่อง “ค่านี้ควรต่างจากไฟล์ sibling นั้น” เลย และเช่นเดียวกันกับ unit สองตัวที่ generate backend.tf เหมือนกันเป๊ะ
  • “dependency block ที่ไม่มี mock_outputs พังแค่ apply เท่านั้น ไม่เคยพัง plan” พิสูจน์แล้วด้านบน: บน environment สดใหม่สมบูรณ์ที่ dependency ไม่เคยถูก apply เลยแม้แต่ครั้งเดียว run --all plan เองก็พัง
  • “project/location ใน remote_state.config แบบ GCS scope state ต่อ unit เหมือน key/prefix ที่อื่น” พิสูจน์แล้วด้านบน: unit สองตัวที่มีโครงสร้างต่างกันจริง (network, app) generate backend.tf เหมือนกันเป๊ะ ต่างกันแค่ไม่มีอะไรเลย — project/location ควบคุมการ auto-create bucket ไม่เคย address state เลย มีแค่ prefix เท่านั้นที่ทำแบบนั้น และไม่เคยถูกตั้งเลย
flowchart TD
  CI["ci/deploy.sh"] -->|"1: run-all/plan-all removed"| CI
  CI -->|"2: --terragrunt-* flags rejected"| CI
  CI --> H["terragrunt hcl validate"]
  H -->|"3: find_in_parent_folders() no arg"| H
  H -->|"6: include without expose"| H
  H --> R["terragrunt run --all plan"]
  R -->|"4: dependency, no mock_outputs -- fresh env"| R
  R --> M["module-level terraform plan"]
  M -->|"7: terraform_remote_state cross-env"| M
  D["diff dev vs prod files"] -->|"5: byte-identical locals"| D
  L["root.hcl remote_state, generated backend.tf"] -->|"8: no prefix -- state collision"| L
แต่ละ bug อยู่ตรงไหนในเส้นทางประเมินของ live tree นี้
find_in_parent_folders() ถูกเรียกโดยไม่มี argument ใน tree ที่ root config ชื่อ root.hcl terragrunt hcl validate จริงแสดงอะไร?
environment สดใหม่ที่ network ไม่เคยถูก apply เลย และ app มี dependency "network" block ที่ไม่มี mock_outputs เลย terragrunt run --all plan จริงแสดงอะไร?
root remote_state.config แบบ GCS backend ตั้ง bucket, project, และ location ไว้ แต่ไม่มี prefix unit สองตัวที่มีโครงสร้างต่างกันจริง network กับ app แต่ละตัวรัน init -backend=false จริง backend.tf ที่ generate ออกมาแสดงอะไร?
dev กับ prod network unit เหมือนกันเป๊ะ รวม project ด้วย terragrunt hcl validate แสดงอะไร และอะไรจับ bug นี้ได้จริง?
include "env" ตัวที่สองประกาศด้วย merge_strategy = "no_merge" แต่ไม่มี expose = true แล้ว inputs บรรทัดหนึ่งอ่าน include.env.locals.project terragrunt render จริงแสดงอะไร?