TF 101 Study 4주차 정리 - state, module

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

---

CH 5. State

---

• 테라폼은 Stateful한 애플리케이션 → 상태를 관리하는 애플리케이션
• 프로비저닝 결과를 State에 저장하고 프로비저닝한 모든 내용을 저장된 상태로 추적
• terraform.tfstate 파일에 JSON 으로 저장 → 혼자 로컬에서 관리하거나 협업하기 위해 원격 저장소에서 관리
• State에는 작업자가 정의한 코드와 실제 프로비저닝 결과를 저장 → 이후후의 리소스 생성, 수정, 삭제에 대한 동작을 판단

5-1. State의 목적과 의미

---

• terraform apply → State를 사용해서 이전에 생성된 리소스와 비교해 생성, 수정, 삭제 동작이 수행

• State의 역할

  • State에는 테라폼 구성과 실제를 동기화하고 각 리소스에 고유한 아이디(리소스 주소)로 맵핑
  • 리소스 종속성과 같은 메타데이터를 저장하고 추적
  • 테라폼 구성으로 프로비저닝 결과를 캐싱하는 역할을 수행

• Plan을 실행하면 암묵적으로 refresh 동작을 수행하면서 실제 리소스와 State를 비교합니다.

• Plan에서의 -refresh=false
  → 대량으로 리소스를 관리하는 경우 실제 리소스와 State를 비교하는데 오랜 시간이 걸릴 수 있음
  → State를 기준으로 실행 계획을 생성하는 옵션

5-2. State 동기화

---

• 테라폼은 configuration 파일과 기존 State를 비교하여 생성, 수정, 삭제 여부를 결정

• configuration 파일은 테라폼 코드로 작성한 파일을 의미합니다.

• 테라폼은 configuration 파일 또는 State 파일에 정보가 있는 리소스만을 관리합니다.

• configuration - 리소스 존재 / state - 리소스 없음 → 리소스 create

• configuration - 리소스 존재 / state - 리소스 존재 → 리소스 update 또는 no changes

• configuration - 리소스 없음 / state - 리소스 존재 → 리소스 destroy

5-3. 워크스페이스

---

• State를 관리하는 논리적인 가상공간 → 워크스페이스

• 워크스페이스를 구분하면 동일한 구성에서 기존 인프라에 영향을 주지 않으면서 간편하게 테라폼 프로비저닝을 테스트할 수 있다.

• 기본 워크스페이스는 default로 정의되고, 사용 중인 워크스페이스는 terraform workspace list 명령으로 확인할 수 있다.

• terraform workspace new <워크스페이스 이름> : 새로운 워크스페이스 생성

• configuration 파일에서는 terraform.workspace로 워크스페이스의 이름을 참조할 수 있다.

• 테라폼 OSS의 워크스페이스는 완벽한 격리가 불가능하기에 디렉터리 기반의 레이아웃을 사용할 것을 권장한다.

• 워크스페이스를 시스템적으로 보완하여 사용하고자 한다면 테라폼 클라우드 또는 테라폼 엔터프라이즈를 사용할 수도 있다.

CH 6. 모듈

---

• 테라폼으로 리소스를 관리하다보면 시간 지날수록 관리하는 리소스가 많아지고 복잡해진다.
  → 리소스 간의 연관 관계가 복잡해지고 변경 작업의 영향도를 분석하기 어려워진다.

• 모듈 → 테라폼 구성의 집합

• 모듈은 테라폼으로 관리하는 대상의 규모가 커지고 복잡해진 문제를 보완하고 관리 작업을 수월하기 위한 방법입니다.

• 모듈은 루트 모듈과 자식 모듈로 구분된다.

  • 루트 모듈(Root Module) → 테라폼을 실행하고 프로비저닝하는 최상위 모듈
  • 자식 모듈(Child Module) → 루트모듈의 구성에서 호출하는 외부 구성 집합

• 모듈 사용의 장점 → 관리 효율화, 캡슐화, 재사용성, 일관성, 표준화

6-1. 모듈 작성 기본 원칙

---

• 모듈 디렉터리의 권장 형식 → terraform-<프로바이더 이름>-<모듈 이름>
• 테라폼 코드는 처음부터 모듈화를 가정하고 구성할 것을 권장
• 각각의 모듈은 독립적으로 관리하는 것을 권장
• 공개된 테라폼 레지스트리의 모듈을 참고할 것을 권장
• 작성한 모듈은 공개 또는 비공개로 공유 할 것을 권장 → 사용성을 높이고 피드백을 통해 더 발전된 모듈을 구성

6-2. 모듈화해보기

---

• 테라폼 모듈화란? 테라폼 코드를 재사용하기 위한 템플릿 작업
  → 작성된 모듈을 다른 루트 모듈에서 가져다 사용하면서 재사용성과 표준화 구조로 구성할 수 있습니다.

• 모듈은 기본적으로 입력 변수를 입력받아 결과를 출력하는 구조로 구성
  → 모듈에서 필요한 값은 variable로 입력 받고, 모듈에서 생성한 값 중 외부 참조가 필요한 값은 output으로 구성

• 테라폼 코드로 다수의 리소스를 같은 목적으로 여러번 반복해서 사용하려면 리소스 만큼 반복해서 코드를 작성해야합니다.
  → 모듈을 활용하면 반복되는 리소스 묶음을 최소화 할 수 있습니다.

• 모듈로 묶여진 리소스는 module이라는 정의를 통해 단순하게 재활용하고 반복 사용할 수 있다.

• 모듈의 결과 참조 → module.<모듈 이름>.<output 이름>

6-3. 모듈 사용 방식

---

• 모듈에서 사용되는 모든 리소스는 관련 프로바이더의 정의가 필요합니다.

• 프로바이더 정의의 위치

  • 자식 모듈에서 프로바이더 정의

    → 자식 모듈의 프로바이더 버전이 민감하거나 자식 모듈이 독립적인 구조일 때 사용
    → 루트 모듈과 자식 모듈의 프로바이더 버전이 일치되지 않으면 오류가 발생하고 반복문을 사용할 수 없기 때문에 잘 사용하지 않는 방식

  • 루트 모듈에서 프로바이더 정의
    → 자식 모듈이 루트 모듈의 프로바이더 구성에 종속되는 방식
    → 프로바이더를 모듈 내 리소스와 데이터 소스에 일괄 적용

      # 루트 모듈에서 aws.seoul을 정의하고 ec2_seoul 모듈을 호출
      provider "aws" {
        alias  = "seoul"
        region = "ap-northeast-2"
      }
    
      module "ec2_seoul" {
        provider = {
          aws = aws.seoul
        }
        source = "../modules/terraform-aws-ec2"
        instance_type = "m5.large"
      }

• 모듈에도 반복문을 사용할 수 있다.

    locals {
      env = {
        dev = {
          type = "t3.micro"
          name = "dev_ec2"
        }
        prod = {
          type = "m5.large"
          name = "prod_ec2"
        }
      }
    }
  
    module "ec2_seoul" {
      for_each      = local.env
      source        = "../modules/terraform-aws-ec2"
      instance_type = each.value.type
      instance_name = each.value.name
    }

6-4. 모듈 소스 관리

---

• module 블록에서 source로 모듈 코드의 위치를 정의

    # 로컬 디렉터리에 있는 모듈 사용
    module "local_directory_vpc" {
      source = "../modules/"
    }
  
    # 테라폼 레지스트리에 있는 모듈 사용
    module "terraform_registry_vpc" {
      source = "terraform-aws-modules/vpc/aws"
    }
  
    # github에 있는 모듈 사용
    module "github_vpc" {
      source = "github.com/hyuckang/terraform-vpc"
    }

• 모듈 소스의 유형

  • 로컬 디렉터리, 테라폼 레지스트리, 깃허브, S3 등