DRY Configuration with include

ไอเดียในหนึ่งประโยค

include block ร่วมกับ find_in_parent_folders() ทำให้ unit ดึงทุกอย่างที่ shared config file กำหนดไว้มาใช้ได้เลย และ locals ร่วมกับ read_terragrunt_config() ก็ขยายแนวคิดเดียวกันนี้ไปยัง intermediate file ที่อยู่ระหว่าง root กับ unit ได้อีกกี่ชั้นก็ได้

include block: สืบทอด root.hcl โดยไม่ต้องเขียนซ้ำ

บทก่อนหน้าแสดงให้เห็นว่า root.hcl ประกาศ remote_state และ provider generate block ไว้ครั้งเดียวที่ด้านบนสุดของ tree ส่วน unit จะเข้าถึงทั้งสองอย่างนี้ได้โดยไม่ต้อง copy บรรทัดใดเลย ผ่าน include block

include "root" {
  path = find_in_parent_folders("root.hcl")
}

find_in_parent_folders("root.hcl") จะไต่ขึ้นไปตาม directory tree เริ่มจาก directory ของ unit นั้นเอง จนกว่าจะเจอไฟล์ชื่อ root.hcl ไม่ว่า unit จะอยู่ลึกแค่ไหนในเชิงชั้น เช่น แค่ชั้นเดียวใต้ root หรือลึกถึงห้าชั้น ฟังก์ชันนี้ก็จะไต่ขึ้นไปหาจนเจอ ทำให้การย้าย unit ไปอยู่ที่ระดับความลึกอื่นไม่ทำให้ reference พังไป ส่วน label ของ include block อย่าง "root" ในตัวอย่างนี้ คือชื่อที่ Terragrunt ใช้ track การ include นี้ภายใน unit หนึ่งสามารถมี include block ได้มากกว่าหนึ่งตัว แต่ละตัวมี label ของตัวเอง และชี้ไปยังไฟล์คนละไฟล์ได้

เมื่อ include แล้ว ทุก block ที่ root.hcl กำหนดไว้ ไม่ว่าจะเป็น remote_state, provider generate block หรืออะไรก็ตามที่วางไว้ตรงนั้น จะทำงานเหมือนถูกเขียนอยู่ใน terragrunt.hcl ของ unit เองโดยตรง นี่คือกลไกทั้งหมด include block เพียงตัวเดียวแทนที่บรรทัดซ้ำนับสิบที่มิฉะนั้นต้องเขียนซ้ำในทุก unit ทั่วทั้ง tree

แชร์ config แบบละเอียดลงไปด้วย locals และ read_terragrunt_config

root.hcl ไม่ใช่ที่เดียวที่ shared configuration จะอยู่ได้ tree ขนาดใหญ่มักมีชั้นกลางอีกชั้นด้วย เช่น ไฟล์ subscription.hcl หนึ่งไฟล์ต่อหนึ่ง Azure subscription วางอยู่เหนือทุก unit ที่อยู่ภายใต้ subscription นั้น เก็บค่าที่เจาะจงสำหรับ subscription นั้นโดยเฉพาะ

locals {
  subscription_id = "11111111-1111-1111-1111-111111111111"
  environment     = "networking"
}

unit ที่อยู่ภายใต้ subscription นั้นอ่านไฟล์นี้ด้วย read_terragrunt_config() ห่อไว้ใน locals block ของตัวเอง

include "root" {
  path = find_in_parent_folders("root.hcl")
}

locals {
  subscription_vars = read_terragrunt_config(find_in_parent_folders("subscription.hcl"))
}

inputs = {
  subscription_id = local.subscription_vars.locals.subscription_id
  address_space   = ["10.1.0.0/16"]
  tags = {
    environment = local.subscription_vars.locals.environment
  }
}

read_terragrunt_config() จะ parse ไฟล์ที่ส่งเข้าไป แล้วคืนค่าเป็น map ของทุกอย่างที่ประกาศไว้ในไฟล์นั้น ทำให้ local.subscription_vars.locals.subscription_id เข้าถึง locals block ของ subscription.hcl ได้โดยตรง สังเกตว่านี่เป็นกลไกคนละแบบกับ include โดย include จะสืบทอด block อย่าง remote_state มาทั้งหมด ส่วน read_terragrunt_config() ให้ unit เข้าถึงค่าเฉพาะจุดจากไฟล์ที่เลือกจะอ่าน โดยไม่ต้องสืบทอดทั้งไฟล์ ความต่างนี้เองที่ทำให้เหมาะกับ intermediate file root.hcl ยังคง apply กับทุก unit ทั่วทั้ง tree ผ่าน include ส่วน subscription.hcl ก็แค่ต้องถูกอ่านโดย unit จำนวนหนึ่งที่อยู่ภายใต้ subscription นั้นจริง ๆ เท่านั้น

inputs: เทียบเท่ากับไฟล์ tfvars ใน Terragrunt

ทุกตัวอย่างที่ผ่านมาจบด้วย inputs block ซึ่งสมควรได้รับคำอธิบายของตัวเอง ใน Terraform ธรรมดา คุณส่งค่า variable ให้ root module ผ่านไฟล์ .tfvars หรือ flag -var บน command line ส่วน inputs block ของ Terragrunt ก็ทำหน้าที่เดียวกัน เพียงแต่ค่าต่าง ๆ อยู่ใน HCL ของ unit เองโดยตรง แทนที่จะอยู่ในไฟล์แยกต่างหาก

inputs = {
  address_space = ["10.0.0.0/16"]
  location      = "westeurope"
}

ทุก key ใน inputs ต้องตรงกับ variable ที่ underlying Terraform module ประกาศไว้จริง Terragrunt จะส่งแต่ละค่าผ่านไปเหมือนถูกส่งด้วย -var เพราะ inputs เป็น HCL ธรรมดา จึง reference locals, ผลลัพธ์จาก read_terragrunt_config() หรือในบทถัดไปของ module นี้ คือ output ของ unit อื่นได้ ซึ่งไฟล์ .tfvars แบบ static ทำแบบนี้ไม่ได้เลย

flowchart TD
  root["root.hcl (remote_state, provider generate)"]
  sub["subscription.hcl (locals: subscription_id, environment)"]
  unit["vnet/terragrunt.hcl"]
  root -->|include find_in_parent_folders root.hcl| unit
  sub -->|read_terragrunt_config find_in_parent_folders subscription.hcl| unit
  unit --> inputs["inputs = merge of root, subscription, and unit values"]

root.hcl, intermediate subscription.hcl และ unit ที่รวมทั้งสองระดับเข้าด้วยกัน

🏗️ สรุปในหนึ่งบรรทัด

include "root" { path = find_in_parent_folders("root.hcl") } block สืบทอดทุก block ที่กำหนดไว้ใน shared root file มาทั้งหมด โดย unit ไม่ต้องเขียนซ้ำเลย และ find_in_parent_folders() จะไต่ directory tree ขึ้นไปจนเจอไฟล์นั้นไม่ว่า unit จะอยู่ลึกแค่ไหน locals block ร่วมกับ read_terragrunt_config(find_in_parent_folders(...)) ขยายแนวคิดเดียวกันไปยัง intermediate file เช่น subscription.hcl ต่อหนึ่ง subscription ทำให้ unit เข้าถึงค่าเฉพาะจุดที่แชร์กันได้ โดยไม่ต้องสืบทอดทั้งไฟล์ ส่วน inputs block คือสิ่งที่เทียบเท่ากับไฟล์ .tfvars ใน Terragrunt ส่งค่าตรงเข้าไปยัง variable ของ underlying Terraform module และเพราะเป็น HCL ธรรมดา จึงรวมค่าจาก root, intermediate file และตัว unit เองเข้าด้วยกันในที่เดียวได้