GitLab Terraform 도우미

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

경고: Terraform CI/CD 템플릿은 폐기 예정이며 GitLab 18.0에서 제거될 예정입니다. 자세한 정보는 폐기 알림을 참조하세요.

GitLab은 GitLab 관리 Terraform State와의 통합을 용이하게하기 위해 두 가지 도우미를 제공합니다.

gitlab-terraform 스크립트, 이는 terraform 명령어를 감싸는 얇은 래퍼입니다.
terraform-images 컨테이너 이미지, 이 이미지에는 gitlab-terraform 스크립트와 terraform 자체가 포함되어 있습니다.

두 도우미는 Terraform 이미지 프로젝트에서 유지보수됩니다.

`gitlab-terraform`

gitlab-terraform 스크립트는 terraform 명령어를 감싸는 얇은 래퍼입니다.

CI/CD 파이프라인에서 gitlab-terraform을 실행하여 GitLab 관리 Terraform State 백엔드에 연결하는 데 필요한 환경 변수를 설정합니다.

도우미 스크립트의 소스(실행하지 않음)

gitlab-terraform 스크립트를 소스로 사용하면 terraform을 실제로 실행하지는 않고 terraform 호출을 위한 환경을 구성합니다. 환경을 준비하거나 terragrunt와 같은 대체 도구를 사용해야하는 경우에는 스크립트를 소스로 사용할 수 있습니다.

스크립트를 소스로 사용하려면 다음을 실행하세요:

source $(which gitlab-terraform)

BusyBox와 같은 일부 셸은 다른 스크립트가 귀하의 스크립트를 소스하는 경우를 지원하지 않습니다. 자세한 정보는 이 Stack Overflow 쓰레드를 참조하세요. 이 문제를 해결하려면 bash, zsh, 또는 ksh를 사용하거나 셸에서 직접 gitlab-terraform을 소스로 사용해야 합니다.

명령어

다음 명령어로 gitlab-terraform을 실행할 수 있습니다.

명령어	명령행을 전달합니까?	암시적 init?	설명
`gitlab-terraform apply`	예	예	`terraform apply` 실행.
`gitlab-terraform destroy`	예	예	`terraform destroy` 실행.
`gitlab-terraform fmt`	예	아니요	check 모드에서 `terraform fmt` 실행.
`gitlab-terraform init`	예	적용되지 않음	`terraform init` 실행.
`gitlab-terraform plan`	예	예	`terraform plan` 실행하고 `plan.cache` 파일을 생성함.
`gitlab-terraform plan-json`	아니요	아니요	`plan.cache` 파일을 MR 통합을 위한 GitLab Terraform 보고서로 변환함.
`gitlab-terraform validate`	예	예 (백엔드 미포함)	`terraform validate` 실행.
`gitlab-terraform -- <cmd>`	예	아니요	래핑되어 있더라도 `terraform <cmd>` 실행.
`gitlab-terraform <cmd>`	예	아니요	래핑되지 않은 경우에만 `terraform <cmd>` 실행.

일반 변수

gitlab-terraform을 실행할 때 다음 변수가 구성됩니다.

변수	기본값	설명
`TF_ROOT`	설정되지 않음	Terraform 구성의 루트. 설정되어 있으면 Terraform `-chdir` 인수 값으로 사용됨. 모든 읽기 및 쓰기 파일은 주어진 구성 루트에 상대적입니다.
`TF_CLI_CONFIG_FILE`	`$HOME/.terraformrc`	Terraform 구성 파일의 위치.
`TF_IN_AUTOMATION`	`true`	Terraform 명령어가 자동화되었음을 나타내기 위해 `true`로 설정됨.
`TF_GITLAB_SOURCED`	`false`	만약 `gitlab-terraform`가 소스로 사용되었다면 `true`로 설정됩니다.
`TF_PLAN_CACHE`	`$TF_ROOT/plan.cache` 또는 `$PWD/plan.cache`	plan cache 파일의 위치. `TF_ROOT`가 설정되지 않은 경우 현재 작업 디렉토리(`$PWD`)를 기준으로 경로가 지정됩니다.
`TF_PLAN_JSON`	`$TF_ROOT/plan.json` 또는 `$PWD/plan.json`	MR 통합을 위한 plan JSON 파일의 위치. `TF_ROOT`가 설정되지 않은 경우 현재 작업 디렉토리(`$PWD`)를 기준으로 경로가 지정됩니다.
`DEBUG_OUTPUT`	`"false"`	`"true"`로 설정하면 각 문이 `set -x`와 함께 기록됩니다.

GitLab 관리 Terraform 상태 변수

gitlab-terraform을 실행할 때 다음 변수가 구성됩니다.

변수	기본값	설명
`TF_STATE_NAME`	설정되지 않음	`TF_ADDRESS`가 설정되지 않았고 `TF_STATE_NAME`이 제공된 경우 `TF_STATE_NAME` 값이 GitLab 관리 Terraform State 이름으로 사용됩니다.
`TF_ADDRESS`	`$TF_STATE_NAME`의 Terraform State API URL	`TF_HTTP_ADDRESS`의 기본값으로 사용됩니다. 기본적으로 `TF_STATE_NAME`은 GitLab 관리 Terraform State 이름으로 사용됩니다.
`TF_USERNAME`	`$GITLAB_USER_LOGIN` 또는 `$TF_PASSWORD`가 설정되지 않은 경우 `gitlab-ci-token`	`TF_HTTP_USERNAME`의 기본값으로 사용됩니다.
`TF_PASSWORD`	`$CI_JOB_TOKEN`	`TF_HTTP_PASSWORD`의 기본값으로 사용됩니다.
`TF_HTTP_ADDRESS`	`$TF_ADDRESS`	Terraform 백엔드의 주소.
`TF_HTTP_LOCK_ADDRESS`	`$TF_ADDRESS/lock`	Terraform 백엔드 lock 엔드포인트의 주소.
`TF_HTTP_LOCK_METHOD`	`POST`	Terraform 백엔드 lock 엔드포인트에서 사용할 메서드.
`TF_HTTP_UNLOCK_ADDRESS`	`$TF_ADDRESS/lock`	Terraform 백엔드 unlock 엔드포인트의 주소.
`TF_HTTP_UNLOCK_METHOD`	`DELETE`	Terraform 백엔드 unlock 엔드포인트에서 사용할 메서드.
`TF_HTTP_USERNAME`	`$TF_USERNAME`	Terraform 백엔드 인증에 사용할 사용자 이름.
`TF_HTTP_PASSWORD`	`$TF_PASSWORD`	Terraform 백엔드 인증에 사용할 비밀번호.
`TF_HTTP_RETRY_WAIT_MIN`	`5`	Terraform 백엔드로의 HTTP 요청 시도 간격의 최소 시간(초).

명령 변수

gitlab-terraform를 실행할 때 이러한 변수가 구성됩니다.

변수	기본값	설명
`TF_IMPLICIT_INIT`	`true`	`true`이면 래핑된 명령 실행 전에 암시적 `terraform init`이 실행됩니다.
`TF_INIT_NO_RECONFIGURE`	`false`	`true`이면 암시적 `terraform init`이 `-reconfigure` 없이 실행됩니다.
`TF_INIT_FLAGS`	설정되지 않음	추가 `terraform init` 플래그.

Terraform 입력 변수

gitlab-terraform를 실행할 때 이러한 Terraform 입력 변수가 자동으로 설정됩니다. 기본값에 대한 자세한 정보는 Predefined variables를 참조하세요.

변수	기본값
`TF_VAR_CI_JOB_ID`	`$CI_JOB_ID`
`TF_VAR_CI_COMMIT_SHA`	`$CI_COMMIT_SHA`
`TF_VAR_CI_JOB_STAGE`	`$CI_JOB_STAGE`
`TF_VAR_CI_PROJECT_ID`	`$CI_PROJECT_ID`
`TF_VAR_CI_PROJECT_NAME`	`$CI_PROJECT_NAME`
`TF_VAR_CI_PROJECT_NAMESPACE`	`$CI_PROJECT_NAMESPACE`
`TF_VAR_CI_PROJECT_PATH`	`$CI_PROJECT_PATH`
`TF_VAR_CI_PROJECT_URL`	`$CI_PROJECT_URL`

Terraform 이미지

gitlab-terraform 도우미 스크립트와 terraform 자체는 컨테이너 이미지에서 제공됩니다 registry.gitlab.com/gitlab-org/terraform-images/. 이러한 이미지를 사용하여 통합을 구성하고 관리할 수 있습니다.

다음 이미지가 제공됩니다:

이미지 이름	태그	설명
`stable`	`latest`	최신 `terraform-images` 릴리스가 최신 Terraform 릴리스와 함께 번들로 제공됩니다.
`releases/$TERRAFORM_VERSION`	`latest`	특정 Terraform 릴리스와 번들로 제공되는 최신 `terraform-images` 릴리스.
`releases/$TERRAFORM_VERSION`	`$TERRAFORM_IMAGES_VERSION`	특정 Terraform 릴리스와 번들로 제공되는 특정 `terraform-images` 릴리스.

지원되는 조합에 대해서는 the terraform-images container registry를 참조하세요.

GitLab Terraform 도우미

`gitlab-terraform`

도우미 스크립트의 소스(실행하지 않음)

명령어

일반 변수

GitLab 관리 Terraform 상태 변수

명령 변수

Terraform 입력 변수

Terraform 이미지

관련 주제

도움말

기능 사용 가능성과 제품 평가판

도움받기