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

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

특정 브랜치 또는 태그를 위해 파이프라인을 트리거하려면 API 호출을 사용할 수 있습니다. pipeline triggers API endpoint를 통해 사용할 수 있습니다.

만약 GitLab CI/CD로 이주 중이라면, 다른 제공업체에서의 작업을 호출할 때 GitLab CI/CD 파이프라인을 트리거할 수 있습니다. 예를 들어 Jenkins나 CircleCI에서의 이주 과정 중입니다.

API 인증 시, 다음을 사용할 수 있습니다:

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

파이프라인 트리거 토큰을 생성하고, 이를 사용하여 브랜치나 태그의 파이프라인을 트리거할 수 있습니다. 이 토큰은 사용자 프로젝트 액세스와 권한을 표현합니다.

전제 조건:

  • 프로젝트의 유지자(Maintainer) 역할을 최소한으로 가질 필요가 있습니다.

토큰을 생성하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > CI/CD를 선택합니다.
  3. 파이프라인 트리거 토큰을 확장합니다.
  4. 새 토큰 추가를 선택합니다.
  5. 설명을 입력하고 파이프라인 트리거 토큰 생성을 선택합니다.
    • 생성한 모든 트리거에 대한 전체 토큰을 볼 수 있고 복사할 수 있습니다.
    • 다른 프로젝트 구성원이 만든 토큰에 대해서는 처음 4자만 볼 수 있습니다.

경고: 평문으로 토큰을 공개 프로젝트에 저장하거나, 악의적 사용자가 액세스할 수 있도록 저장하는 것은 보안 위험이 될 수 있습니다. 유출된 트리거 토큰은 예정되지 않은 배포를 강요하거나, CI/CD 변수에 액세스를 시도하는 등, 악용될 수 있습니다. Masked CI/CD 변수를 사용하여 토큰의 보안을 강화할 수 있습니다. 토큰은 안전하게 보관하는 데 대한 자세한 정보는 보안 고려 사항을 참조하세요.

파이프라인 트리거

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

cURL 사용

파이프라인 triggers API endpoint를 사용하여 파이프라인을 트리거하는 데 cURL을 사용할 수 있습니다. 예를 들어:

  • 여러 줄로 된 cURL 명령어 사용: 

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

  • cURL을 사용하여 쿼리 문자열에서 <token>과 <ref_name>을 전달: 

    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과 같은 브랜치 또는 태그 이름으로 대체합니다.
  • <project_id>는 123456과 같은 프로젝트 ID로 대체합니다. 프로젝트 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

이 예에서:

  • 1234는 project-B의 프로젝트 ID입니다. 프로젝트 ID는 프로젝트 개요 페이지에 표시됩니다.
  • rules은 project-A에 태그가 추가될 때마다 작업을 실행할 수 있도록 합니다.
  • MY_TRIGGER_TOKEN은 트리거 토큰을 담은 Masked CI/CD 변수입니다.

웹훅 사용

다른 프로젝트의 웹훅에서 파이프라인을 트리거하려면, 회전하거나 태그 이벤트에 대한 다음과 같은 웹훅 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_name을 우선하며, 페이로드의 ref는 소스 저장소에서 트리거된 브랜치입니다. 슬래시가 포함된 경우 ref_name을 URL 인코딩해야 합니다.
  • <token>은 파이프라인 트리거 토큰으로 대체하세요.

웹훅 페이로드 액세스

웹훅을 사용하여 파이프라인을 트리거하면, TRIGGER_PAYLOAD 사전 정의 CI/CD 변수를 통해 웹훅 페이로드에 액세스할 수 있습니다. 페이로드는 file-type 변수로 노출되므로 cat $TRIGGER_PAYLOAD나 유사한 명령어로 데이터에 액세스할 수 있습니다.

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

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

파라미터는 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/CD 구성 파일에서 trigger 키워드를 사용합니다.

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

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

작업을 실행시킨 파이프라인 트리거 토큰은 해당 작업 페이지에서 확인할 수 있습니다. 페이지 오른쪽 하단에 일부 트리거 토큰이 작업 세부 정보 아래에 표시됩니다:

단일 작업 페이지에서 트리거로 표시됨

트리거 토큰으로 트리거된 파이프라인에서 작업은 빌드 > 작업에서 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을 검토하십시오.