Terraform 인프라

Terraform은 인프라를 안전하고 예측 가능하게 생성, 변경 및 개선할 수 있는 오픈 소스 코드형 인프라 소프트웨어 도구입니다.

Terraform 인프라 생성기는 Terraform 인프라 프로젝트를 생성합니다. 생성된 애플리케이션에는 Checkov 보안 검사를 통한 보안 모범 사례가 포함되어 있습니다.

사용법

Terraform 프로젝트 생성

두 가지 방법으로 새 Terraform 프로젝트를 생성할 수 있습니다:

CLI

pnpm

pnpm nx g @aws/nx-plugin:terraform#project --name=tf-infra

yarn

yarn nx g @aws/nx-plugin:terraform#project --name=tf-infra

npm

npx nx g @aws/nx-plugin:terraform#project --name=tf-infra

bun

bunx nx g @aws/nx-plugin:terraform#project --name=tf-infra

어떤 파일이 변경될지 확인하기 위해 드라이 런을 수행할 수도 있습니다

pnpm

pnpm nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

yarn

yarn nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

npm

npx nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

bun

bunx nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

VSCode

1. 설치 Nx Console VSCode Plugin 아직 설치하지 않았다면
2. VSCode에서 Nx 콘솔 열기
3. 클릭 Generate (UI) "Common Nx Commands" 섹션에서
4. 검색 @aws/nx-plugin - terraform#project
5. 필수 매개변수 입력
   • name: tf-infra
6. 클릭 Generate

옵션

매개변수	타입	기본값	설명
name 필수	string	-	프로젝트의 이름입니다.
type	application | library	application	terraform lib(재사용 가능한 모듈) 또는 app(배포 가능한 애플리케이션) 여부입니다.
directory	string	packages	새 프로젝트의 디렉토리입니다.
subDirectory	string	-	프로젝트가 배치되는 하위 디렉토리입니다. 기본값은 프로젝트 이름입니다.
preferInstallDependencies	boolean	true	생성기 실행 후 의존성 설치를 선호할지 여부입니다. 여러 생성기를 일괄 처리할 때 설치를 연기하려면 false로 설정하세요 (후속 생성기가 Nx 프로젝트 그래프를 계산할 수 있도록 필요한 경우 설치는 여전히 실행됩니다); 마지막에 한 번 설치합니다.

생성기 출력

생성기는 프로젝트 유형에 따라 다른 파일 구조를 생성합니다:

type = application

애플리케이션 타입

애플리케이션 프로젝트(--type=application)의 경우, 생성기는 원격 상태 관리를 포함한 완전한 Terraform 애플리케이션을 생성합니다:

• 디렉터리src

  • main.tf 메인 Terraform 구성 파일
  • providers.tf S3 백엔드를 사용한 프로바이더 구성
  • variables.tf 입력 변수 정의
  • outputs.tf 출력 값 정의
  • 디렉터리env 환경별 변수 파일

    • dev.tfvars 개발 환경 변수
• 디렉터리bootstrap 원격 상태를 위한 부트스트랩 구성

  • main.tf 상태 저장을 위한 S3 버킷 및 정책
  • providers.tf AWS 프로바이더 구성
  • variables.tf 부트스트랩 변수 정의
• 디렉터리scripts nx bootstrap 및 init 타겟에서 실행되는 Node 헬퍼

  • aws-config.ts AWS SDK 자격 증명 체인을 통해 계정 + 리전 확인
  • bootstrap.ts 부트스트랩 tfstate를 가져오기/푸시하고 terraform apply 실행
  • init.ts S3 백엔드 구성으로 terraform init 실행
• project.json 프로젝트 구성 및 빌드 타겟

공유 Terraform 모듈

생성기는 또한 packages/common/terraform 라이브러리를 생성하며, 이는 초기에 메트릭 모듈(메타데이터가 포함된 빈 Cloudformation 스택 생성)만 추가하고 자동으로 계측되어 nx-plugin-for-aws 팀이 사용 메트릭을 추적할 수 있도록 합니다.

type = library

라이브러리 타입

라이브러리 프로젝트(--type=library)의 경우, 생성기는 재사용 가능한 Terraform 모듈을 위한 더 간단한 구조를 생성합니다:

• 디렉터리src

  • main.tf 메인 Terraform 모듈 파일
• project.json 프로젝트 구성 및 빌드 타겟

애플리케이션 vs 라이브러리

애플리케이션 프로젝트는 원격 상태 관리를 포함한 완전한 배포 기능을 제공하는 반면, 라이브러리 프로젝트는 다른 프로젝트에서 사용할 수 있는 재사용 가능한 Terraform 모듈을 생성하도록 설계되었습니다.

Terraform 인프라 구현

src/main.tf 내부에서 Terraform 인프라 작성을 시작할 수 있습니다. 예를 들어:

src/main.tf

locals {
  account_id = data.aws_caller_identity.current.account_id
  aws_region = data.aws_region.current.id
}

resource "null_resource" "print_info" {
  # triggers = {
  #   always_run = timestamp()
  # }

  provisioner "local-exec" {
    command = "echo 'AWS Region: ${local.aws_region}, AWS Account: ${local.account_id}, Environment: ${var.environment}'"
  }
}

# Declare your infrastructure here
resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-name"
}

프로젝트 간 종속성

별도의 프로젝트(lib)에서 모듈을 실행하려면 다음과 같이 할 수 있습니다:

module "lib_module" {
  source = "../../path/to/my-lib/src"
}

이렇게 하면 Nx 그래프가 자동으로 업데이트되어 사용하는 애플리케이션과 라이브러리 간에 종속성이 추가됩니다.

환경 구성

src/env/*.tfvars 파일에서 환경별 변수를 구성합니다.

새 환경을 추가하려면 환경별 변수가 포함된 새 src/env/<environment>.tfvars 파일을 생성하고 새 환경 구성을 위해 project.json의 apply, destroy, init, plan에 새 항목을 추가합니다. 예를 들어, prod 환경을 추가한다고 가정해 봅시다:

src/env/prod.tfvars

# Production environment variables
environment = "prod"
region      = "us-west-2"

project.json

{
  "targets": {
        "apply": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform apply ../../../dist/packages/infra/terraform/dev.tfplan"
                },
                "prod": {
                    "command": "terraform apply ../../../dist/packages/infra/terraform/prod.tfplan"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd": "{projectRoot}/src"
            },
            "dependsOn": ["plan"]
        },
        "destroy": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform destroy -var-file=env/dev.tfvars"
                },
                "prod": {
                    "command": "terraform destroy -var-file=env/prod.tfvars"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd":"{projectRoot}/src"
            },
            "dependsOn": ["init"]
        },
        "init": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "env": { "TF_ENV": "dev" }
                },
                "prod": {
                    "env": { "TF_ENV": "prod" }
                }
            },
            "options": {
                "forwardAllArgs": true,
                "commands": ["tsx {projectRoot}/scripts/init.ts {projectRoot}"],
                "cwd": "{workspaceRoot}"
            }
        },
        "plan": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform plan -var-file=env/dev.tfvars -out=../../../dist/packages/infra/terraform/dev.tfplan"
                },
                "prod": {
                    "command": "terraform plan -var-file=env/dev.tfvars -out=../../../dist/packages/infra/terraform/prod.tfplan"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd": "{projectRoot}/src"
            },
            "dependsOn": ["init"]
        }
    }
}

기본 환경

기본적으로 모든 타겟은 dev 환경을 가정하지만, 다음과 같이 특정 환경을 대상으로 지정할 수 있습니다:

• pnpm
• yarn
• npm
• bun

pnpm nx apply tf-infra --configuration=prod

yarn nx apply tf-infra --configuration=prod

npx nx apply tf-infra --configuration=prod

bunx nx apply tf-infra --configuration=prod

상태가 환경 간에 tfstate를 자동으로 분리하므로 언제든지 환경을 전환할 수도 있습니다.

type = application

원격 상태 부트스트랩 (애플리케이션 프로젝트만 해당)

인프라를 배포하기 전에 원격 상태 백엔드를 부트스트랩해야 합니다. 이렇게 하면 Terraform 상태 파일을 저장할 S3 버킷이 생성됩니다:

pnpm

pnpm nx bootstrap tf-infra

yarn

yarn nx bootstrap tf-infra

npm

npx nx bootstrap tf-infra

bun

bunx nx bootstrap tf-infra

AWS 프로필 구성

부트스트랩 리소스를 배포하려는 계정/리전으로 AWS CLI 프로필이 구성되어 있는지 확인하세요.

부트스트랩 타겟은 애플리케이션 타입 프로젝트에만 사용할 수 있습니다. 라이브러리 프로젝트는 재사용 가능한 모듈로 설계되었으므로 원격 상태 관리가 필요하지 않습니다.

사용 가능한 타겟

사용 가능한 타겟은 프로젝트 유형에 따라 다릅니다:

공통 타겟 (애플리케이션 및 라이브러리 모두)

인프라 검증

validate 타겟을 사용하여 Terraform 구성을 검증할 수 있습니다:

pnpm

pnpm nx validate tf-infra

yarn

yarn nx validate tf-infra

npm

npx nx validate tf-infra

bun

bunx nx validate tf-infra

코드 포맷팅

fmt 타겟을 사용하여 Terraform 코드를 포맷합니다:

pnpm

pnpm nx fmt tf-infra

yarn

yarn nx fmt tf-infra

npm

npx nx fmt tf-infra

bun

bunx nx fmt tf-infra

보안 테스트

test 타겟을 사용하여 Checkov로 인프라에 대한 보안 검사를 실행합니다:

pnpm

pnpm nx test tf-infra

yarn

yarn nx test tf-infra

npm

npx nx test tf-infra

bun

bunx nx test tf-infra

보안 테스트 결과는 루트 dist 폴더의 dist/packages/<my-terraform-project>/checkov 아래에서 찾을 수 있습니다.

type = application

애플리케이션 전용 타겟

다음 타겟은 애플리케이션 타입 프로젝트에만 사용할 수 있습니다:

인프라 계획

변경 사항을 적용하기 전에 plan 타겟을 실행하여 Terraform이 수행할 작업을 확인할 수 있습니다:

pnpm

pnpm nx plan tf-infra

yarn

yarn nx plan tf-infra

npm

npx nx plan tf-infra

bun

bunx nx plan tf-infra

이렇게 하면 dist/packages/<my-terraform-project>/terraform/dev.tfplan에 계획 파일이 생성됩니다.

Terraform 초기화

init 타겟을 사용하여 Terraform 작업 디렉터리를 초기화합니다:

pnpm

pnpm nx run tf-infra:init

yarn

yarn nx run tf-infra:init

npm

npx nx run tf-infra:init

bun

bunx nx run tf-infra:init

AWS에 배포

계획 후 apply 타겟을 사용하여 인프라를 AWS에 배포할 수 있습니다:

pnpm

pnpm nx apply tf-infra

yarn

yarn nx apply tf-infra

npm

npx nx apply tf-infra

bun

bunx nx apply tf-infra

자동 승인

위 명령은 plan 타겟에서 생성된 계획을 적용합니다. 변경 사항을 검토하려면 먼저 plan을 실행해야 합니다.

배포 별칭

deploy 타겟도 apply의 별칭으로 사용할 수 있습니다.

• pnpm
• yarn
• npm
• bun

pnpm nx deploy tf-infra

yarn nx deploy tf-infra

npx nx deploy tf-infra

bunx nx deploy tf-infra

또는

pnpm

pnpm nx apply tf-infra

yarn

yarn nx apply tf-infra

npm

npx nx apply tf-infra

bun

bunx nx apply tf-infra

를 서로 바꿔서 사용할 수 있습니다.

출력 가져오기

Terraform 구성에서 출력 값을 검색합니다:

pnpm

pnpm nx output tf-infra

yarn

yarn nx output tf-infra

npm

npx nx output tf-infra

bun

bunx nx output tf-infra

인프라 삭제

인프라를 해체해야 할 때 destroy 타겟을 사용합니다:

pnpm

pnpm nx destroy tf-infra

yarn

yarn nx destroy tf-infra

npm

npx nx destroy tf-infra

bun

bunx nx destroy tf-infra

파괴적 작업

이렇게 하면 이 Terraform 구성에서 관리하는 모든 리소스가 영구적으로 삭제됩니다. 주의해서 사용하세요!

부트스트랩 리소스 삭제

부트스트랩 리소스(상태 저장을 위한 S3 버킷)를 정리하려면:

pnpm

pnpm nx bootstrap-destroy tf-infra

yarn

yarn nx bootstrap-destroy tf-infra

npm

npx nx bootstrap-destroy tf-infra

bun

bunx nx bootstrap-destroy tf-infra

추가 정보

Terraform에 대한 자세한 내용은 Terraform 문서 및 AWS 프로바이더 문서를 참조하세요.