API를 사용하여 파이프라인 트리거하기

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

특정 브랜치 또는 태그의 파이프라인을 트리거하려면 API 호출을 사용하여 파이프라인 트리거 API 엔드포인트를 호출할 수 있습니다.

GitLab CI/CD로 마이그레이션 중이라면, API 엔드포인트를 호출하여 다른 제공업체의 작업에서 GitLab CI/CD 파이프라인을 트리거할 수 있습니다. 예를 들어, Jenkins 또는 CircleCI에서의 마이그레이션 중인 경우입니다.

API와의 인증 중에 사용할 수 있는 것은 다음과 같습니다:

파이프라인 트리거 토큰 생성

파이프라인 트리거 토큰을 생성하고 해당 토큰을 사용하여 API 호출을 인증하여 브랜치 또는 태그에 대한 파이프라인을 트리거할 수 있습니다. 이 토큰은 사용자의 프로젝트 액세스 및 권한을 표현합니다.

전제 조건:

  • 프로젝트의 유지보수자(Maintainer) 역할을 최소한으로 할당받아야 합니다.

트리거 토큰을 생성하려면:

  1. 왼쪽 사이드바에서 찾아보기 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > CI/CD를 선택합니다.
  3. 파이프라인 트리거 토큰을 확장합니다.
  4. 새 토큰 추가를 선택합니다.
  5. 설명을 입력한 후 파이프라인 트리거 토큰 생성을 선택합니다.
    • 생성된 모든 트리거의 전체 토큰을 확인하고 복사할 수 있습니다.
    • 다른 프로젝트 구성원에 의해 생성된 토큰에 대해서는 처음 4자만 볼 수 있습니다.
caution
공개 프로젝트에서 평문으로 토큰을 저장하거나, 악의적 사용자가 액세스할 수 있는 방식으로 저장하는 것은 보안 리스크입니다. 유출된 트리거 토큰은 예정되지 않은 배포를 강제하거나, CI/CD 변수에 액세스를 시도하거나 다른 사악한 용도에 사용될 수 있습니다. 마스킹된 CI/CD 변수는 트리거 토큰의 보안성을 향상시킵니다. 토큰을 안전하게 보관하는 데 대한 자세한 내용은 보안 고려 사항을 참조하십시오.

파이프라인 트리거

파이프라인 트리거 토큰을 생성하고나중에는 API에 액세스할 수 있는 도구나 웹훅을 사용하여 파이프라인을 트리거할 수 있습니다.

cURL 사용

cURL을 사용하여 파이프라인 트리거 API 엔드포인트로 파이프라인을 트리거할 수 있습니다.

예를 들어 다음과 같이 멀티라인 cURL 명령을 사용할 수 있습니다: 

curl --request POST \
     --form token=<token> \
     --form ref=<ref_name> \
     "https://gitlab.example.com/api/v4/projects/<project_id>/trigger/pipeline"

또는 쿼리 문자열에 <token>과 <ref_name>을 전달하고 cURL을 사용할 수 있습니다. 

curl --request POST \
     "https://gitlab.example.com/api/v4/projects/<project_id>/trigger/pipeline?token=<token>&ref=<ref_name>"

각 예제에서 다음을 대체하십시오:

  • URL을 https://gitlab.com 또는 해당 인스턴스의 URL로 바꿉니다.
  • <token>을 사용자의 트리거 토큰으로 바꿉니다.
  • <ref_name>을 main과 같은 브랜치 또는 태그 이름으로 바꿉니다. 프로젝트 ID를 123456과 같이 표시합니다. 프로젝트 ID는 프로젝트 개요 페이지에서 표시됩니다.

CI/CD 작업 사용

다른 파이프라인이 실행될 때 파이프라인을 트리거하기 위해 파이프라인 트리거 토큰으로 CI/CD 작업을 사용할 수 있습니다.

예를 들어, project-A에서 태그가 생성될 때 project-B의 main 브랜치에 대한 파이프라인을 트리거하려면, 다음과 같이 project-A의 .gitlab-ci.yml 파일에 다음 작업을 추가하십시오: 

trigger_pipeline:
  stage: deploy
  script:
    - 'curl --fail --request POST --form token=$MY_TRIGGER_TOKEN --form ref=main "https://gitlab.example.com/api/v4/projects/123456/trigger/pipeline"'
  rules:
    - if: $CI_COMMIT_TAG
  environment: production

이 예에서는 다음을 사용합니다:

웹훅 사용

다른 프로젝트의 웹훅에서 파이프라인을 트리거하려면, 푸시 및 태그 이벤트에 대한 다음과 같은 웹훅 URL을 사용하십시오: 

https://gitlab.example.com/api/v4/projects/<project_id>/ref/<ref_name>/trigger/pipeline?token=<token>

다음을 대체하십시오:

  • URL을 https://gitlab.com 또는 해당 인스턴스의 URL로 바꿉니다.
  • <project_id>를 123456과 같은 프로젝트 ID로 바꿉니다. 프로젝트 ID는 프로젝트 개요 페이지에서 표시됩니다.
  • <ref_name>을 main과 같은 브랜치 또는 태그 이름으로 바꿉니다. 이 값은 웹훅 페이로드의 ref와 일치합니다. 원본 리포지터리에서 트리거를 발생시킨 브랜치입니다. 슬래시가 포함된 경우 ref_name을 URL 인코딩해야 합니다.
  • <token>은 파이프라인 트리거 토큰입니다.

웹훅 페이로드 액세스

웹훅을 사용하여 파이프라인을 트리거하면 TRIGGER_PAYLOAD와 같은 사전 정의된 CI/CD 변수를 사용하여 웹훅 페이로드에 액세스할 수 있습니다. 페이로드는 파일 유형 변수로 노출되므로 cat $TRIGGER_PAYLOAD 또는 비슷한 명령어로 데이터에 액세스할 수 있습니다.

API 호출에서 CI/CD 변수 전달

트리거 API 호출에서 CI/CD 변수를 전달할 수 있습니다. 이러한 변수는 우선 순위가 가장 높습니다하며, 동일한 이름의 모든 변수를 무시합니다.

매개변수 형식은 variables[key]=value로, 예를 들어 다음과 같습니다: 

curl --request POST \
     --form token=TOKEN \
     --form ref=main \
     --form variables[UPLOAD_TO_S3]="true" \
     "https://gitlab.example.com/api/v4/projects/123456/trigger/pipeline"

트리거된 파이프라인의 CI/CD 변수는 각 작업 페이지에 표시되지만, 소유자 및 유지보수자 역할을 할당받은 사용자만 해당 값들을 확인할 수 있습니다.

UI에서 작업 변수

파이프라인 트리거 토큰 취소

파이프라인 트리거 토큰을 취소하려면:

  1. 왼쪽 사이드바에서 찾아보기 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > CI/CD를 선택합니다.
  3. 파이프라인 트리거를 확장합니다.
  4. 취소하려는 트리거 토큰 왼쪽에 있는 취소()를 선택합니다.

한 번 취소된 트리거 토큰은 다시 추가할 수 없습니다.

트리거된 파이플라인에서 CI/CD 작업 구성

트리거된 파이프라인에서 작업을 실행할 시기를 구성하려면 다음을 수행할 수 있습니다.

  • $CI_PIPELINE_SOURCE 사전 정의된 CI/CD 변수와 함께 rules를 사용합니다.
  • only/except 키워드를 사용하되, rules 키워드를 사용하는 것이 바람직합니다.
$CI_PIPELINE_SOURCE 값 only/except 키워드 트리거 방법
trigger triggers 파이프라인 트리거 API를 사용해 트리거된 파이프라인에서 트리거 토큰으로 트리거합니다.
pipeline pipelines 파이프라인 트리거 API를 사용해서 $CI_JOB_TOKEN 또는 CI/CD 구성 파일의 trigger 키워드를 사용합니다.

또한, $CI_PIPELINE_TRIGGERED 사전 정의 CI/CD 변수는 트리거된 파이프라인에서 true로 설정됩니다.

사용된 파이프라인 트리거 토큰 확인

작업을 실행한 파이프라인 트리거 토큰을 확인하려면 해당 작업 페이지를 방문하세요. 페이지 오른쪽에 트리거 토큰의 일부가 작업 세부정보 아래에 표시됩니다:

단일 작업 페이지에서 트리거된 것으로 표시

트리거 토큰을 사용하여 트리거된 파이프라인에서 작업은 Build > 작업에서 triggered로 표시됩니다.

문제 해결

웹훅으로 파이프라인을 트리거할 때 403 Forbidden 오류 발생

웹훅으로 파이프라인을 트리거하면 API에서 {"message":"403 Forbidden"}라는 응답을 반환할 수 있습니다. 트리거 루프를 피하려면 파이프라인 이벤트를 사용하여 파이프라인을 트리거하지 마세요.

파이프라인을 트리거할 때 404 Not Found 오류 발생

파이프라인을 트리거하려고 할 때 {"message":"404 Not Found"}라는 응답을 받는 경우, 해당 오류는 개인 액세스 토큰 대신 파이프라인 트리거 토큰을 사용했을 가능성이 있습니다. 새로운 트리거 토큰을 생성하고 이를 사용하세요.

파이프라인을 트리거할 때 The requested URL returned error: 400 오류 발생

존재하지 않는 브랜치 이름을 ref로 사용해 파이프라인을 트리거하려고 하면 GitLab이 The requested URL returned error: 400을 반환합니다.

예를 들어, 프로젝트에서 기본 브랜치에 대해 다른 브랜치 이름을 사용하는 경우, 실수로 main을 브랜치 이름으로 사용할 수 있습니다.

이 오류의 또 다른 가능한 원인은 CI_PIPELINE_SOURCE 값이 trigger일 때 파이프라인 생성을 방지하는 규칙입니다. 다음과 같은 경우입니다: 

rules:
  - if: $CI_PIPELINE_SOURCE == "trigger"
    when: never

CI_PIPELINE_SOURCE 값이 trigger일 때 파이프라인이 생성될 수 있도록 당신의 workflow:rules을 확인하세요.