서비스

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

CI/CD를 구성할 때 작업이 실행되는 컨테이너를 생성하는 데 사용되는 이미지를 지정합니다. 이 이미지를 지정하기 위해 image 키워드를 사용합니다.

services 키워드를 사용하여 추가 이미지를 지정할 수 있습니다. 이 추가 이미지는 두 개의 컨테이너가 서로 이용할 수 있는 다른 컨테이너를 생성하는 데 사용됩니다. 두 개의 컨테이너는 서로에게 접근하고 작업을 실행할 때 통신할 수 있습니다.

서비스 이미지는 임의의 응용 프로그램을 실행할 수 있지만, 가장 흔한 사용 사례는 데이터베이스 컨테이너를 실행하는 것입니다. 예를 들어:

기존 이미지를 사용하여 해당 이미지를 추가 컨테이너로 실행하는 것이 해당 프로젝트가 빌드될 때마다 mysql을 설치하는 것보다 더 간편하고 빠릅니다.

데이터베이스 서비스만 제한되지 않습니다. 필요한 만큼 많은 서비스를 .gitlab-ci.yml에 추가하거나 수동으로 config.toml을 수정할 수 있습니다. Docker Hub나 개인 컨테이너 레지스트리에서 찾은 이미지는 모두 서비스로 사용할 수 있습니다.

서비스는 CI 컨테이너 자체와 동일한 DNS 서버, 검색 도메인, 그리고 추가 호스트를 상속받습니다.

서비스와 작업의 연결 방법

컨테이너의 연결 방법에 대해 더 자세히 알아보려면 컨테이너 연결을 읽어보세요.

어플리케이션에 mysql을 서비스로 추가한다면 해당 이미지는 작업 컨테이너에 연결된 컨테이너를 생성하는 데 사용됩니다.

MySQL의 서비스 컨테이너는 mysql라는 호스트 이름으로 접근할 수 있습니다. 데이터베이스 서비스에 접근하려면 소켓이나 localhost 대신 mysql이라는 호스트에 연결하세요. 서비스에 접근에서 자세히 알아보세요.

서비스의 헬스 체크 작동 방법

서비스는 네트워크로 접근 가능한 추가 기능을 제공하도록 설계되었습니다. MySQL이나 Redis와 같은 데이터베이스, 심지어 Docker-in-Docker를 사용할 수 있습니다. CI/CD 작업이 계속 진행되기 위해 필요한 실제로 어떠한 것이든지 사용할 수 있으며 네트워크로 접근할 수 있습니다.

이러한 작동을 보장하기 위해 러너는 다음을 확인합니다:

  1. 기본적으로 컨테이너에서 노출된 포트를 확인합니다.
  2. 이러한 포트가 접근 가능해질 때까지 대기하는 특별한 컨테이너를 시작합니다.

체크의 두 번째 단계에서 실패하면 경고가 출력됩니다: *** WARNING: Service XYZ probably didn't start properly. 이 문제는 다음과 같은 이유로 발생할 수 있습니다:

  • 서비스에 열린 포트가 없는 경우
  • 서비스가 제한 시간 내에 제대로 시작되지 않았고 포트가 응답하지 않는 경우

대부분의 경우, 작업에 영향을 미치지만 경고가 출력된 경우에도 작업이 성공할 수 있습니다. 예를 들어:

  • 경고가 발생한 후 서비스가 잠시 후 시작되었고 작업이 처음부터 연결된 서비스를 사용하지 않았다면, 작업이 서비스에 연결하려고 할 때 이미 작업이 대기 중이었을 수 있습니다.
  • 서비스 컨테이너가 네트워킹 서비스를 제공하지 않지만 작업 디렉터리(모든 서비스는 /builds 아래의 작업 디렉터리를 볼륨으로 마운트함)에서 무언가를 수행합니다. 이 경우, 서비스는 자신의 작업을 수행하고 작업이 연결하려고 시도하지 않기 때문에 실패하지 않습니다.

서비스가 성공적으로 시작되면, 해당 서비스는 before_script가 실행되기 전에 시작됩니다. 이는 서비스를 쿼리하는 before_script를 작성할 수 있다는 것을 의미합니다.

작업이 실패하더라도 서비스는 작업이 끝날 때까지 계속 실행됩니다.

서비스 이미지에서 제공된 소프트웨어 사용

service를 지정하면 이는 네트워크로 접근 가능한 서비스를 제공합니다. 데이터베이스가 해당 서비스의 가장 간단한 예시입니다.

서비스 기능은 services 이미지에서 정의된 소프트웨어를 작업의 컨테이너에 추가하지 않습니다.

예를 들어, 작업에서 다음과 같이 services를 정의한 경우, php, node 또는 go 명령은 스크립트에서 사용할 수 없으며 작업은 실패합니다: 

job:
  services:
    - php:7
    - node:latest
    - golang:1.10
  image: alpine:3.7
  script:
    - php -v
    - node -v
    - go version

작업에서 php, node 및 go를 사용해야 하는 경우, 다음을 할 수 있습니다:

  • 필요한 모든 도구를 포함하는 기존 Docker 이미지를 선택합니다.
  • 모든 필요한 도구를 포함하는 자체 Docker 이미지를 만들고 해당 이미지를 작업에 사용합니다.

.gitlab-ci.yml 파일에서 services 정의

또한 작업별로 다른 이미지와 서비스를 정의할 수 있습니다: 

default:
  before_script:
    - bundle install

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

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

또는 image 및 services에 대해 몇 가지 확장 구성 옵션을 전달할 수 있습니다: 

default:
  image:
    name: ruby:2.6
    entrypoint: ["/bin/bash"]
  services:
    - name: my-postgres:11.7
      alias: db,postgres,pg
      entrypoint: ["/usr/local/bin/db-postgres"]
      command: ["start"]
  before_script:
    - bundle install

test:
  script:
    - bundle exec rake spec

서비스에 접근

예를 들어, 애플리케이션과의 API 통합을 테스트하기 위해 Wordpress 인스턴스가 필요하다고 가정해 봅시다. 그렇다면 .gitlab-ci.yml 파일에서 tutum/wordpress 이미지를 사용할 수 있습니다: 

services:
  - tutum/wordpress:latest

만약 서비스에 별칭을 지정하지 않았다면, 작업이 실행될 때 tutum/wordpress가 시작됩니다. 빌드 컨테이너에서 두 개의 호스트 이름 아래에서 액세스할 수 있습니다:

  • tutum-wordpress
  • tutum__wordpress

언더스코어로 구분된 호스트 이름은 RFC(요청-응답) 유효하지 않을 수 있으며, 제3자 응용프로그램에서 문제를 일으킬 수 있습니다.

서비스의 호스트 이름의 기본 별칭은 다음 규칙을 따라 이미지 이름에서 만들어집니다:

  • 콜론(:) 이후부터의 모든 문자를 제거합니다.
  • 슬래시(/)는 더블 언더스코어로 (__) 대체하고 주 별칭을 만듭니다.
  • 슬래시(/)는 싱글 대시로 (-) 대체하고 보조 별칭이 만들어집니다(이는 GitLab 러너 v1.1.0 이상이 필요합니다).

기본 동작을 재정의하려면 하나 이상의 서비스 별칭을 지정할 수 있습니다.

서비스 연결

외부 API가 자체 데이터베이스와 통신해야 하는 엔드 투 엔드 테스트와 같은 복잡한 작업과 같은 종속적인 서비스를 사용할 수 있습니다.

예를 들어, API를 사용하는 프런트엔드 애플리케이션에 대한 엔드 투 엔드 테스트에서 API가 데이터베이스가 필요한 경우: 

end-to-end-tests:
  image: node:latest
  services:
    - name: selenium/standalone-firefox:${FIREFOX_VERSION}
      alias: firefox
    - name: registry.gitlab.com/organization/private-api:latest
      alias: backend-api
    - name: postgres:14.3
      alias: db postgres db
  variables:
    FF_NETWORK_PER_BUILD: 1
    POSTGRES_PASSWORD: supersecretpassword
    BACKEND_POSTGRES_HOST: postgres
  script:
    - npm install
    - npm test

이 해결책이 작동하려면 각 작업에 대해 새 네트워크를 만드는 네트워킹 모드를 사용해야 합니다.

CI/CD 변수를 서비스로 전달하기

또한 .gitlab-ci.yml 파일에서 Docker images 및 services를 직접 세밀하게 조정하려면 사용자 정의 CI/CD 변수를 전달할 수도 있습니다. 자세한 내용은 .gitlab-ci.yml에서 정의된 변수를 참조하세요. 

# 다음 변수들은 Postgres 컨테이너 및 Ruby 컨테이너로 자동으로 전달되며 각각에서 사용할 수 있습니다.
variables:
  HTTPS_PROXY: "https://10.1.1.1:8090"
  HTTP_PROXY: "https://10.1.1.1:8090"
  POSTGRES_DB: "my_custom_db"
  POSTGRES_USER: "postgres"
  POSTGRES_PASSWORD: "example"
  PGDATA: "/var/lib/postgresql/data"
  POSTGRES_INITDB_ARGS: "--encoding=UTF8 --data-checksums"

default:
  services:
    - name: postgres:11.7
      alias: db
      entrypoint: ["docker-entrypoint.sh"]
      command: ["postgres"]
  image:
    name: ruby:2.6
    entrypoint: ["/bin/bash"]
  before_script:
    - bundle install

test:
  script:
    - bundle exec rake spec

services의 사용 가능한 설정

  • GitLab 및 GitLab Runner 9.4에서 도입됨.
설정 필요 여부 GitLab 버전 설명
name 다른 옵션과 함께 사용할 경우에는 yes 9.4 사용할 이미지의 전체 이름. 전체 이미지 이름에 레지스트리 호스트명이 포함되어 있는 경우, 단축된 서비스 액세스 이름을 정의하기 위해 alias 옵션을 사용하세요. 더 자세한 내용은 서비스 액세스를 참조하세요.
entrypoint 아니요 9.4 컨테이너의 진입점으로 실행할 명령 또는 스크립트. 컨테이너를 생성하는 동안 Docker --entrypoint 옵션으로 변환됩니다. 이 구문은 Dockerfile의 ENTRYPOINT 지시문과 유사하며, 각 쉘 토큰은 배열에서 별도의 문자열입니다.
command 아니요 9.4 컨테이너의 명령 또는 스크립트. 이미지 이름 뒤에 전달되는 인수로 Docker에 전달됩니다. 이 구문은 Dockerfile의 CMD 지시문과 유사하며, 각 쉘 토큰은 배열에서 별도의 문자열입니다.
alias (1) 아니요 9.4 작업의 컨테이너에서 서비스에 액세스하기 위한 추가 별칭. 여러 별칭은 공백이나 쉼표로 구분될 수 있습니다. 더 자세한 내용은 서비스 액세스를 참조하세요.
variables (2) 아니요 14.5 서비스로 전달되는 추가 환경 변수. 구문은 Job Variables와 동일합니다. 서비스 변수는 자신을 참조할 수 없습니다.

(1) 별칭 지원은 Kubernetes 실행자에 대해 GitLab Runner 12.8에서 도입되었으며 Kubernetes 버전 1.7 이상에서만 사용할 수 있습니다.

(2) Docker 및 Kubernetes 실행자에 대한 서비스 변수 지원은 GitLab Runner 14.8에서 도입되었습니다.

동일한 이미지에서 여러 서비스 시작하기

새로운 확장된 Docker 구성 옵션 이전에는 다음 구성은 제대로 작동하지 않았습니다: 

services:
  - mysql:latest
  - mysql:latest

실행기는 mysql:latest 이미지를 사용하는 두 개의 컨테이너를 시작했지만, 두 컨테이너 모두 기본 호스트 이름 지정을 기반으로 작업 컨테이너에 mysql 별칭이 추가되었습니다. 이로 인해 두 서비스 중 하나에 액세스할 수 없는 상태가 되었습니다.

새로운 확장된 Docker 구성 옵션 이후, 위의 예제는 다음과 같이 보입니다: 

services:
  - name: mysql:latest
    alias: mysql-1
  - name: mysql:latest
    alias: mysql-2

실행기는 여전히 mysql:latest 이미지를 사용하여 두 개의 컨테이너를 시작하지만, 각각을 .gitlab-ci.yml 파일에서 구성된 별칭으로도 액세스할 수 있습니다.

서비스에 대한 명령 설정하기

예를 들어, 일부 SQL 데이터베이스가 있는 super/sql:latest 이미지가 있습니다. 이를 작업의 서비스로 사용하고자 합니다. 또한, 이미지가 컨테이너를 시작하는 동안 데이터베이스 프로세스를 시작하지 않습니다. 사용자는 데이터베이스를 시작하기 위해 수동으로 /usr/bin/super-sql run을 사용해야 합니다.

새로운 확장된 Docker 구성 옵션 이전에는 다음을 수행해야 했습니다:

  • super/sql:latest 이미지를 기반으로 자체 이미지를 만듭니다.
  • 기본 명령을 추가합니다.

  • 작업의 구성에서 이미지를 사용합니다.

    • my-super-sql:latest 이미지의 Dockerfile: 

      FROM super/sql:latest
CMD ["/usr/bin/super-sql", "run"]

    • .gitlab-ci.yml 파일에서 작업: 

      services:
  - my-super-sql:latest

새로운 확장된 Docker 구성 옵션 이후, 다음과 같이 .gitlab-ci.yml 파일에서 command를 설정할 수 있습니다: 

services:
  - name: super/sql:latest
    command: ["/usr/bin/super-sql", "run"]

command의 구문은 Dockerfile의 CMD와 유사합니다.

services를 docker run과 함께 사용하기 (Docker-in-Docker) 옆에

docker run으로 시작된 컨테이너는 GitLab에서 제공하는 서비스에도 연결할 수 있습니다.

서비스 부팅이 비용이 많이들거나 많은 시간이 소요될 때,이 기술을 사용하여 다양한 클라이언트 환경에서 테스트를 실행할 수 있으며, 테스트된 서비스를 단 한 번만 부팅할 수 있습니다. 

access-service:
  stage: build
  image: docker:20.10.16
  services:
    - docker:dind                    # docker run에 필요함
    - tutum/wordpress:latest
  variables:
    FF_NETWORK_PER_BUILD: "true"     # 컨테이너 간 네트워킹 활성화
  script: |
    docker run --rm --name curl \
      --volume  "$(pwd)":"$(pwd)"    \
      --workdir "$(pwd)"             \
      --network=host                 \
      curlimages/curl:7.74.0 curl "http://tutum-wordpress"

이 솔루션이 작동하려면 다음을 준수해야 합니다:

Docker 통합 작동 방식

다음은 작업시 Docker가 수행하는 단계에 대한 고수준 개요입니다.

  1. 모든 서비스 컨테이너를 생성합니다: mysql, postgresql, mongodb, redis.
  2. config.toml과 빌드 이미지의 Dockerfile에서 정의된 모든 볼륨을 저장하기 위한 캐시 컨테이너를 생성합니다(ruby:2.6 예에서와 같이).
  3. 빌드 컨테이너를 생성하고 모든 서비스 컨테이너를 빌드 컨테이너에 연결합니다.
  4. 빌드 컨테이너를 시작하고 작업 스크립트를 컨테이너로 전송합니다.
  5. 작업 스크립트 실행합니다.
  6. 다음 위치에 코드를 확인합니다: /builds/group-name/project-name/.
  7. .gitlab-ci.yml에 정의된 단계를 실행합니다.
  8. 빌드 스크립트의 종료 상태를 확인합니다.
  9. 빌드 컨테이너 및 생성된 모든 서비스 컨테이너를 제거합니다.

서비스 컨테이너 로그 캡처

서비스 컨테이너에서 실행 중인 응용 프로그램에 의해 생성된 로그는 이후 검사 및 디버깅을 위해 캡처될 수 있습니다. 서비스 컨테이너의 로그를 확인하고자 하는 경우는 서비스 컨테이너가 성공적으로 시작되었지만 예상대로 작동하지 않아 작업 실패로 이어지는 경우입니다. 로그는 컨테이너 내의 서비스 구성의 누락 또는 잘못된 구성을 나타낼 수 있습니다.

서비스 로깅을 활성화하려면 프로젝트의 .gitlab-ci.yml 파일에 CI_DEBUG_SERVICES 변수를 추가하십시오: 

variables:
  CI_DEBUG_SERVICES: "true"

허용된 값은 다음과 같습니다:

  • 활성화: TRUE, true, True
  • 비활성화: FALSE, false, False

다른 값은 오류 메시지가 표시되며 해당 기능이 비활성화됩니다.

활성화된 경우 모든 서비스 컨테이너의 로그가 캡처되어 다른 로그와 동시에 작업 추적 로그로 스트리밍됩니다. 각 컨테이너의 로그는 해당 컨테이너의 별칭으로 접두사가 붙으며 다른 색상으로 표시됩니다.

참고: 서비스 컨테이너의 로그를 캡처할 서비스가 활성적으로 디버깅 중일 때만 CI_DEBUG_SERVICES를 활성화해야 합니다. 서비스 컨테이너 로그 캡처에는 저장 및 성능에 영향이 있습니다.

경고: CI_DEBUG_SERVICES를 활성화하면 마스킹된 변수가 공개될 수 있습니다. CI_DEBUG_SERVICES를 활성화하면 서비스 컨테이너 로그와 CI 작업 로그가 작업 추적 로그로 동시에 스트리밍되므로 서비스 컨테이너 로그가 작업의 마스크된 로그 안에 삽입될 수 있습니다. 이는 변수 마스킹 메커니즘을 방해하여 마스크된 변수가 공개될 수 있습니다.

CI/CD 변수 마스킹을 참조하십시오.

로컬에서 작업 디버깅

다음 명령은 관리자 권한 없이 실행됩니다. 사용자 계정으로 Docker를 실행할 수 있어야 합니다.

먼저 build_script라는 파일을 만들어 시작하십시오: 

cat <<EOF > build_script
git clone https://gitlab.com/gitlab-org/gitlab-runner.git /builds/gitlab-org/gitlab-runner
cd /builds/gitlab-org/gitlab-runner
make runner-bin-host
EOF

우리는 여기에서 Makefile을 포함하는 GitLab Runner 리포지토리를 예제로 사용하고 있어, make를 실행하면 Makefile에 정의된 타겟이 실행됩니다. make runner-bin-host 대신에 프로젝트에 특화된 명령을 실행할 수 있습니다.

그런 다음 서비스 컨테이너를 만듭니다: 

docker run -d --name service-redis redis:latest

이전 명령은 최신 Redis 이미지를 사용하여 service-redis라는 이름의 서비스 컨테이너를 만듭니다. 서비스 컨테이너는 백그라운드에서 실행됩니다 (-d).

마지막으로 앞에서 만든 build_script 파일을 실행하여 빌드 컨테이너를 만듭니다: 

docker run --name build -i --link=service-redis:redis golang:latest /bin/bash < build_script

위 명령은 golang:latest 이미지에서 생성된 build라는 컨테이너를 만들고 이 컨테이너에 연결된 서비스가 하나 있는 컨테이너를 생성합니다. build_script는 stdin을 통해 파이프되어 발생하며, 이로써 build 컨테이너에서 build_script를 실행합니다.

테스트를 마치고 이제 더 이상 컨테이너가 필요하지 않다면, 다음으로 모두 제거할 수 있습니다: 

docker rm -f -v build service-redis

위 명령은 build 컨테이너, 서비스 컨테이너 및 해당 컨테이너 만들기에 사용된 모든 볼륨(-v)을 강제로(-f) 제거합니다.

서비스 컨테이너 사용시 보안

Docker 권한 부여 모드는 서비스에 적용됩니다. 이는 서비스 이미지 컨테이너가 호스트 시스템에 액세스할 수 있음을 의미합니다. 신뢰할 수 있는 원본에서 컨테이너 이미지를 사용해야 합니다.

공유된 /builds 디렉토리

빌드 디렉토리는 /builds 아래의 볼륨으로 마운트되어 작업과 서비스 사이에서 공유됩니다. 작업은 서비스가 실행되고 나서 프로젝트를 /builds/$CI_PROJECT_PATH로 체크합니다. 따라서 서비스가 프로젝트 파일이 필요하거나 예를 들어 아티팩트로 사용할 파일을 거기에 넣으려면 그 디렉토리가 존재하고 $CI_COMMIT_SHA가 체크아웃되기를 기다려야 할 수 있습니다. 작업이 체크아웃 프로세스를 완료하기 전에 수행된 변경 사항은 체크아웃 프로세스에 의해 제거됩니다.