설정 위치: .pipeline-config.yaml

.pipeline-config.yaml 구성 파일을 사용하여 파이프라인 동작을 확장하십시오.

파일 위치

풀 리퀘스트 및 지속적 통합 파이프라인의 경우, .pipeline-config.yaml 구성 파일을 .travis.yml`` 또는 Jenkinsfile 파일과 동일한 방식으로 앱 저장소에 저장하십시오. 지속적 배포 파이프라인의 경우, 이 파일을 전용 저장소에 저장하십시오.

모든 파이프라인의 경우 다음 파이프라인 UI 매개변수를 사용하여 .pipeline-config.yaml의 위치 및 소스를 사용자 정의할 수 있습니다.

• 구성 파일의 경로를 설정하려면 pipeline-config를 사용합니다. 기본값은 .pipeline-config.yaml입니다.
• pipeline-config-repo 구성 및 스크립트를 가져올 저장소를 설정하려면. 기본값은 지속 통합 앱 저장소입니다.
• pipeline-config-branch 구성 저장소의 구성에 대한 브랜치로 사용하기 위해. 기본값은 지속 통합(CI) 앱 저장소의 브랜치이며, 지속 배포(CD)의 경우 master 브랜치입니다.

구성 매개변수

.pipeline-config.yaml 파일의 구성은 다음 매개변수를 지원합니다.

이러한 설정은 파이프라인 매개변수가 아니며 .pipeline-config.yaml 파일의 일부여야 합니다.

• image: 태스크의 기본 이미지로 파이프라인 작업자에서 액세스 가능한 Docker 이미지를 사용할 수 있습니다.

• script: 스테이지에서 실행할 스크립트입니다. 이 필드는 스크립트 파일로 사용되므로, 제공한 기본 이미지에서 해당 내용이 스크립트 파일처럼 작동하는지 확인하십시오. 이 구성 파일 옆에 다른 스크립트를 포함하고 이 시작점에서 이 스크립트를 참조할 수 있습니다. 예를 들어, 다음과 같습니다.

test:
  image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.69
  script: |
    #!/bin/sh
    scripts/lint.sh
    scripts/unit-test.sh

• dind: 스크립트 컨텍스트에 docker-in-docker를 사용할지 여부를 지정합니다. 기본 설정은 false입니다.

• abort_on_failure: 기본적으로 스크립트가 실패하면 파이프라인이 중지됩니다. 이를 false 로 설정하면 단계가 경고 (황색 상태) 로 표시되고 (경고와 함께 전달됨) 파이프라인이 계속될 수 있으며 실패한 작업이 증거에서 참조됩니다.

• image_pull_policy: 기본 이미지에 대해 이미지에 제공된 ‘ ImagePullPolicy ’ 설정을 지정하십시오. 가능한 값은 Kubernetes의 유효한 값(Always 또는 IfNotPresent)과 동일합니다. 기본값은 IfNotPresent입니다.

• configmap: PipelineRun에서 액세스 가능한 제공된 configmap에서 키-값 쌍을 가져옵니다. 지원되는 값은 다음과 같습니다.

  • config-name: 직접 configmap 이름 구문입니다. 스테이지 실행기가 config-name이라는 configmap을 액세스하고 마운트하려고 합니다.
  • $prop-name: 간접적 configmap 이름 구문입니다. configmap 이름은 파이프라인 UI에 설정된 모든 환경 값을 포함하는 환경 특성 configmap에서 검색됩니다. 예를 들어, 환경 속성에 ‘ my-config ’라는 속성이 설정되어 있다면, ‘ $prop ’에 대해 ‘ my-config ’가 사용됩니다.

• secret: PipelineRun에서 액세스 가능한 제공된 configmap에서 키-값 쌍을 가져옵니다. 지원되는 값은 다음과 같습니다.

  • secret-name: 직접 시크릿 이름 구문입니다. 스테이지 실행기가 secret-name이라는 시크릿을 액세스하고 마운트하려고 합니다.

  • $prop-name: 간접 시크릿 이름 구문입니다. 'Secret' 이름은 파이프라인 UI에서 설정된 모든 환경 값을 포함하는 environment-properties 구성 맵에 있습니다. 예를 들어, 환경 특성 configmap에 my-secret 특성이 포함된 경우 my-secret이 $prop에 사용됩니다.

• runAfter: 이 특성에 지정된 스테이지가 완료된 후 현재 스테이지를 실행합니다. .pipeline-config.yaml 에서 사용한 스테이지 이름으로 값을 설정하십시오. 이 특성을 사용하지 말고 이 특성으로 지정된 단계가 파이프라인에 있는지 확인하십시오. 단계가 존재하지 않으면 파이프라인이 교착 상태가 될 수 있습니다.

• skip: true 로 설정된 경우, 가능하면 v10 파이프라인에서 현재 단계를 생략하십시오. 모든 스테이지를 생략할 수 있는 것은 아닙니다. 다음 표에는 파이프라인 실행 중에 건너뛸 수 있는 단계가 나열되어 있습니다.

version: '1' # fixed, this value is used to track schema changes
# `setup` runs right after the app repo is cloned
setup:
  # the pipeline will break in case setup fails (default is true)
  abort_on_failure: true
  # any docker image can be used which is accessible by the private worker
  image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.69
  # you can reference configmaps, each key in the configmap is going to be available as `/config/{key}`
  configmap: my-config
    # `$prop` is the indirect config map syntax, the concrete configmap is looked
    # up from the `environment-properties` configmap
    #
    # Eg. if there's a `prop: my-config` entry in the environment properties,
    # then `my-config` is going to be used for `$prop`
  configmap: $prop
  # the mechanism described works for secrets as well!
  secret: $my-secrets
  # the script is executed inside the checked out app repo
  script: |
    #!/bin/sh
    ...
# `test` runs after `setup`, but before building the docker image
test:
  image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.69
  script: |
    #!/bin/sh
    ...
# `static-scan` runs after `test`, but before building the docker image
static-scan:
  image: ibmcom/pipeline-base-image:2.12
  script: |
    #!/bin/sh
    ...
# `deploy` runs after building the docker image
deploy:
  image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.69
  # the script has access to the built docker image, which is available at `/config/image`
  script: |
    #!/bin/sh
    cat /config/image
# `dynamic-scan` runs after `deploy`, but before the acceptance test run
dynamic-scan:
  image: ibmcom/pipeline-base-image:2.12
  script: |
    #!/bin/sh
    ...
# `acceptance-test` runs after `deploy`
acceptance-test:
  image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.69
  script: |
    #!/bin/sh
    ...