LXD와 커스텀 실행기 사용하기

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

이 예에서는 빌드마다 컨테이너를 생성하고 정리하기 위해 LXD를 사용합니다.

이 예에서 각 단계별로 bash 스크립트를 사용합니다. 자체 이미지를 지정할 수 있으며, 이는 CI_JOB_IMAGE로 노출됩니다. 이 예에서는 간단히 ubuntu:18.04 이미지를 사용합니다. 여러 이미지를 지원하려면 실행기를 수정해야 합니다.

이 스크립트에는 다음과 같은 선행 요구 사항이 있습니다:

구성 

[[runners]]
  name = "lxd-driver"
  url = "https://www.gitlab.com"
  token = "xxxxxxxxxxx"
  executor = "custom"
  builds_dir = "/builds"
  cache_dir = "/cache"
  [runners.custom]
    prepare_exec = "/opt/lxd-driver/prepare.sh" # LXD 컨테이너 생성 및 종속성 다운로드를 위한 bash 스크립트 경로
    run_exec = "/opt/lxd-driver/run.sh" # 컨테이너 내에서 스크립트를 실행하는 bash 스크립트 경로
    cleanup_exec = "/opt/lxd-driver/cleanup.sh" # 컨테이너 삭제를 위한 bash 스크립트 경로

베이스

각 단계 준비, 실행, 그리고 정리에서는 이 스크립트를 사용하여 스크립트 전반에 걸쳐 사용되는 변수를 생성합니다.

이 스크립트가 다른 스크립트와 동일한 디렉토리에 위치하는 것이 중요합니다. 이 경우 /opt/lxd-driver/에 위치합니다. 

#!/usr/bin/env bash

# /opt/lxd-driver/base.sh

CONTAINER_ID="runner-$CUSTOM_ENV_CI_RUNNER_ID-project-$CUSTOM_ENV_CI_PROJECT_ID-concurrent-$CUSTOM_ENV_CI_CONCURRENT_PROJECT_ID-$CUSTOM_ENV_CI_JOB_ID"

준비

준비 스크립트는 다음을 수행합니다:

  • 실행 중인 동일한 이름의 컨테이너를 제거합니다.
  • 컨테이너를 시작하고 시작될 때까지 대기합니다.
  • 필수 종속성을 설치합니다. 
#!/usr/bin/env bash

# /opt/lxd-driver/prepare.sh

currentDir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
source ${currentDir}/base.sh # 베이스에서 변수 가져오기.

set -eo pipefail

# 모든 오류를 catch하고 시스템 오류로 표시합니다.
trap "exit $SYSTEM_FAILURE_EXIT_CODE" ERR

start_container () {
    if lxc info "$CONTAINER_ID" >/dev/null 2>/dev/null ; then
        echo '이전 컨테이너를 찾았으므로 삭제 중'
        lxc delete -f "$CONTAINER_ID"
    fi

    # 컨테이너 이미지는 하드코딩되어 있지만 `CI_JOB_IMAGE` predefined variable을 사용할 수 있습니다.
    # https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
    # 이는 `CUSTOM_ENV_CI_JOB_IMAGE`로 사용 가능하며 사용자가 이미지를 지정할 수 있습니다. 스크립트의 나머지 부분은 우분투 이미지에서 실행 중이라고 가정하므로 수정이 필요할 수 있습니다.
    lxc launch ubuntu:18.04 "$CONTAINER_ID"

    # 컨테이너가 시작될 때까지 대기합니다. 간결성을 위해 systemd를 사용합니다.
    for i in $(seq 1 10); do
        if lxc exec "$CONTAINER_ID" -- sh -c "systemctl isolate multi-user.target" >/dev/null 2>/dev/null; then
            break
        fi

        if [ "$i" == "10" ]; then
            echo '컨테이너 시작을 10초간 기다렸으나 종료합니다.'
            # 시스템 오류임을 GitLab Runner에 알리므로 재시도되어야 합니다.
            exit "$SYSTEM_FAILURE_EXIT_CODE"
        fi

        sleep 1s
    done
}

install_dependencies () {
    # Git LFS를 설치하고, git은 우분투 이미지에 미리 설치되어 있습니다.
    lxc exec "$CONTAINER_ID" -- sh -c 'curl -s "https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh" | sudo bash'
    lxc exec "$CONTAINER_ID" -- sh -c "apt-get install -y git-lfs"

    # 캐시/아티팩트가 필요하므로 gitlab-runner 바이너리를 설치합니다.
    lxc exec "$CONTAINER_ID" -- sh -c 'curl -L --output /usr/local/bin/gitlab-runner "https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64"'
    lxc exec "$CONTAINER_ID" -- sh -c "chmod +x /usr/local/bin/gitlab-runner"
}

echo "$CONTAINER_ID에서 실행 중"

start_container

install_dependencies

실행

이 단계에서는 GitLab Runner에 의해 생성된 스크립트를 STDIN을 통해 컨테이너로 보내 실행합니다. 

#!/usr/bin/env bash

# /opt/lxd-driver/run.sh

currentDir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
source ${currentDir}/base.sh # 베이스에서 변수 가져오기.

lxc exec "$CONTAINER_ID" /bin/bash < "${1}"
if [ $? -ne 0 ]; then
    # 빌드를 GitLab에서 실패로 표시하기 위해 변수를 사용해 종료합니다.
    exit $BUILD_FAILURE_EXIT_CODE
fi

정리

빌드가 완료되었으므로 컨테이너를 삭제합니다. 

#!/usr/bin/env bash

# /opt/lxd-driver/cleanup.sh

currentDir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
source ${currentDir}/base.sh # 베이스에서 변수 가져오기.

echo "$CONTAINER_ID 컨테이너 삭제 중"

lxc delete -f "$CONTAINER_ID"