GitLab Terraform 도우미
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을 실행할 수 있습니다.
| 명령어 | 명령줄 전달 | 암시적 init? | 설명 |
|---|---|---|---|
gitlab-terraform apply
| 예 | 예 |
terraform apply를 실행합니다.
|
gitlab-terraform destroy
| 예 | 예 |
terraform destroy를 실행합니다.
|
gitlab-terraform fmt
| 예 | 아니요 | 체크 모드에서 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
| 계획 캐시 파일의 위치입니다. TF_ROOT가 설정되지 않은 경우 해당 경로는 현재 작업 디렉터리($PWD)를 기준으로 결정됩니다.
|
TF_PLAN_JSON
|
$TF_ROOT/plan.json 또는 $PWD/plan.json
|
MR 통합을 위한 계획 JSON 파일의 위치입니다. TF_ROOT가 설정되지 않은 경우 해당 경로는 현재 작업 디렉터리($PWD)를 기준으로 결정됩니다.
|
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
| 테라폼 백엔드 잠금 엔드포인트의 주소 |
TF_HTTP_LOCK_METHOD
| POST
| 테라폼 백엔드 잠금 엔드포인트에 사용할 메소드 |
TF_HTTP_UNLOCK_ADDRESS
| $TF_ADDRESS/lock
| 테라폼 백엔드 잠금 해제 엔드포인트의 주소 |
TF_HTTP_UNLOCK_METHOD
| DELETE
| 테라폼 백엔드 잠금 해제 엔드포인트에 사용할 메소드 |
TF_HTTP_USERNAME
| $TF_USERNAME
| 테라폼 백엔드 인증을 위한 사용자 이름 |
TF_HTTP_PASSWORD
| $TF_PASSWORD
| 테라폼 백엔드 인증을 위한 암호 |
TF_HTTP_RETRY_WAIT_MIN
| 5
| 테라폼 백엔드에 대한 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를 참조하십시오.
도움말