TF 101 Study 2주차 정리 - data source, variable, local, output, for_each, for, dynamic

• 가시다님이 진행하시는 CloudNeta의 Terraform 101 Study에 참가하며 작성한 내용입니다.
• 스터디 교재 → 테라폼으로 시작하는 IaC

CH3. 기본 사용법 - 2

---

3-5. 데이터 소스

---

• 데이터 소스 → 테라폼으로 정의되지 않은 외부 리소스 또는 저장된 정보를 테라폼 내에서 참조할 때 사용
• 외부에서 데이터 소스를 가져오기 위한 조건 → 인수(Arguments)
• 가져온 데이서 소스의 내용 → 속성(Attributes)

# 테라폼 코드
data "<리소스 유형>" "<이름>" {
    <인수> = <값>
}

# 데이터 소스 참조
data.<리소스 유형>.<이름>.<속성>

• 데이터 소스로 리전 내에서 사용 가능한 가용영역 목록 가져오기

3-6. 입력 변수(variable)

---

• Input Variables → 필요한 속성 값을 정의해 코드의 변경 없이 인프라를 생성하기 위해 사용
• 입력 변수는 테라폼 Plan시에 입력하고 참조는 var.<이름>으로 한다

variable "<이름>" {
    <인수> = <값>
}

• 입력 변수를 활용하여 EC2에 Name 태그 적용하기

변수 유형

• 기본 유형
  • string, number, bool, any
• 컬렉션 유형
  • list → 인덱스로 참조
  • set → 키로 참조
  • map, set → 선언된 값이 정렬

유효성 검사

• 테라폼 0.13.0 이후로 사용자 지정 유효성 검사가 가능 → 변수 블록 내에 validation과 condition, error_message
• 변수 코드 내에서 validation은 여러번 가능

variable "image_id" {
  type        = string
  description = "The id of the machine image(AMI) to use for the server"

  validation {
    condition     = length(var.image_id) > 4
    error_message = "The image_id value must exceed 4."
  }
  validation {
    condition     = can(regex("^ami-", var.image_id))
    error_message = "The image_id value mus starting with 'ami-i'."
  }
}

민감한 변수 취급

• sensitive가 적용된 변수는 Plan, Apply시에 (sensitive value)로 표시가 된다.
• sensitive를 적용해도 terraform.tfstate 파일에는 평문으로 저장

variable "my_password" {
   default   = "password"
   sensitive = true
 }

변수 입력 방식과 우선순위

• 변수가 선언되는 방식에 따라 우선순위가 존재
• CLI에서 입력 < default 값 < 환경변수 < terraform.tfvars < *.auto.tfvars < *auto.tfvars.json < -var 또는 -var-file로 변수 지정
• 환경변수는 ‘TF_VAR_변수이름’으로 선언
• *.atuo.tfvars과 *.auto.tfvars.json → 파일명에 따라 우선순위 적용(a.auto.tfvars보다 b.auto.tfvars의 우선순위가 높다, *.auto.tfvars.json도 동일)
• 변수 선언 방식이 다양한 이유 → 테라폼 실행 환경, 실행 방식에 따라 동일한 코드로 다수의 프로비저닝을 수행하도록 디자인

3-7. local(지역 값)

---

• local → 코드 내에서 가공되어 동작하는 값을 선언(locals 블럭으로 선언)
• 변수처럼 실행 시에 입력받을 수 없다.
• 값이나 표현식을 반복적으로 사용할 수 있는 편의성을 제공
  → 빈번하게 여러 곳에서 사용하는 경우 실제 값에 대한 추적이 어려워져 관리의 측면에서 부담이 발생할 수 있다.
• 동일한 tf파일 내에서 여러번 선언 가능하고 여러 파일에 걸쳐 만드는 것도 가능
  → locals에 선언한 이름은 전체 루트 모듈 내에서 유일해야 합니다.

locals {
    name = "tf101"
    my_info = {
        name = "hyuckang"
        region = "KR"
    }
}
# local.name -> tf101
# local.my_info.name -> hyuckang

• local 변수를 적용하여 EC2 인스턴스에 region 태그 달기

3-8. 출력(output)

---

• output → 프로비저닝 수행 후의 결과 값을 확인하는 용도
• 테라폼 모듈 간 또는 워크스페이스 간 데이터 접근 용도
• output 결과에서 리소스 생성 후 결정되는 속성 값은 프로비저닝이 완료되어야 최종적으로 결과를 확인 할 수 있습니다.
  → 이런 경우 terraform plan에서 값을 출력할 수 없습니다.

3-9. 반복문

---

count

• 선언된 정수(count)만큼 리소스나 모듈을 생성
• count에서 생성되는 참조값은 count.index이며 인덱스는 0부터 시작해 1씩 증가

resource "local_file" "count_files" {
    count = 5
    content = "abc"
    filename = "abc${count.index}.txt"
}

# count로 생성한 리소스 참조
<리소스 타입>.<이름>[<인덱스 번호>]
local_file.count_files[0].filename # abc0.txt

• count와 list를 활용하여 리소스를 생성한 경우
  → list 중간에 값이 삭제되면 의도하지 않은 삭제 및 재생성이 일어날 수 있다.

for_each

• map 또는 set을 이용하여 선언된 key의 개수만큼 리소스를 생성
• key 값은 count의 index와는 달리 고유하므로 중간에 값을 삭제한 후 다시 적용해도 삭제한 값에 대해서만 리소스를 삭제
• each.key와 each.value를 통해 코드내에서 참조 가능

# AAA라는 내용을 가진 key_a.txt와 BBB라는 내용을 가진 key_b.txt가 생성되는 코드
resource "local_file" "for_each_test" {
    for_each = {
        key_a = "AAA"
        key_b = "BBB"
    }
    content = each.value
    filename = "${each.key}.txt"
}

for

• 복합 형식 값의 반복하는데 사용

• for문을 [ ]로 묶으면 tuple이 반환되고, { }로 묶으면 object가 반환된다.

• object의 경우에 키와 값에 대한 쌍은 => 기호로 구분한다.

• list와 for

    # 값 또는 인덱스를 반복 -> 인수가 1개인 경우 "값"만 반복, 인수가 2개인 경우 "인덱스와 값"을 반복
    # 관용적으로 값은 v, 인덱스는 i로 표현
  
    output "list_one_argument" {
      value = [for v in [1, 2, 3] : "value : ${v}"]
    }
    # list_one_argument의 출력 결과
    list_one_argument = [
      "value : 1",
      "value : 2",
      "value : 3",
    ]
  
    output "list_two_argument" {
      value = [for i, v in [1, 2, 3] : "index : ${i} / value : ${v}"] # 출력 index : 0 / value : 1
    }
    # list_two_argument의 출력 결과
    list_two_argument = [
      "index : 0 / value : 1",
      "index : 1 / value : 2",
      "index : 2 / value : 3",
    ]

• map과 for

    # 키 또는 인덱스를 반복 -> 인수가 1개인 경우 "키"만 반복, 인수가 2개인 경우 "키와 값"을 반복
    # 관용적으로 키는 k, 값은 v로 표현
    variable "members" {
      default = {
        name_a = { role = "guest", group = "infra" },
        name_b = { role = "member", group = "dev" },
        name_c = { role = "admin", group = "infra" },
      }
    }
  
    output "print_role" {
      value = [for k, v in var.members : "${k} has ${v.role}"]
    }
  
    # print_role의 출력 결과
    print_role = [
      "name_a has guest",
      "name_b has member",
      "name_c has admin",
    ]

dynamic

• 리소스 자체의 반복이 아닌 리소스 내의 블록 속성(Attribute as Blocks)을 반복하는 경우 → dynamic
• 기존 블록의 속성 이름을 dynamic 블록의 이름 선언하고, 기존 블록의 속성을 content 블록에 작성한다.

# 기존의 리소스 내의 반복
resource "provider_resource" "name" {
  some_setting {
    key = a_value
  }
  some_setting {
    key = b_value
  }
  some_setting {
    key = c_value
  }
}

# 리소스 내의 반복을 dynamic으로 변경
resource "provider_resource" "name" {
  dynamic "some_setting" {
    for_each = {
      a_key = a_value
      b_key = b_value
      c_key = c_value
    }
  }
  content {
    key = some_setting.value
  }
}

• dynamic을 활용하여 security group 내에서 security group rule 반복 생성하기