Docker 실행자

상세 정보: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed

GitLab Runner은 Docker 이미지에서 작업을 실행하기 위해 Docker 실행자를 사용합니다.

Docker 실행자를 사용하여 다음 작업을 수행할 수 있습니다:

  • 각 작업에 동일한 빌드 환경을 유지합니다.
  • CI 서버에서 작업을 실행할 필요 없이 로컬에서 명령을 테스트하는 데 동일한 이미지를 사용합니다.

Docker 실행자는 Docker Engine를 사용하여 각 작업을 별도 및 격리된 컨테이너에서 실행합니다. Docker Engine에 연결하려면 실행자가 다음을 사용합니다:

사전 요구 사항:

Docker 실행자 워크플로우

Docker 실행자는 준비, 작업 전, 작업 후 단계를 실행하는 데 사용하는 특수한 Alpine Linux를 기반으로 한 Docker 이미지를 사용합니다. 특별한 Docker 이미지의 정의를 보려면 GitLab Runner 저장소를 참조하세요.

Docker 실행자는 작업을 여러 단계로 분할합니다:

  1. 준비: 서비스를 생성하고 시작합니다.
  2. 작업 전: 이전 단계에서 캐시를 복원하고 다운로드하고, 이전에 생성된 아티팩트를 복원합니다. 특수한 Docker 이미지에서 실행됩니다.
  3. 작업: 러너에 구성된 Docker 이미지에서 빌드를 실행합니다.
  4. 작업 후: 캐시를 생성하고 GitLab에 아티팩트를 업로드합니다. 특별한 Docker 이미지에서 실행됩니다.

지원되는 구성

Docker 실행자는 다음 구성을 지원합니다.

Windows 구성의 알려진 문제점 및 추가 요구 사항에 대해서는 Windows 컨테이너 사용를 참조하세요.

러너가 설치된 위치: 실행자는: 컨테이너가 실행 중:
Windows docker-windows Windows
Windows docker Linux
Linux docker Linux

이러한 구성은 지원되지 않습니다:

러너가 설치된 위치: 실행자는: 컨테이너가 실행 중:
Linux docker-windows Linux
Linux docker Windows
Linux docker-windows Windows
Windows docker Windows
Windows docker-windows Linux

참고: GitLab Runner는 Docker Engine API인 v1.25를 사용하여 Docker Engine과 통신합니다. 따라서 Linux 서버에서의 Docker의 최소 지원 버전은 1.13.0이어야 하며, Windows Server의 경우 최신 버전이어야 합니다 Windows Server 버전을 확인하기 위해서.

Docker 실행자 사용

Docker 실행자를 사용하려면 config.toml에서 실행자로 Docker를 정의하세요.

다음 샘플에서는 Docker를 실행자로 정의하고 예제 구성을 보여줍니다. 이러한 값에 대한 자세한 정보는 고급 구성을 참조하세요. 

concurrent = 4

[[runners]]
name = "myRunner"
url = "https://gitlab.com/ci"
token = "......"
executor = "docker"
[runners.docker]
  tls_verify = true
  image = "my.registry.tld:5000/alpine:latest"
  privileged = false
  disable_entrypoint_overwrite = false
  oom_kill_disable = false
  disable_cache = false
  volumes = [
    "/cache",
  ]
  shm_size = 0
  allowed_pull_policies = ["always", "if-not-present"]
  allowed_images = ["my.registry.tld:5000/*:*"]
  allowed_services = ["my.registry.tld:5000/*:*"]
  [runners.docker.volume_driver_ops]
    "size" = "50G"

이미지 및 서비스 구성

사전 요구 사항:

  • 작업이 실행되는 이미지에는 해당 운영 체제의 PATH에서 작동하는 셸이 있어야 합니다. 지원되는 셸은 다음과 같습니다:

Docker 실행자를 구성하려면 .gitlab-ci.yml 및 config.toml에서 Docker 이미지 및 서비스를 정의합니다.

다음 키워드를 사용하세요:

  • image: 러너가 작업을 실행하는 데 사용하는 Docker 이미지의 이름입니다.
    • 로컬 Docker Engine 또는 Docker Hub의 이미지를 입력하세요. 자세한 내용은 Docker documentation를 참조하세요.
    • 이미지 버전을 정의하려면 콜론(:)을 사용하여 태그를 추가하세요. 태그를 지정하지 않으면 Docker는 latest를 버전으로 사용합니다.
  • services: 다른 컨테이너를 만들고 image에 연결하는 추가 이미지입니다. 서비스 유형에 대한 자세한 내용은 Services를 참조하세요.

.gitlab-ci.yml에서 이미지 및 서비스 정의

러너가 모든 작업에 사용하는 이미지 및 빌드 시 사용할 서비스 목록을 정의합니다.

예시: 

image: ruby:2.7

services:
  - postgres:9.3

before_script:
  - bundle install

test:
  script:
  - bundle exec rake spec

작업별로 다른 이미지 및 서비스를 정의하려면: 

before_script:
  - bundle install

test:2.6:
  image: ruby:2.6
  services:
  - postgres:9.3
  script:
  - bundle exec rake spec

test:2.7:
  image: ruby:2.7
  services:
  - postgres:9.4
  script:
  - bundle exec rake spec

만약 .gitlab-ci.yml에서 image를 정의하지 않았다면, 러너는 config.toml에 정의된 image를 사용합니다.

config.toml에서 이미지와 서비스 정의

러너에 의해 실행되는 모든 작업에 이미지와 서비스를 추가하려면 config.toml의 [runners.docker]를 업데이트하세요. 만약 .gitlab-ci.yml에서 image를 정의하지 않았다면, 러너는 config.toml에서 정의된 이미지를 사용합니다.

예시: 

[runners.docker]
  image = "ruby:2.7"

[[runners.docker.services]]
  name = "mysql:latest"
  alias = "db"

[[runners.docker.services]]
  name = "redis:latest"
  alias = "cache"

이 예시는 테이블 배열 구문을 사용합니다.

사설 레지스트리에서 이미지 정의

전제 조건:

사설 레지스트리에서 이미지를 정의하려면, .gitlab-ci.yml에서 레지스트리 이름과 이미지를 제공하세요.

예시: 

image: my.registry.tld:5000/namespace/image:tag

이 예시에서 GitLab 러너는 레지스트리 my.registry.tld:5000에서 이미지 namespace/image:tag를 탐색합니다.

네트워크 구성

CI/CD 작업에 서비스를 연결하기 위해 네트워크를 구성해야 합니다.

네트워크를 구성하려면 다음 중 하나를 사용할 수 있습니다:

  • 권장됨. 러너를 각 작업에 대해 네트워크를 생성하도록 구성합니다.
  • 컨테이너 링크를 정의합니다. 컨테이너 링크는 Docker의 레거시 기능입니다.

각 작업에 대한 네트워크 생성

러너를 각 작업에 대해 네트워크를 생성하도록 구성할 수 있습니다.

이 네트워킹 모드를 활성화하면 러너는 각 작업에 대해 사용자 정의 Docker 브릿지 네트워크를 생성하고 사용합니다. Docker 환경 변수는 컨테이너 간에 공유되지 않습니다. 사용자 정의 브릿지 네트워크에 대한 자세한 내용은 Docker 문서를 참조하세요.

이 네트워킹 모드를 사용하려면 config.toml의 기능 플래그 또는 환경 변수에 FF_NETWORK_PER_BUILD를 활성화하세요.

network_mode을 설정하지 마십시오.

예시: 

[[runners]]
  (...)
  executor = "docker"
  environment = ["FF_NETWORK_PER_BUILD=1"]

또는: 

[[runners]]
  (...)
  executor = "docker"
  [runners.feature_flags]
    FF_NETWORK_PER_BUILD = true

기본 Docker 주소 풀을 설정하려면 dockerd에서 default-address-pool을 사용합니다. 네트워크에서 이미 CIDR 범위가 사용 중이라면 Docker 네트워크가 호스트의 다른 네트워크와(다른 Docker 네트워크 포함) 충돌할 수 있습니다.

이 기능은 Docker 데몬이 IPv6를 활성화한 상태에서만 작동합니다. IPv6 지원을 활성화하려면 Docker 구성에서 enable_ipv6를 true로 설정하세요. 자세한 내용은 Docker 문서를 참조하세요.

러너는 작업 컨테이너를 해결하기 위해 build 별칭을 사용합니다.

러너가 각 작업에 대해 네트워크를 생성하는 방법

작업이 시작되면 러너가:

  1. Docker 명령어 docker network create <network>와 유사한 브릿지 네트워크를 생성합니다.
  2. 서비스와 컨테이너를 브릿지 네트워크에 연결합니다.
  3. 작업을 끝날 때 네트워크를 제거합니다.

작업을 실행하는 컨테이너와 서비스를 실행하는 컨테이너는 상호의 호스트명 및 별칭을 해결합니다. 이 기능은 Docker에서 제공됩니다.

컨테이너 링크로 네트워크 구성

Docker의 레거시 컨테이너 링크 및 기본 Docker bridge를 사용하여 작업 컨테이너를 서비스와 연결하는 네트워크 모드를 구성할 수 있습니다. 이 네트워크 모드는 FF_NETWORK_PER_BUILD가 활성화되지 않은 경우 기본값입니다.

네트워크를 구성하려면 config.toml 파일에서 네트워킹 모드를 지정하세요:

  • bridge: 브릿지 네트워크 사용. 기본값.
  • host: 컨테이너 내부에서 호스트의 네트워크 스택 사용.
  • none: 네트워킹 없음. 권장되지 않음.

예시: 

[[runners]]
  (...)
  executor = "docker"
[runners.docker]
  network_mode = "bridge"

다른 network_mode 값을 사용하는 경우, 빌드 컨테이너가 연결되는 기존 Docker 네트워크의 이름으로 간주됩니다.

이름 해결 중에 Docker는 컨테이너 내부의 /etc/hosts 파일을 서비스 컨테이너 호스트명과 별칭으로 업데이트합니다. 그러나 서비스 컨테이너에게는 컨테이너 이름을 해결할 수 없습니다. 컨테이너 이름을 해결하려면 각 작업에 대해 네트워크를 생성해야 합니다.

연결된 컨테이너는 환경 변수를 공유합니다.

생성된 네트워크의 MTU 재정의

OpenStack의 가상 머신과 같은 일부 환경에서 사용자 정의 MTU가 필요할 수 있습니다. Docker 데몬은 docker.json에 지정된 MTU를 존준하지 않습니다(Moby 이슈 34981 참조). config.toml에 network_mtu를 설정하여 새로 생성된 네트워크에 대해 올바른 MTU를 사용하도록 Docker 데몬을 설정할 수 있습니다. 이 재정의가 적용되려면 FF_NETWORK_PER_BUILD을 활성화해야 합니다.

다음 구성은 각 작업에 대해 생성된 네트워크의 MTU를 1402로 설정합니다. 환경 요구에 맞게 값을 조정하십시오. 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    network_mtu = 1402
    [runners.feature_flags]
      FF_NETWORK_PER_BUILD = true

Docker 이미지와 서비스 제한

Docker 이미지와 서비스를 제한하려면 allowed_images 및 allowed_services 매개변수에 와일드카드 패턴을 지정하세요.

예를 들어, 사설 Docker 레지스트리에서의 이미지만 허용하려면 다음과 같이 지정하세요: 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    allowed_images = ["my.registry.tld:5000/*:*"]
    allowed_services = ["my.registry.tld:5000/*:*"]

사설 Docker 레지스트리의 이미지 목록으로 제한하려면 다음과 같이 지정하세요: 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    allowed_images = ["my.registry.tld:5000/ruby:*", "my.registry.tld:5000/node:*"]
    allowed_services = ["postgres:9.4", "postgres:latest"]

서비스 호스트명 액세스

서비스 호스트명에 액세스하려면 .gitlab-ci.yml의 services에 서비스를 추가하십시오.

예를 들어, Wordpress 인스턴스를 사용하여 응용 프로그램과의 API 통합을 테스트하려면, 서비스 이미지로 tutum/wordpress를 사용하십시오: 

services:
- tutum/wordpress:latest

작업 실행 시, tutum/wordpress 서비스가 시작됩니다. 빌드 컨테이너에서 tutum__wordpress 및 tutum-wordpress 호스트명을 사용하여 액세스할 수 있습니다.

지정된 서비스 별칭 외에도, 러너는 서비스 컨테이너에 서비스 이미지 이름을 별칭으로 할당합니다. 이러한 별칭 중 아무 것이나 사용할 수 있습니다.

러너는 이미지 이름을 기반으로 다음과 같은 규칙을 사용하여 별칭을 생성합니다:

  • : 이후의 모든 것이 제거됩니다.
  • 첫 번째 별칭에는 슬래시(/)가 더블 언더스코어로(__) 대체됩니다.
  • 두 번째 별칭에는 슬래시(/)가 싱글 대시(-)로 대체됩니다.

사용자는 프라이빗 서비스 이미지를 사용하는 경우, 러너가 지정된 포트를 제거하고 규칙을 적용합니다. registry.gitlab-wp.com:4999/tutum/wordpress 서비스는 호스트명 registry.gitlab-wp.com__tutum__wordpress와 registry.gitlab-wp.com-tutum-wordpress으로 결과됩니다.

서비스 구성

데이터베이스 이름을 변경하거나 계정 이름을 설정하려면 서비스에 환경 변수를 정의할 수 있습니다.

러너가 변수를 전달하면:

  • 변수는 모든 컨테이너에 전달됩니다. 러너는 특정 컨테이너에 변수를 전달할 수 없습니다.
  • 안전한 변수는 빌드 컨테이너로 전달됩니다.

구성 변수에 대한 자세한 정보는 각 이미지의 Docker Hub 페이지에 제공된 설명서를 참조하십시오.

RAM에 디렉터리 마운트

디렉터리를 RAM에 마운트하려면 tmpfs 옵션을 사용할 수 있습니다. 이는 데이터베이스와 같은 I/O 관련 작업이 많은 경우 성능을 높일 수 있습니다.

러너 구성에서 tmpfs와 services_tmpfs 옵션을 사용하면 각각 고유의 옵션을 가진 여러 경로를 지정할 수 있습니다. 더 많은 정보는 Docker 문서를 참조하십시오.

예를 들어, 공식 MySQL 컨테이너의 데이터 디렉터리를 RAM에 마운트하려면, config.toml을 구성하십시오: 

[runners.docker]
  # For the main container
  [runners.docker.tmpfs]
      "/var/lib/mysql" = "rw,noexec"

  # For services
  [runners.docker.services_tmpfs]
      "/var/lib/mysql" = "rw,noexec"

서비스 내 디렉토리 빌드

GitLab 러너는 모든 공유 서비스에 대해 /builds 디렉토리를 마운트합니다.

다른 서비스 사용에 대한 자세한 내용은 다음을 참조하십시오:

GitLab 러너가 서비스 상태 확인을 수행하는 방법

서비스가 시작되면, GitLab 러너는 서비스의 응답을 기다립니다. Docker 실행자는 서비스 컨테이너의 노출된 서비스 포트로 TCP 연결을 시도합니다.

  • GitLab 15.11 이전에는 첫 번째 노출된 포트만 확인됩니다.
  • GitLab 16.0 이후에는 처음 20개의 노출된 포트가 확인됩니다.

HEALTHCHECK_TCP_PORT 서비스 변수를 사용하여 특정 포트에서 상태 확인을 수행할 수 있습니다: 

job:
  services:
    - name: mongo
      variables:
        HEALTHCHECK_TCP_PORT: "27017"

이 구현 방법을 보려면, health check Go command를 사용하십시오.

Docker 드라이버 작업 지정

빌드용 볼륨을 생성할 때 Docker 볼륨 드라이버에 전달할 인수를 지정하십시오. 예를 들어, 각 빌드가 실행할 수 있는 공간을 제한하는 데 사용할 수 있습니다.

다음 예제에서는 각 빌드가 사용할 수 있는 공간을 50GB로 설정하는 config.toml을 보여줍니다. 

[runners.docker]
  [runners.docker.volume_driver_ops]
      "size" = "50G"

컨테이너 빌드 및 캐시용 디렉토리 구성

컨테이너에 데이터를 저장할 디렉토리를 정의하려면, config.toml의 [runners.docker] 섹션에서 /builds 및 /cache 디렉토리를 구성하십시오.

/cache 저장 경로를 수정하는 경우, 해당 경로를 영구적으로 표시하려면 config.toml의 [runners.docker] 섹션에서 volumes = ["/my/cache/"]를 정의해야 합니다.

기본적으로 Docker 실행자는 다음 디렉토리에 빌드 및 캐시를 저장합니다:

  • /builds/<namespace>/<project-name>에 빌드
  • 컨테이너 내의 /cache에 캐시

Docker 캐시 지우기

러너에 의해 생성된 사용되지 않는 컨테이너 및 볼륨을 제거하려면 clear-docker-cache를 사용하십시오.

옵션 목록을 보려면 다음과 같이 help 옵션을 사용하여 스크립트를 실행하십시오: 

clear-docker-cache help

기본 옵션은 모든 사용되지 않는 컨테이너 (둥글거나 참조되지 않음) 및 볼륨을 제거하는 prune-volumes입니다.

효율적으로 캐시 저장 공간을 관리하려면:

  • cron을 사용하여 정기적으로 clear-docker-cache를 실행하십시오 (예: 주마다 한 번).
  • 디스크 공간을 회수하면서 성능을 위해 최근 컨테이너를 유지하십시오.

Docker 빌드 이미지 지우기

clear-docker-cache 스크립트는 GitLab 러너에 의해 태그되지 않았기 때문에 Docker 이미지를 제거하지 않습니다.

Docker 빌드 이미지를 지우려면:

  1. 회수할 디스크 공간을 확인하십시오: 

    clear-docker-cache space

Show docker disk usage
----------------------

TYPE            TOTAL     ACTIVE    SIZE      RECLAIMABLE
Images          14        9         1.306GB   545.8MB (41%)
Containers      19        18        115kB     0B (0%)
Local Volumes   0         0         0B        0B
Build Cache     0         0         0B        0B

  2. 사용되지 않는 컨테이너, 네트워크, 이미지 (둥글고 참조되지 않음) 및 태그되지 않은 볼륨을 모두 제거하려면, docker system prune을 실행하십시오.

Persistent storage

도커 실행자는 컨테이너를 실행할 때 지속적인 저장소를 제공합니다. volumes =에 정의된 모든 디렉토리는 빌드 간에 지속적입니다.

volumes 지시문은 다음 유형의 저장소를 지원합니다:

  • 동적 저장소의 경우, <경로>를 사용합니다. <경로>는 동일한 프로젝트의 동시 작업의 후속 실행 간에 지속됩니다. 데이터는 사용자 정의 캐시 볼륨에 첨부됩니다: runner-<short-token>-project-<id>-concurrent-<concurrency-id>-cache-<md5-of-path>.
  • 호스트 바운드 저장소의 경우, <host-path>:<path>[:<mode>]를 사용합니다. <path>는 호스트 시스템의 <host-path>에 바운드됩니다. 선택적인 <mode>는 이 저장소가 읽기 전용 또는 읽기/쓰기 (기본)임을 지정합니다.

빌드용 지속적 저장소

/builds 디렉토리를 호스트 바운드 저장소로 만들면, 빌드는 다음 위치에 저장됩니다: /builds/<short-token>/<concurrent-id>/<namespace>/<project-name>, 여기서:

  • <short-token>은 실행자 토큰의 줄임 버전 (첫 8자)입니다.
  • <concurrent-id>는 프로젝트의 문맥에서 특정 실행자의 로컬 작업 ID를 식별하는 고유한 번호입니다.

IPC 모드

도커 실행자는 컨테이너의 IPC 네임스페이스를 다른 위치와 공유하는 것을 지원합니다. 이는 docker run --ipc 플래그에 매핑됩니다. 더 많은 세부 정보는 도커 설명서의 IPC 설정에서 확인할 수 있습니다.

특권 모드

도커 실행자는 빌드 컨테이너를 세부 조정하는 여러 옵션을 지원합니다. 이 중 하나는 privileged 모드입니다.

특권 모드로 Docker-in-Docker 사용

구성된 privileged 플래그는 빌드 컨테이너와 모든 서비스에 전달되어, Docker-in-Docker 접근을 쉽게 허용합니다.

먼저 실행자를 privileged 모드로 실행하도록 실행자를 구성합니다 (config.toml): 

[[runners]]
  executor = "docker"
  [runners.docker]
    privileged = true

그런 다음, 빌드 스크립트 (.gitlab-ci.yml)에서 Docker-in-Docker 컨테이너를 사용하도록 설정합니다: 

image: docker:git
services:
- docker:dind

build:
  script:
  - docker build -t my-image .
  - docker push my-image

경고: 특권 모드에서 실행되는 컨테이너는 보안 위험을 가집니다. 컨테이너가 특권 모드에서 실행되면 컨테이너 보안 메커니즘을 비활성화하고 호스트에 권한 상승을 노출시킵니다. 특권 모드에서 컨테이너를 실행하면 컨테이너 탈출로 이어질 수 있습니다. 자세한 정보는 runtime privilege and Linux capabilities에 대한 도커 설명서를 참조하세요.

다음과 같은 오류를 피하고 싶다면, 도커 설명서에서 확인할 수 있듯이, Docker in Docker를 TLS로 구성하거나 TLS를 비활성화 해야 할 수도 있습니다.

제한된 특권 모드로 루트리스(Docker-in-Docker의 루트리스 버전)

이 버전에서는 Docker-in-Docker 루트리스 이미지만 특권 모드로 서비스로 실행할 수 있습니다.

services_privileged와 allowed_privileged_services 구성 매개변수는 특권 모드에서 실행되는 허용되는 컨테이너를 제한합니다.

제한된 특권 모드로 루트리스 Docker-in-Docker를 사용하려면:

  1. config.toml에서 실행자를 services_privileged와 allowed_privileged_services를 사용하도록 구성합니다: 

    [[runners]]
  executor = "docker"
  [runners.docker]
    services_privileged = true
    allowed_privileged_services = ["docker.io/library/docker:*-dind-rootless", "docker.io/library/docker:dind-rootless", "docker:*-dind-rootless", "docker:dind-rootless"]

  2. .gitlab-ci.yml에서 빌드 스크립트를 Docker-in-Docker 루트리스 컨테이너로 편집합니다: 

    image: docker:git
services:
- docker:dind-rootless

build:
  script:
  - docker build -t my-image .
  - docker push my-image

allowed_privileged_services에 나열된 Docker-in-Docker 루트리스 이미지만 특권 모드에서 실행할 수 있습니다. 작업 및 서비스용 다른 모든 컨테이너는 비특권 모드로 실행됩니다.

비바이트 이미지로 실행되기 때문에, Docker-in-Docker 루트리스 또는 Buildkit 루트리스와 같은 이미지를 거의 안전하게 사용할 수 있습니다.

보안 문제에 대한 자세한 정보는, Docker 실행자의 보안 위험을 참조하세요.

Docker ENTRYPOINT 구성

기본적으로 Docker 실행자는 Docker 이미지의 ENTRYPOINT를 덮어쓰지 않으며 sh 또는 bash를 COMMAND로 전달하여 작업 스크립트를 실행하는 컨테이너를 시작합니다.

작업 스크립트를 실행할 수 있도록, Docker 이미지는:

  • sh 또는 bash와 grep를 제공해야 합니다.
  • 인수로 sh/bash를 전달하면 쉘을 시작하는 ENTRYPOINT를 정의해야 합니다.

Docker 실행자는 작업의 컨테이너를 다음 명령의 동등한 것으로 실행합니다: 

docker run <image> sh -c "echo 'It works!'" # 또는 bash

만약 Docker 이미지가 이 메커니즘을 지원하지 않는다면, 프로젝트 구성에서 이미지의 ENTRYPOINT를 덮어쓸 수 있습니다: 

# 동등한
# docker run --entrypoint "" <image> sh -c "echo 'It works!'"
image:
  name: my-image
  entrypoint: [""]

자세한 정보는 이미지의 ENTRYPOINT 덮어쓰기와 Docker에서 CMD와 ENTRYPOINT 상호 작용 이해를 참조하세요.

작업 스크립트와 ENTRYPOINT

ENTRYPOINT를 사용하여 커스텀 환경이나 보안 모드에서 빌드 스크립트를 실행하는 Docker 이미지를 생성할 수 있습니다.

예를 들어, 빌드 스크립트를 실행하지 않는 ENTRYPOINT를 사용하는 Docker 이미지를 생성할 수 있습니다. 대신 Docker 이미지가 디렉토리에서 빌드를 수행하는 미리 정의된 일련의 명령을 실행합니다. privileged mode에서 빌드 컨테이너를 실행하고, 러너의 빌드 환경을 보호합니다.

  1. 새 Dockerfile을 생성합니다: 

    FROM docker:dind
ADD / /entrypoint.sh
ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]

  2. ENTRYPOINT로 사용되는 bash 스크립트(entrypoint.sh)를 생성합니다: 

    #!/bin/sh

dind docker daemon
    --host=unix:///var/run/docker.sock \
    --host=tcp://0.0.0.0:2375 \
    --storage-driver=vf &

docker build -t "$BUILD_IMAGE" .
docker push "$BUILD_IMAGE"

  3. 이미지를 Docker 레지스트리에 푸시합니다.

  4. 권한 부여된 모드에서 Docker 실행기를 실행합니다. config.toml에 다음을 정의하세요: 

    [[runners]]
  executor = "docker"
  [runners.docker]
    privileged = true

  5. 프로젝트에서 다음과 같이 .gitlab-ci.yml을 사용합니다: 

    variables:
  BUILD_IMAGE: my.image
build:
  image: my/docker-build:image
  script:
  - Dummy Script

Docker 명령을 실행하기 위해 Podman 사용

Linux에 GitLab Runner가 설치된 경우, 작업에서 Docker 실행기에서 컨테이너 실행에 Docker를 대체하기 위해 Podman을 사용할 수 있습니다.

전제 조건:

  1. Linux 호스트에서 GitLab Runner를 설치하세요. 시스템 패키지 관리자를 사용하여 GitLab Runner를 설치한 경우, 자동으로 gitlab-runner 사용자가 생성됩니다.
  2. GitLab Runner로 실행할 사용자로 로그인합니다. 이렇게 하면 pam_systemd를 우회하지 않고 올바른 사용자로 SSH를 사용할 수 있습니다. 이는 해당 사용자로 systemctl을 실행할 수 있도록 합니다.
  3. 시스템이 루트리스 Podman 설정에 필요한 요구 사항을 충족하는지 확인하세요. 특히 사용자가 /etc/subuid 및 /etc/subgid에 올바른 항목을 가지고 있는지 확인하세요.
  4. Linux 호스트에서 Podman을 설치하세요.

  5. Podman 소켓을 활성화하고 시작하세요: 

    systemctl --user --now enable podman.socket

  6. Podman 소켓이 수신 대기 중인지 확인하세요: 

    systemctl status --user podman.socket
  7. Podman의 API에 액세스하는 것을 통해 Listen 키에서 소켓 문자열을 복사하세요.

  8. GitLab Runner 사용자 로그 아웃 후에도 Podman 소켓이 사용 가능하도록 하세요: 

    sudo loginctl enable-linger gitlab-runner

  9. GitLab Runner config.toml 파일을 편집하고 소켓 값을 [runners.docker] 섹션의 host 항목에 추가하세요. 예: 

    [[runners]]
  name = "podman-test-runner-2022-06-07"
  url = "https://gitlab.com"
  token = "x-XxXXXXX-xxXxXxxxxx"
  executor = "docker"
  [runners.docker]
    host = "unix:///run/user/1012/podman/podman.sock"
    tls_verify = false
    image = "quay.io/podman/stable"
    privileged = true

Dockerfile로부터 컨테이너 이미지를 빌드하기 위해 Podman 사용

다음 예제는 Podman을 사용하여 컨테이너 이미지를 빌드하고 해당 이미지를 GitLab 컨테이너 레지스트리에 푸시하는 방법을 보여줍니다.

Runner의 config.toml에서 기본 컨테이너 이미지를 quay.io/podman/stable로 설정하여 CI 작업에서 해당 이미지를 사용하여 포함된 명령을 실행합니다. 

variables:
  IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG

before_script:
  - podman login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY

oci-container-build:
  stage: build
  script:
    - podman build -t $IMAGE_TAG .
    - podman push $IMAGE_TAG
  when: manual

Dockerfile로부터 컨테이너 이미지를 빌드하기 위해 Buildah 사용

다음 예제는 Buildah를 사용하여 컨테이너 이미지를 빌드하고 해당 이미지를 GitLab 컨테이너 레지스트리에 푸시하는 방법을 보여줍니다. 

image: quay.io/buildah/stable

variables:
  IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG

before_script:
  - buildah login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY

oci-container-build:
  stage: build
  script:
    - buildah bud -t $IMAGE_TAG .
    - buildah push $IMAGE_TAG
  when: manual

작업을 실행하는 사용자 지정

기본적으로 러너는 컨테이너 내에서 작업을 root 사용자로 실행합니다. 다른 비 ROOT 사용자를 지정하여 작업을 실행하려면 Docker 이미지의 Dockerfile에서 USER 지시문을 사용하세요. 

FROM amazonlinux
RUN ["yum", "install", "-y", "nginx"]
RUN ["useradd", "www"]
USER "www"
CMD ["/bin/bash"]

해당 Docker 이미지를 사용하여 작업을 실행하면 지정된 사용자로 실행됩니다: 

build:
  image: my/docker-build:image
  script:
  - whoami   # www

Runner 이미지를 가져오는 방식 구성

config.toml에서 pull 정책을 구성하여 레지스트리에서 Runner가 Docker 이미지를 가져오는 방식을 정의할 수 있습니다. 단일 정책, 여러 정책 목록, 또는 특정 pull 정책 허용을 설정할 수 있습니다.

pull_policy에 다음 값들을 사용하세요:

  • always: 로컬 이미지가 존재하더라도 이미지를 항상 가져옵니다. 기본값입니다.
  • if-not-present: 로컬 버전이 존재하지 않을 때에만 이미지를 가져옵니다.
  • never: 이미지를 절대로 가져오지 않고 로컬 이미지만 사용합니다. 
[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    pull_policy = "always" # 가능 값: always, if-not-present, never

always pull 정책 설정

기본적으로 켜져 있는 always 옵션은 컨테이너를 생성하기 전에 항상 이미지를 가져옵니다. 이 옵션을 사용하면 이미지가 최신 상태임을 보장하고, 로컬 이미지가 존재해도 오래 된 이미지를 사용하는 것을 방지합니다.

이 pull 정책은 다음 경우에 사용하세요:

  • Runner가 항상 가장 최신 이미지를 가져와야 하는 경우.
  • Runner가 자동 확장 또는 GitLab 인스턴스 내에서 공유 Runner로 구성된 경우.

이 pull 정책은 로컬로 저장된 이미지를 사용해야 하는 경우에는 사용하지 마십시오.

config.toml에서 pull_policy로 always를 설정하세요: 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    pull_policy = "always"

if-not-present pull 정책 설정

if-not-present pull 정책을 설정하면 Runner는 먼저 로컬 이미지가 있는지 확인합니다. 로컬 이미지가 없는 경우에만 레지스트리에서 이미지를 가져옵니다.

다음 상황에 if-not-present 정책을 사용하세요:

  • 로컬 이미지를 사용하되, 로컬 이미지가 없는 경우 이미지를 가져와야 하는 경우.
  • 무거운 이미지 레이어의 차이를 분석하는 데 걸리는 시간을 줄여야 하는 경우. 이 경우에는 정기적으로 Docker Engine 스토어에서 이미지를 수동으로 삭제하여 이미지를 강제로 업데이트해야 합니다.

다음 상황에 이 정책을 사용하지 마십시오:

  • 다른 사용자가 Runner를 사용하는 공유 Runner에서 개인 이미지에 액세스할 수 있는 경우. 보안 문제에 대한 자세한 내용은 if-not-present pull 정책에서 개인 Docker 이미지 사용을 참조하십시오.
  • 작업이 자주 업데이트되어야 하고 항상 최신 이미지 버전에서 실행해야 하는 경우. 이 때문에 로컬 이미지를 자주 삭제하는 가치가 네트워크 부하 감소를 상쇄할 수 있습니다.

config.toml에서 if-not-present 정책을 설정하세요: 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    pull_policy = "if-not-present"

never pull 정책 설정

전제 조건:

  • 로컬 이미지에는 설치된 Docker Engine과 사용된 이미지의 로컬 사본이 포함되어 있어야 합니다.

never pull 정책을 설정하면 이미지 가져오기가 비활성화됩니다. 사용자는 Runner가 실행되는 Docker 호스트에서 수동으로 가져온 이미지만 사용할 수 있습니다.

never pull 정책을 사용하여:

  • Runner 사용자가 사용할 이미지를 제어합니다.
  • 공개 레지스트리에 공개되어 있지 않은 특정 이미지만 사용할 수 있는 프로젝트에 대한 전용 Runner에 사용합니다.

자동 확장 Docker executor에서 never pull 정책을 사용하지 마십시오. never pull 정책은 선택한 클라우드 제공업체를 위해 사전 정의된 클라우드 인스턴스 이미지를 사용할 때에만 사용할 수 있습니다.

config.toml에서 never 정책을 설정하세요: 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    pull_policy = "never"

여러 pull 정책 설정

만약 레지스트리에서 이미지 가져오기를 실패하는 경우를 대비하여 여러 pull 정책을 목록으로 나열할 수 있습니다. Runner는 pull 정책을 나열된 순서대로 처리하고, 가져오기 시도가 성공하거나 목록이 고갈될 때까지 처리합니다. 예를 들어, Runner가 always pull 정책을 사용하고 레지스트리에 액세스할 수 없는 경우, if-not-present를 두 번째 pull 정책으로 추가하여 로컬로 캐시된 Docker 이미지를 사용할 수 있습니다.

이 pull 정책의 보안 문제에 대한 자세한 내용은 if-not-present pull 정책에서 개인 Docker 이미지 사용을 참조하십시오.

여러 pull 정책을 config.toml에 목록으로 추가하세요: 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    pull_policy = ["always", "if-not-present"]

Docker pull 정책 허용

.gitlab-ci.yml 파일에서 pull 정책을 지정할 수 있습니다. 이 정책은 CI/CD 작업이 이미지를 가져오는 방식을 결정합니다.

.gitlab-ci.yml 파일에서 사용할 수 있는 pull 정책을 제한하려면 allowed_pull_policies를 사용하세요.

예를 들어, always와 if-not-present pull 정책만 허용하려면 config.toml에 추가하세요: 

[[runners]]
  (...)
  executor = "docker"
  [runners.docker]
    (...)
    allowed_pull_policies = ["always", "if-not-present"]
  • allowed_pull_policies를 지정하지 않으면 목록은 pull_policy 키워드에 지정된 값과 일치합니다.
  • pull_policy를 지정하지 않으면 기본값은 always입니다.
  • 기존의 pull_policy 키워드는 allowed_pull_policies에 지정되지 않은 pull 정책을 포함해서는 안 됩니다. 그렇지 않으면 작업에서 오류가 발생합니다.

이미지 가져오기 오류 메시지

오류 메시지 설명
Pulling docker image registry.tld/my/image:latest ... ERROR: Build failed: Error: image registry.tld/my/image:latest not found Runner가 이미지를 찾을 수 없습니다. always pull 정책이 설정된 경우 표시됩니다.
Pulling docker image local_image:latest ... ERROR: Build failed: Error: image local_image:latest not found 이미지가 로컬에서 빌드되었고 기본 Docker 레지스트리에도 존재하지 않습니다. always pull 정책이 설정된 경우 표시됩니다.
Pulling docker image registry.tld/my/image:latest ... WARNING: Cannot pull the latest version of image registry.tld/my/image:latest : Error: image registry.tld/my/image:latest not found WARNING: Locally found image will be used instead. Runner가 이미지를 가져오는 대신 로컬 이미지를 사용했습니다. always pull 정책이 GitLab Runner 1.8 미만에서만 표시됩니다.
Pulling docker image local_image:latest ... ERROR: Build failed: Error: image local_image:latest not found 이미지를 로컬에서 찾을 수 없습니다. never pull 정책이 설정된 경우 표시됩니다.
WARNING: Failed to pull image with policy "always": Error response from daemon: received unexpected HTTP status: 502 Bad Gateway (docker.go:143:0s) Attempt #2: Trying "if-not-present" pull policy Using locally found image version due to "if-not-present" pull policy Runner가 이미지를 가져오지 못하고 다음 목록된 pull 정책을 사용해 이미지를 가져오려고 시도합니다. 여러 pull 정책이 설정된 경우 표시됩니다.

실패한 풀 다시 시도하기

런너를 구성하여 실패한 이미지 풀을 다시 시도하려면 config.toml에서 동일한 정책을 여러 번 지정하세요.

예를 들어, 이 구성은 한 번 풀을 다시 시도합니다. 

[runners.docker]
  pull_policy = ["always", "always"]

이 설정은 다음 재시도 지시문 과 유사하지만, 특별히 도커 풀이 초기에 실패한 경우에만 적용됩니다.

Windows 컨테이너 사용

  • [소개] (https://gitlab.com/groups/gitlab-org/-/epics/535) GitLab Runner 11.11에서 소개되었습니다.

도커 실행기와 Windows 컨테이너를 사용하려면, 제한 사항, 지원되는 Windows 버전 및 Windows Docker 실행기 구성에 대한 다음 정보를 참조하세요.

Nanoserver 지원

  • [소개] (https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/2492) GitLab Runner 13.6에서 소개되었습니다.

Windows 도우미 이미지에서 PowerShell Core 지원이 도입된 것으로, 이제 도우미 이미지의 nanoserver 변형을 활용할 수 있습니다.

Windows에서 Docker 실행기의 제한 사항

Windows 컨테이너를 사용하는 것에 대한 일부 제한 사항은 다음과 같습니다.

  • Docker-in-Docker은 도커 자체에서 지원되지 않기 때문에 지원되지 않습니다.
  • 대화형 웹 터미널은 지원되지 않습니다.
  • 호스트 장치 마운팅은 지원되지 않습니다.
  • 볼륨 디렉토리를 마운트할 때 디렉토리가 있어야 하며, 그렇지 않으면 도커에서 컨테이너를 시작하지 못합니다. 자세한 사항은 #3754를 참조하세요.
  • docker-windows 실행기는 Windows에서 실행 중인 GitLab Runner에서만 실행할 수 있습니다.
  • Windows에서 Linux 컨테이너 은 아직 실험적이기 때문에 지원되지 않습니다. 자세한 내용은 관련된 이슈에서 확인하세요.

  • Docker의 제한으로 인해, 대상 경로 드라이브 문자가 c:가 아니면 다음에 대한 경로가 지원되지 않습니다.

    이는 f:\\cache_dir와 같은 값이 지원되지 않음을 의미하지만, f:는 지원됩니다. 그러나 대상 경로가 c: 드라이브에 있는 경우에도 경로가 지원됩니다. (예: c:\\cache_dir).

    도커 데몬이 이미지 및 컨테이너를 보관하는 위치를 구성하려면 도커 데몬의 daemon.json 파일에서 data-root 매개변수를 업데이트하세요.

    자세한 정보는 구성 파일을 사용하여 도커 구성을 참조하세요.

지원되는 Windows 버전

GitLab Runner는 다음 Windows 버전만 지원합니다. 이는 저희의 Windows 지원 수명 주기를 따릅니다:

  • Windows Server 2022 LTSC (21H2)
  • Windows Server 2019 LTSC (1809)

미래의 Windows Server 버전에 대해서는 미래 버전 지원 정책을 확인하세요.

GitLab Runner가 실행 중인 Windows와 동일한 OS 버전을 기반으로 한 컨테이너만 실행할 수 있습니다. 예를 들어, 다음 Windows Server Core 이미지를 사용할 수 있습니다.

  • mcr.microsoft.com/windows/servercore:ltsc2022
  • mcr.microsoft.com/windows/servercore:ltsc2022-amd64
  • mcr.microsoft.com/windows/servercore:1809
  • mcr.microsoft.com/windows/servercore:1809-amd64
  • mcr.microsoft.com/windows/servercore:ltsc2019

지원되는 Docker 버전

GitLab Runner를 실행 중인 Windows Server는 Windows Server의 버전을 감지하기 위해 Docker의 최신 버전을 실행해야 합니다.

GitLab Runner와 작동하지 않는 알려진 Docker 버전은 Docker 17.06인데, Docker가 Windows Server 버전을 식별하지 못하여 다음 오류가 발생합니다: 

지원되지 않는 Windows 버전: Windows Server Datacenter

이 문제 해결에 대해 자세히 읽어보세요.

Windows Docker 실행기 구성

참고: --docker-volumes 또는 DOCKER_VOLUMES 환경 변수를 전달할 때 소스 디렉토리로 c:\\cache를 등록한 경우에는 알려진 문제가 있습니다.

다음은 Windows에서 실행되는 간단한 도커 실행기를 위한 구성 예입니다. 

[[runners]]
  name = "windows-docker-2019"
  url = "https://gitlab.com/"
  token = "xxxxxxx"
  executor = "docker-windows"
  [runners.docker]
    image = "mcr.microsoft.com/windows/servercore:1809_amd64"
    volumes = ["c:\\cache"]

도커 실행기에 대한 기타 구성 옵션은 고급 구성 섹션을 참조하세요.

서비스

GitLab Runner 12.9 이상에서 작업별 네트워크를 만들어 서비스를 활성화할 수 있습니다.