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

# 오류 발생 시 대비하여 중단하고 시스템 오류로 표시합니다.
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`(이하 `CI_JOB_IMAGE`를 사용하는 스크립트의 나머지 부분에선 ubuntu 이미지로 가정하며 수정이 필요할 수 있음)를 사용할 수 있습니다.
    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은 ubuntu 이미지에 미리 설치됩니다.
    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 CI에서 실패로 표시하기 위해 변수를 사용하여 종료합니다.
    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 # Get variables from base.

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

lxc delete -f "$CONTAINER_ID"