콘솔을 사용하여 Tekton에 대한 Delivery Pipeline 구성

1. 툴체인의 ‘개요’ 페이지에서 ‘배포 파이프라인 ’ 카드의 Delivery Pipeline 를 클릭하여 Tekton Delivery Pipeline 개요 페이지를 엽니다.

2. 설정 을 클릭하십시오. 정의 섹션에서 다음 태스크를 완료하십시오.

   a. Tekton 파이프라인 정의 및 관련 아티팩트를 포함하는 Git 저장소 및 URL을 지정하십시오. 저장소를 사용할 수 없으면 도구 체인 개요 페이지로 돌아와 저장소를 추가하십시오.

   b. 사용하려는 Git 저장소 내의 분기를 선택하거나 태그를 입력하십시오.

   c. Git 저장소 내에서 파이프라인 정의 경로를 지정하십시오. 동일한 저장소 내에서 특정 정의를 참조할 수 있습니다. 도구 체인에 통합되어 있는 경우 여러 정의 저장소도 추가할 수 있습니다.

   d. 변경사항을 저장하십시오.

   파이프라인 정의가 자동으로 업데이트됩니다.

   계산된 파이프라인 정의 크기 한계는 1MB입니다. 파이프라인을 저장하거나 실행할 때 오류가 발생하면 파이프라인 정의의 크기를 줄이거나 다중 파이프라인으로 분할해야 합니다.

3. 작업자 탭에서는 Tekton 파이프라인을 실행할 때 사용하려는 IBM 관리 공유 작업자 또는 개인용 작업자를 선택하십시오. 개인용 작업자에 대한 자세한 정보는 Delivery Pipeline Private Worker에 대한 작업을 참조하십시오.

   개인용 작업자는 Tekton 파이프라인과 동일한 도구 체인에서 정의되어야 합니다.

4. 환경 특성 섹션에서 추가를 클릭하고 특성 유형을 선택하여 사용자 고유의 환경 특성을 정의하십시오. 예를 들어 IBM Cloud 리소스에 액세스하기 위해 파이프라인에 있는 모든 스크립트에서 사용하는 API 키를 전달하는 API_KEY 특성을 정의할 수 있습니다. 다음 유형의 특성을 추가할 수 있습니다.

   • 열거: 사용자 정의 옵션 목록에서 선택할 수 있는 값이 있는 특성 키입니다.
   • 보안 값: AES-128 암호화를 통해 보호되는 단일 행 값이 있는 특성 키입니다. 이 값은 별표 문자를 사용하여 표시됩니다. 또는 도구 체인에서 이러한 도구를 사용할 수 있는 경우, 키 아이콘을 클릭하여 저장소 통합에서 시크릿(예: IBM Key Protect)을 선택할 수 있습니다.
   • 텍스트 값: 단일 행 또는 여러 행일 수 있는 텍스트 값이 있는 특성 키입니다. 이전에는 별도의 텍스트 영역 특성 유형에서 다중 행 값을 지원했습니다.
   • 도구 통합: 도구 체인 도구 통합에서 런타임에 분석되는 값이 있는 특성 키입니다. 기본적으로 이 값은 도구 통합의 JSON 문자열 표시입니다. 선택적 JSON 필터에 대한 값을 제공하여 특정 필드 또는 오브젝트의 서브세트를 검색할 수 있습니다. 예를 들어 GitHub 통합이 선택되고 JSON 필터 parameters.repo_url이 지정된 경우 이 값은 PipelineRun 리소스가 실행될 때 도구 통합에 구성된 Git 저장소의 URL을 반영합니다.

   Tekton 파이프라인 리소스에서 이러한 특성에 액세스할 수 있습니다. 이 특성에 대한 자세한 정보는 Tekton 파이프라인 환경 및 리소스를 참조하십시오.

   대체되지 않도록 특성을 잠글 수 있습니다. 런타임 시 잠긴 특성을 대체하려고 시도하면 실행 요청이 거부됩니다. 잠긴 특성은 기본적으로 실행 사이드 패널에 표시되지 않지만 '모든 특성 표시' 옵션을 사용하여 읽기 전용으로 표시할 수 있습니다.

5. 저장 을 클릭하십시오.

6. '파이프라인 개요' 페이지에서 [추가]를 클릭하여 트리거를 생성하고, 추가할 트리거 유형을 선택한 다음, 해당 트리거를 이벤트 리스너에 연결합니다. 사용 가능한 이벤트 리스너 목록에는 파이프라인 코드 저장소에 정의된 리스너가 포함되어 있습니다.

   트리거는 Tekton 트리거 정의를 기반으로 합니다. Git 리포 트리거는 자신에게 매핑된 이벤트 리스너를 사용하여 수신되는 이벤트 페이로드에서 정보를 추출하고 Kubernetes 리소스를 생성합니다. 이러한 리소스는 Tekton PipelineRun 리소스에 적용됩니다.

   트리거된 파이프라인 실행은 Limit concurrent runs 옵션을 사용하여 실행을 직렬화하도록 구성하지 않는 한 동시에 실행됩니다. 이 옵션이 사용 가능하면 이 트리거로 시작할 수 있는 동시 실행 수를 제한할 수 있습니다. 예를 들어, 최대 한도가 1로 설정된 경우, 이 트리거에 대한 파이프라인 실행은 한 번에 하나만 수행되며, 그 외의 실행은 “대기 중” 상태로 대기열에 들어갑니다. 최대 20개의 실행( IBM 관리형 워커를 사용하는 경우 5개)이 대기 상태로 큐에 쌓인 후, 이후 요청은 자동으로 취소됩니다. IBM 관리형 워커를 사용할 경우, 기본적으로 모든 시간 기반 트리거는 동시에 하나만 실행될 수 있습니다.

   트리거가 동시 실행 한도를 초과하면 용량을 사용할 수 있을 때까지 새 파이프라인 실행이 '대기' 상태로 전환됩니다. 원하는 경우 이 동작을 수정하여 가장 최근 실행만 '대기 중' 상태가 되고 다른 실행은 자동으로 취소되도록 할 수 있습니다. 예를 들어, 짧은 시간 내에 여러 번 실행이 트리거될 때 가장 최근 커밋만 빌드하려는 경우 Git 트리거에 유용할 수 있습니다. 이 기능을 활성화하려면 트리거 구성 패널에서 '대기 실행 1회로 제한' 토글을 사용할 수 있으며, limit_waiting_runs 속성을 사용하여 API를 통해서도 설정할 수 있습니다 (API 문서 참조). 이 설정은 '대기 중' 상태의 실행에만 적용되며 활성 실행에는 영향을 미치지 않습니다.

   수동 트리거는 실행 파이프라인 단추를 클릭하고 트리거를 선택하면 실행됩니다.

   Git 저장소 트리거는 지정된 Git 저장소 및 분기에 대해 지정된 Git 이벤트 유형이 발생하면 실행됩니다.

   Tekton 파이프라인 리소스에서 Git 트리거로 전달되는 웹훅 페이로드에 액세스할 수 있습니다. 정확한 필드가 저장소에 특정한 경우 웹훅 페이로드에 대한 일반 구문은 $(event.payloadFieldName)입니다. 웹훅을 작성하려면 우선 대응되는 Git 통합에 대해 Git Admin 액세스 권한을 부여해야 합니다. Git Admin 액세스 권한을 부여하려면 다시 Git 통합을 구성 및 저장하십시오.

   시간 기반 트리거는 CRON 값으로 정의된 예약된 시간에 실행됩니다. 시간 기반 트리거에 사용되는 CRON 표현식은 UNIX crontab 구문을 기반으로 하며, 다음 다섯 가지 시간 및 날짜 필드로 구성됩니다: minute, hour, day of the month, month, day of the week. 이러한 필드는 X X X X X 형식으로 공백으로 구분됩니다. 타이밍 트리거의 최대 빈도는 5분마다 한 번입니다. 다음 예는 다양한 시간 빈도를 사용하는 문자열을 보여줍니다.

   • */5 * * * * - 트리거가 5분마다 실행됩니다.
   • 0 * * * * - 트리거가 매시간 시작 시 실행됩니다.
   • 0 9 * 1 MON-FRI - 트리거가 1월의 평일 오전 9시마다 실행됩니다.
   • 0 * * NOV,DEC 1 - 트리거가 11월, 12월 중 월요일 매시간에 실행됩니다.

일반 웹훅 트리거는 시크릿 설정으로 구성된 POST 요청이 일반 웹훅 URL로 이동할 때 실행됩니다. 일반 웹훅 트리거는 POST 요청에 대한 고유한 웹훅 URL을 제공합니다.

PipelineRun UI가 이벤트 페이로드 섹션에서 일반 웹훅 페이로드 값을 숨기지 않으므로 페이로드에 민감한 데이터를 포함하지 마십시오. 그 대신에 비밀번호 또는 API 키 시크릿 등의 트리거 특성을 사용하여 일반 웹훅에서 요구하는 데이터를 보호하십시오.

다음 방법 중 하나를 사용하여 Git, Slack 발신 웹훅, Artifactory 웹훅 등에서 사용할 수 있도록 일반 웹훅 트리거를 보호할 수 있습니다.

• 저장된 토큰과 POST 요청 내에서 전달되는 토큰을 비교하는 토큰 일치. 지원되는 토큰 소스는 헤더, 조회 또는 페이로드입니다. 토큰 일치는 GitLab 웹훅 및 Slack 발신 웹훅에서 사용됩니다.
• 저장된 토큰이 있는 HMAC 16진 다이제스트를 사용하여 다이제스트된 페이로드에서 생성되는 시그니처와 해시를 비교하는 페이로드 일치. 지원되는 시그니처 소스는 헤더, 조회 또는 페이로그입니다. 사용자가 다이제스트 알고리즘을 지정해야 합니다. 페이로드 다이제스트 일치는 GitHub 웹훅에서 사용됩니다.
• Tekton 태스크 유효성 검증을 수행하려면 사용자가 해당 Tekton 태스크 내에서 웹훅 요청을 유효성 검증해야 합니다.

GitHub 웹훅과 함께 일반 웹훅 트리거를 사용하려면 다음 값을 지정하십시오.

• 보안: Payload Digest Matches
• 시그니처 소스: Header
• 헤더 키 이름: X-Hub-Signature
• 다이제스트 알고리즘: sha1.

GitLab 웹훅과 함께 일반 웹훅 트리거를 사용하려면 다음 값을 지정하십시오.

• 보안: Token Matches
• 토큰 소스: Header
• 헤더 키 이름: X-Gitlab-Token

Slack 웹훅과 함께 일반 웹훅 트리거를 사용하려면 다음 값을 지정하십시오.

• 보안: Token Matches
• 토큰 소스: Payload
• JSON 특성 이름/양식 키: token

다음 예는 Token Matches 규칙으로 보안 설정된 일반 웹훅에 curl 명령을 사용하는 방법을 보여줍니다.

  ![일반 웹훅](images/pipeline_tekton_generic_webhook.png){: caption="웹훅 " caption-side="bottom"}

curl -X POST \
https://devops-api.us-south.devops.cloud.ibm.com/v1/tekton-webhook/588236be-749b-4c67-ae57-a561abbbc9a8/run/7e82880e-4223-4c98-8ca9-ef6df36bb6dc \
-H 'Content-Type: application/json' \
-H 'token: 48a0f92c0932890048596906a22ae189c48c5619fbcf9600' \
-d '{
"somekey": "somevalue"
}'

파이프라인 정의에서 페이로드 값을 얻으려면 이벤트에서 파생된 값으로 Triggerbinding 매개변수를 지정하십시오.

apiVersion: tekton.dev/v1beta1
kind: TriggerBinding
metadata:
name: binding
spec:
params:
- name: somekey
value: $(event.somekey)

변경사항을 저장하십시오.

또한 일반 웹훅 트리거는 웹훅 요청 본문에서 프로퍼티 전달을 지원합니다. 이를 통해 웹훅에 의해 트리거되는 PipelineRun 에 대한 프로퍼티를 재정의하거나 PipelineRun 에 사용된 파이프라인/트리거 프로퍼티를 보완하는 추가 프로퍼티를 전달할 수 있습니다.

페이로드 프로퍼티에 비밀번호나 API 키 비밀 번호와 같은 민감한 데이터를 전달해야 하는 경우, 해당 프로퍼티에 속성 유형 SECURE 을 사용하여 UI에서 일반 텍스트로 표시되지 않도록 해야 합니다.

또한, 트리거되는 PipelineRun 을 설명하고 브라우저에서 PipelineRun 세부 정보를 볼 때 UI에 표시되는 선택적 설명을 요청 본문으로 전달할 수 있습니다.

다음 예는 텍스트 속성, 보안 속성 및 설명을 전달하면서 일반 웹훅과 함께 curl 명령을 사용하는 방법을 보여 줍니다:

curl -X POST \
https://devops-api.us-south.devops.cloud.ibm.com/v1/tekton-webhook/588236be-749b-4c67-ae57-a561abbbc9a8/run/7e82880e-4223-4c98-8ca9-ef6df36bb6dc \
-H 'Content-Type: application/json' \
-H 'token: 48a0f92c0932890048596906a22ae189c48c5619fbcf9600' \
-d '{
  "description":"This text can be used to describe the PipelineRun that will be triggered by this request.",
  "properties":[
    {"name":"mytextprop","type":"TEXT","value":"my text value"},
    {"name":"mysecureprop","type":"SECURE","value":"mysecret"}
  ]
}'

Tekton 파이프라인에 대한 Delivery Pipeline 트리거 구성하기

Git 리포지토리의 다양한 이벤트에 따라 Tekton 파이프라인의 트리거를 구성할 수 있습니다. 다음 옵션을 사용하여 Git 트리거를 필터링합니다:

• 브랜치: 브랜치: 지정된 이벤트가 발생하면 선택한 리포지토리의 특정 브랜치에 대한 파이프라인을 트리거합니다.
• 패턴: 지정된 이벤트가 발생하면 선택한 리포지토리의 태그 및 브랜치 이름에 대한 글로브 일치를 기반으로 파이프라인을 트리거합니다.
• CEL 필터: 이벤트가 제공된 일반 표현식 언어(CEL) 필터와 일치할 때 파이프라인을 트리거합니다.

분기 및 패턴 옵션을 사용하여 ' commit push, ' pull request opened' , ' updated' 또는 ' closed' 와 같은 이벤트를 지정합니다. 또한 초안 풀리퀘스트 이벤트 포함 옵션을 전환하여 초안 풀리퀘스트에 대한 파이프라인 트리거를 허용하거나 건너뛰는 방식으로 풀리퀘스트 이벤트를 지정할 수 있습니다. 마찬가지로, 포크된 리포지토리에서 풀 리퀘스트 이벤트 포함 토글을 사용하여 포크된 리포지토리에서 풀 리퀘스트에 대한 파이프라인 트리거를 허용할지 여부를 지정할 수 있습니다. 또한 라벨 필터 옵션을 선택하여 필터 테이블의 사용자 정의 기준에 따라 풀 리퀘스트 라벨을 기반으로 필터링을 활성화할 수 있습니다.

CEL 필터 옵션은 이벤트 페이로드의 다른 필드와 일치하는 것과 같은 고급 사용 사례를 지원합니다. 이 옵션은 푸시 이벤트, 모든 풀 리퀘스트 이벤트, 이슈 이벤트, 이슈 댓글 이벤트, 릴리스 이벤트 및 GitHub 병합 대기열 이벤트를 지원합니다. 이 옵션은 일반 웹훅 트리거의 선택적 기능으로도 사용할 수 있으며 웹훅 페이로드를 기반으로 이벤트 필터링을 제공합니다.

   header['x-github-event'] == 'pull_request' &&
      (body.action == 'opened' || body.action == 'synchronize') &&
      body.pull_request.base.ref == 'main'

   header['x-github-event'] == 'push' && body.ref == 'refs/heads/main'

   header['x-github-event'] == 'push' &&
      body.ref == 'refs/heads/main' &&
      !body.head_commit.message.contains("skip run")

   header['x-github-event'] == 'issue_comment' &&
      body.action == 'created' && has(body.issue.pull_request) &&
      body.comment.body.contains('/lgtm')

   header['x-github-event'] == 'issues' &&
      body.action == 'opened' &&
      body.issue.labels.exists(label, label.name == 'urgent')

   header['x-gitlab-event'] == 'Merge Request Hook' &&
      (body.object_attributes.action == 'open' || body.object_attributes.action == 'update') &&
      body.object_attributes.target_branch == 'main'

   header['x-gitlab-event'] == 'Push Hook' && body.ref == 'refs/heads/main'

   header['x-gitlab-event'] == 'Push Hook' &&
      body.ref == 'refs/heads/main' &&
      !body.object_attributes.last_commit.message("skip run")

   header['x-gitlab-event'] == 'Note Hook' &&
      body.object_attributes.noteable_type == 'MergeRequest' &&
      body.object_attributes.action == 'create' &&
      body.object_attributes.note.contains('/lgtm')

   header['x-gitlab-event'] == 'Issue Hook' &&
      (body.object_attributes.action == 'open') &&
      body.object_attributes.labels.exists(label, label.name == 'urgent')

   (header['x-event-key'] == 'pullrequest:created' || header['x-event-key'] == 'pullrequest:updated') &&
       body.pullrequest.destination.branch.name == 'main'

   header['x-event-key'] == 'repo:push' && body.push.changes[0].new.name == 'main'

   header['x-event-key'] == 'repo:push' &&
      body.push.changes[0].new.name == 'main' &&
      !body.push.changes[0].commits[0].message("skip run")

   header['x-event-key'] == 'pullrequest:comment_created' &&
      body.comment.content.raw.contains('/lgtm')

   header['x-event-key'] == 'issue:created' &&
      body.issue.kind == 'bug'

콘솔 UI를 사용하여 툴체인 삭제하기

1. IBM Cloud 콘솔에서 메뉴 아이콘 > 플랫폼 자동화 > 툴체인을 클릭합니다.
2. 도구 체인 페이지에서 도구 체인을 클릭하여 해당 개요 페이지를 여십시오. 또는 사용자 앱의 앱 세부사항 페이지에서 도구 체인 이름을 클릭하십시오.
3. '배달 파이프라인' 섹션에서 삭제하려는 파이프라인을 찾습니다.
4. 해당 파이프라인의 메뉴 아이콘을 클릭하고 삭제 옵션을 클릭합니다.
5. 대화 상자에서 ‘삭제’를 클릭하여 삭제를 확인하십시오.

API를 사용하여 Delivery Pipeline 삭제하기

1. IAM 베어러 토큰을 확보하십시오. 또는 SDK를 사용하는 경우 IAM API키를 얻고 환경 변수를 사용하여 클라이언트 옵션을 설정하십시오.

   export CD_TEKTON_PIPELINE_APIKEY={api_key}
   

2. DevOps Insights 도구 통합을 추가할 도구 체인의 영역 및 ID를 판별 하십시오.

3. 파이프라인을 삭제하십시오.

   curl -X DELETE \
     https://api.{region}.devops.cloud.ibm.com/toolchain/v2/toolchains/{toolchain_id}/tools/{pipeline_id} \
     -H 'Authorization: Bearer {iam_token}'
   

   const CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');
   ...
   (async () => {
      const pipelineSvc = CdTektonPipelineV2.newInstance();
      const params = {
         id: {pipeline_id},
      };
      const res = await pipelineSvc.deleteTektonPipeline(params);
   })();
   

   import {
      "github.com/IBM/continuous-delivery-go-sdk/cdtektonpipelinev2"
   }
   ...
   cdTektonPipelineOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}
   pipelineSvc, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineOptions)
   deleteTektonPipelineOptions := pipelineSvc.NewDeleteTektonPipelineOptions(
      {pipeline_id}
   )
   response, err := pipelineSvc.DeleteTektonPipeline(deleteTektonPipelineOptions)
   

   from ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2
   ...
   pipeline_service = CdTektonPipelineV2.new_instance()
   response = pipeline_service.delete_tekton_pipeline(
      id={pipeline_id}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.CdTektonPipeline;
   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.model.*;
   ...
   CdTektonPipeline pipelineSvc = CdTektonPipeline.newInstance();
   DeleteTektonPipelineOptions deleteTektonPipelineOptions = new DeleteTektonPipelineOptions.Builder()
      .id({pipeline_id})
      .build();
   Response<Void> response = pipelineSvc.deleteTektonPipeline(deleteTektonPipelineOptions).execute();
   

다음 표에서는 이전 단계에서 사용된 각 변수를 나열하고 설명합니다.

Terraform을 사용하여 Delivery Pipeline 삭제

1. 기존 파이프라인에 대한 resource 블록을 포함하는 Terraform 파일 (예: main.tf) 을 찾으십시오.

   다음 예제의 resource 에서는 기존 파이프라인을 설명합니다.

   data "ibm_resource_group" "group" {
     name = "default"
   }
   resource "ibm_cd_toolchain" "my_toolchain" {
     name              = "terraform_toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   resource "ibm_cd_toolchain_tool_pipeline" "my_pipeline_tool" {
     parameters {
        name = "terraform-pipeline-integration"
     }
     toolchain_id = ibm_cd_toolchain.my_toolchain.id
   }
   resource "ibm_cd_tekton_pipeline" "my_tekton_pipeline" {
    worker {
        id = "public"
    }
    pipeline_id = ibm_cd_toolchain_tool_pipeline.my_pipeline_tool.tool_id
   }
   

2. Terraform 파일에서 ibm_cd_toolchain_tool_pipeline 및 ibm_cd_tekton_pipeline resource 블록을 제거하십시오.

3. 필요한 경우 Terraform CLI를 초기화하십시오.

   terraform init
   

4. Terraform 실행 플랜을 작성하십시오. 이 계획은 파이프라인을 삭제하기 위해 실행해야 하는 모든 조치를 요약합니다.

   terraform plan
   

5. Terraform 실행 계획을 적용합니다. Terraform은 파이프라인을 삭제하는 데 필요한 모든 조치를 수행합니다.

   terraform apply
   

명령줄 또는 API를 통해 파이프라인 트리거하기

명령줄에서 IBM Cloud CLI를 사용하거나 curl 을 사용하여 직접 API를 호출하여 파이프라인을 트리거할 수 있습니다.