• gitlab_group_share_group 자원이 서브그룹 상태를 새로 고칠 때 검출되지 않음
  • 기본 템플릿 사용 시 잘못된 CI/CD 구문 오류
    • 오래된 버전의 템플릿 사용
• Terraform 상태 문제 해결
  • terraform apply에서 이전 작업에서 생성된 계획을 사용하여 CI 작업에서 Terraform 상태 파일을 잠글 수 없음
  • 오류: “address”: 필수 필드가 설정되지 않음
  • 상태 새로 고침 오류: HTTP 원격 상태 엔드포인트는 인증이 필요함
  • 파괴적인 명령에 대한 개발자 역할 액세스 활성화
  • 상태 이름에 마침표가 포함되어 있으면 상태를 찾을 수 없음

GitLab과의 Terraform 통합 문제 해결

Terraform과 GitLab을 연동하여 사용할 때 문제가 발생할 수 있으며 해결해야 합니다.

gitlab_group_share_group 자원이 서브그룹 상태를 새로 고칠 때 검출되지 않음

GitLab Terraform 공급자는 기존의 gitlab_group_share_group 자원을 감지하지 못할 수 있습니다. 이는 해당 문제로 인해 발생하는 것입니다. “사용 권한이 있는 사용자가 API에서share_with_groups를 검색할 수 없음”. 이로 인해 Terraform이 기존 자원을 재생성하려고 시도하여 terraform apply를 실행할 때 오류가 발생합니다.

예를 들어, 다음과 같은 그룹/서브그룹 구성을 고려해보십시오:

상위-그룹
├── 서브그룹-A
└── 서브그룹-B

여기서:

• 사용자 user-1은 상위-그룹, 서브그룹-A, 서브그룹-B를 생성합니다.
• 서브그룹-A는 서브그룹-B와 공유됩니다.
• terraform-user는상위-그룹의 멤버이며 상속 된 owner 액세스를 두 서브그룹에 부여받습니다.

Terraform 상태를 새로 고칠 때, 프로바이더가 발행한 GET /groups/:subgroup-A_id API 쿼리는 shared_with_groups 배열에서subgroup-B의 세부 정보를 반환하지 않습니다. 이로 인해 오류가 발생합니다.

이 문제를 해결하기 위해 다음 조건 중 하나를 적용하십시오:

1. terraform-user가 모든 서브그룹 자원을 생성합니다.
2. terraform-user에게 subgroup-B의 Maintainer 또는 Owner 역할을 부여합니다.
3. terraform-user가 subgroup-B에 상속 액세스를 받고 subgroup-B에 적어도 하나의 프로젝트가 포함되어 있는지 확인합니다.

기본 템플릿 사용 시 잘못된 CI/CD 구문 오류

Terraform 템플릿을 사용하는 동안 CI/CD 구문 오류가 발생할 수 있습니다:

• GitLab 14.2 이상에서 latest 템플릿을 사용하는 경우.
• GitLab 15.0 이상에서 템플릿의 어떤 버전을 사용하는 경우.

예를 들어:

include:
  # 14.2 버전 이상에서 다음을 사용하는 경우
  - template: Terraform/Base.latest.gitlab-ci.yml
  - template: Terraform.latest.gitlab-ci.yml
  # 15.0 버전 이상에서는 다음 템플릿도 업데이트되었습니다:
  - template: Terraform/Base.gitlab-ci.yml
  - template: Terraform.gitlab-ci.yml

my-terraform-job:
  extends: .apply

이 오류의 원인으로는 세 가지가 있습니다:

• .init의 경우, 초기화 단계 및 작업이 더 이상 필요하지 않으므로 템플릿에서 제거되었기 때문에 오류가 발생합니다. 구문 오류를 해결하려면.init를 확장하는 모든 작업을 안전하게 제거할 수 있습니다.

• 다른 모든 작업의 경우, 베이스 작업이 이름이 변경되어 오류가 발생합니다. .apply가 .terraform:apply로 변했습니다. 이 오류를 해결하려면 베이스 작업 이름을 업데이트할 수 있습니다. 예를 들어:

    my-terraform-job:
  -   extends: .apply
  +   extends: .terraform:apply
  

• GitLab 15.0부터 템플릿은 rules 구문을 only/except 대신 사용합니다. .gitlab-ci.yml 파일의 구문에 둘 다 포함되지 않도록 확인하십시오.

오래된 버전의 템플릿 사용

주요 릴리스 중에는 호환성 문제가 발생할 수 있습니다. 호환성 문제가 발생하거나 이전 버전의 템플릿을 사용하려는 경우 .gitlab-ci.yml을 이전 버전으로 참조하도록 업데이트할 수 있습니다. 예:

include:
  remote: https://gitlab.com/gitlab-org/configure/template-archive/-/raw/main/14-10/Terraform.gitlab-ci.yml

사용 가능한 템플릿을 확인하려면 template-archive를 확인하십시오.

Terraform 상태 문제 해결

terraform apply에서 이전 작업에서 생성된 계획을 사용하여 CI 작업에서 Terraform 상태 파일을 잠글 수 없음

terraform init에 -backend-config=를 전달하면 Terraform은 이러한 값을 계획 캐시 파일 내에 유지합니다. 이는 password 값을 포함합니다.

따라서 계획을 생성하고 나중에 동일한 계획을 다른 CI 작업에서 사용할 때 -backend-config=password=$CI_JOB_TOKEN를 사용하여Error: Error acquiring the state lock 오류가 발생할 수 있습니다. 이는 $CI_JOB_TOKEN 값이 현재 작업의 지속 시간 동안만 유효하기 때문입니다.

이 문제를 해결하기 위해 CI 작업에서 http backend 구성 변수를 사용하십시오. 이는 GitLab CI를 사용하여 Terraform 상태를 초기화하는 방법을 따를 때 내부적으로 발생하는 일입니다.

오류: “address”: 필수 필드가 설정되지 않음

기본적으로 TF_ADDRESS를 ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/terraform/state/${TF_STATE_NAME}로 설정합니다. 작업에서 TF_STATE_NAME 또는 TF_ADDRESS를 설정하지 않으면 작업이Error: "address": required field is not set 오류 메시지와 함께 실패합니다.

이를 해결하려면, 해당 오류를 반환한 작업에서TF_ADDRESS 또는 TF_STATE_NAME 중 하나가 접근 가능하도록 다음 단계를 수행하십시오:

1. 작업에 대해 CI/CD 환경 범위를 구성합니다.
2. 이전 단계에서 설정한 환경과 일치하도록 작업의 환경을 설정합니다.

상태 새로 고침 오류: HTTP 원격 상태 엔드포인트는 인증이 필요함

이를 해결하기 위해 사용하는 액세스 토큰에 api 범위가 있는지 확인하십시오. TF_HTTP_PASSWORD CI/CD 변수를 설정한 경우 작업이 명시적으로 사용하지 않는 경우 해당 변수를 제거하거나TF_PASSWORD와 동일한 값을 설정하십시오.

파괴적인 명령에 대한 개발자 역할 액세스 활성화

개발자 역할을 하는 사용자가 파괴적인 명령을 실행할 수 있도록 하려면, 해결책이 필요합니다:

1. api 범위로 프로젝트 액세스 토큰을 만듭니다.
2. CI/CD 변수에 TF_USERNAME 및 TF_PASSWORD를 추가합니다:
   1. TF_USERNAME의 값을 프로젝트 액세스 토큰의 사용자 이름으로 설정합니다.
   2. TF_PASSWORD의 값을 프로젝트 액세스 토큰의 암호로 설정합니다.
   3. 선택 사항입니다. 변수를 보호하여 보호된 브랜치 또는 보호된 태그에서 실행되는 파이프라인에서만 사용할 수 있도록 합니다.

상태 이름에 마침표가 포함되어 있으면 상태를 찾을 수 없음

GitLab 15.6 버전 및 이전 버전에서는 상태 이름에 마침표가 포함되어 있고 Terraform이 상태 잠금을 시도하면 404 오류가 발생했습니다.

이 제한을 해결하기 위해 Terraform 명령에 -lock=false를 추가하여 이 문제를 해결할 수 있었습니다. GitLab 백엔드는 요청을 수락하지만 내부적으로 상태 이름에서 마침표와 그 뒤에 오는 문자를 제거했습니다. 예를 들어 foo.bar라는 상태 이름은 foo로 저장되었습니다. 그러나 이와 같은 해결책은 권장되지 않았으며 상태 이름 충돌을 일으킬 수도 있었습니다.

GitLab 15.7 버전부터는 마침표가 있는 상태 이름을 지원합니다. -lock=false 해결책을 사용하고 GitLab 15.7 버전 이상으로 업그레이드하는 경우 작업이 실패할 수 있습니다. 실패의 원인은 GitLab 백엔드가 기존 상태 이름과 다른 전체 상태 이름의 새로운 상태를 저장하기 때문입니다.

작업이 실패하는 경우 상태 이름을 마침표와 그 뒤에 오는 문자를 제외하도록 변경하세요. 예를 들어, 다음과 같은 Terraform 템플릿을 사용하는 경우:

include:
  - template: Terraform.gitlab-ci.yml

variables:
  TF_STATE_NAME: foo

TF_HTTP_ADDRESS, TF_HTTP_LOCK_ADDRESS 및 TF_HTTP_UNLOCK_ADDRESS가 설정되어 있는 경우 상태 이름을 업데이트해야 합니다.

또는 Terraform 상태를 이동할 수도 있습니다.