Custom executor에서 libvirt 사용하기

요약

libvirt를 사용하면 Custom executor 드라이버가 실행하는 모든 작업에 대해 새 디스크와 VM을 생성하고, 작업 완료 후 디스크와 VM을 삭제합니다. 이 문서는 libvirt 설정 방법은 다루지 않습니다.

libvirt를 사용하면 Custom executor 드라이버가 실행하는 모든 작업에 대해 새 디스크와 VM을 생성하고, 작업 완료 후 디스크와 VM을 삭제합니다.

이 문서는 libvirt 설정 방법은 다루지 않습니다. 해당 내용은 범위를 벗어나기 때문입니다. 다만, 이 드라이버는 GCP Nested Virtualization을 사용하여 테스트되었으며, 여기에는 브리지 네트워킹이 포함된 libvirt 설정 방법에 대한 세부 정보도 포함되어 있습니다. 이 예제는 libvirt 설치 시 제공되는 default 네트워크를 사용하므로 해당 네트워크가 실행 중인지 확인하세요.

이 드라이버는 각 VM이 고유한 IP 주소를 가져야 GitLab Runner가 SSH로 접속하여 명령을 실행할 수 있으므로 브리지 네트워킹이 필요합니다. SSH 키는 다음 명령어를 사용하여 생성할 수 있습니다.

매 빌드마다 의존성을 다운로드하지 않기 위해 기본 디스크 VM 이미지를 생성합니다. 다음 예제에서는 virt-builder를 사용하여 디스크 VM 이미지를 생성합니다.

virt-builder debian-12 \
    --size 8G \
    --output /var/lib/libvirt/images/gitlab-runner-base.qcow2 \
    --format qcow2 \
    --hostname gitlab-runner-bookworm \
    --network \
    --install curl \
    --run-command 'curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | bash' \
    --run-command 'curl -s "https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh" | bash' \
    --run-command 'useradd -m -p "" gitlab-runner -s /bin/bash' \
    --install gitlab-runner,git,git-lfs,openssh-server \
    --run-command "git lfs install --skip-repo" \
    --ssh-inject gitlab-runner:file:/root/.ssh/id_rsa.pub \
    --run-command "echo 'gitlab-runner ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers" \
    --run-command "sed -E 's/GRUB_CMDLINE_LINUX=\"\"/GRUB_CMDLINE_LINUX=\"net.ifnames=0 biosdevname=0\"/' -i /etc/default/grub" \
    --run-command "grub-mkconfig -o /boot/grub/grub.cfg" \
    --run-command "echo 'auto eth0' >> /etc/network/interfaces" \
    --run-command "echo 'allow-hotplug eth0' >> /etc/network/interfaces" \
    --run-command "echo 'iface eth0 inet dhcp' >> /etc/network/interfaces"

위 명령어는 앞서 명시된 모든 필수 소프트웨어를 설치합니다.

virt-builder는 루트 비밀번호를 자동으로 설정하며 마지막에 출력됩니다. 직접 비밀번호를 지정하려면 --root-password password:$SOME_PASSWORD를 전달하세요.

구성#

다음은 libvirt를 위한 GitLab Runner 구성 예제입니다:

concurrent = 1
check_interval = 0

[session_server]
  session_timeout = 1800

[[runners]]
  name = "libvirt-driver"
  url = "https://gitlab.com/"
  token = "xxxxx"
  executor = "custom"
  builds_dir = "/home/gitlab-runner/builds"
  cache_dir = "/home/gitlab-runner/cache"
  [runners.custom_build_dir]
  [runners.cache]
    [runners.cache.s3]
    [runners.cache.gcs]
  [runners.custom]
    prepare_exec = "/opt/libvirt-driver/prepare.sh" # VM을 생성하는 bash 스크립트 경로.
    run_exec = "/opt/libvirt-driver/run.sh" # SSH를 통해 VM 내부에서 스크립트를 실행하는 bash 스크립트 경로.
    cleanup_exec = "/opt/libvirt-driver/cleanup.sh" # VM과 디스크를 삭제하는 bash 스크립트 경로.

Base#

각 단계(prepare, run, cleanup)는 아래의 base 스크립트를 사용하여 다른 스크립트에서 사용하는 변수를 생성합니다.

이 스크립트는 다른 스크립트와 동일한 디렉터리, 이 경우 /opt/libvirt-driver/에 위치해야 합니다.

#!/usr/bin/env bash

# /opt/libvirt-driver/base.sh

VM_IMAGES_PATH="/var/lib/libvirt/images"
BASE_VM_IMAGE="$VM_IMAGES_PATH/gitlab-runner-base.qcow2"
VM_ID="runner-$CUSTOM_ENV_CI_RUNNER_ID-project-$CUSTOM_ENV_CI_PROJECT_ID-concurrent-$CUSTOM_ENV_CI_CONCURRENT_PROJECT_ID-job-$CUSTOM_ENV_CI_JOB_ID"
VM_IMAGE="$VM_IMAGES_PATH/$VM_ID.qcow2"

_get_vm_ip() {
    virsh -q domifaddr "$VM_ID" | awk '{print $4}' | sed -E 's|/([0-9]+)?$||'
}

Prepare#

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

디스크를 새 경로에 복사합니다.
복사한 디스크에서 새 VM을 설치합니다.
VM이 IP를 획득할 때까지 대기합니다.
VM에서 SSH가 응답할 때까지 대기합니다.

#!/usr/bin/env bash

# /opt/libvirt-driver/prepare.sh

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

set -eo pipefail

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

# 작업에 사용할 기본 디스크 복사.
qemu-img create -f qcow2 -b "$BASE_VM_IMAGE" "$VM_IMAGE" -F qcow2

# VM 설치
# UEFI 모드로 VM을 부팅하려면 다음을 추가하세요: --boot uefi
virt-install \
    --name "$VM_ID" \
    --os-variant debian11 \
    --disk "$VM_IMAGE" \
    --import \
    --vcpus=2 \
    --ram=2048 \
    --network default \
    --graphics none \
    --noautoconsole

# VM이 IP를 획득할 때까지 대기
echo 'Waiting for VM to get IP'
for i in $(seq 1 300); do
    VM_IP=$(_get_vm_ip)

    if [ -n "$VM_IP" ]; then
        echo "VM got IP: $VM_IP"
        break
    fi

    if [ "$i" == "300" ]; then
        echo 'Waited 300 seconds for VM to start, exiting...'
        # GitLab Runner에 시스템 오류임을 알려
        # 재시도하도록 합니다.
        exit "$SYSTEM_FAILURE_EXIT_CODE"
    fi

    sleep 1s
done

# ssh가 사용 가능해질 때까지 대기
echo "Waiting for sshd to be available"
for i in $(seq 1 300); do
    if ssh -i /root/.ssh/id_rsa -o StrictHostKeyChecking=no gitlab-runner@$VM_IP >/dev/null 2>/dev/null; then
        break
    fi

    if [ "$i" == "300" ]; then
        echo 'Waited 300 seconds for sshd to start, exiting...'
        # GitLab Runner에 시스템 오류임을 알려
        # 재시도하도록 합니다.
        exit "$SYSTEM_FAILURE_EXIT_CODE"
    fi

    sleep 1s
done

Run#

GitLab Runner가 생성한 스크립트의 내용을 SSH를 통해 STDIN으로 VM에 전송하여 스크립트를 실행합니다.

#!/usr/bin/env bash

# /opt/libvirt-driver/run.sh

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

VM_IP=$(_get_vm_ip)

ssh -i /root/.ssh/id_rsa -o StrictHostKeyChecking=no gitlab-runner@$VM_IP /bin/bash < "${1}"
if [ $? -ne 0 ]; then
    # 변수를 사용하여 종료하면 GitLab CI에서
    # 빌드가 실패로 표시됩니다.
    exit "$BUILD_FAILURE_EXIT_CODE"
fi

Cleanup#

이 스크립트는 VM을 제거하고 디스크를 삭제합니다.

#!/usr/bin/env bash

# /opt/libvirt-driver/cleanup.sh

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

set -eo pipefail

# VM을 종료하고 300초 대기합니다.
for i in $(seq 1 300); do
  virsh destroy "$VM_ID" >/dev/null 2>&1
  if [[ "$(virsh domstate "$VM_ID" 2>/dev/null | tr '[:upper:]' '[:lower:]')" =~ shut\ off|destroyed|^$ ]]; then
      break
  fi
  if [ $i -eq 300 ]; then
     exit "$SYSTEM_FAILURE_EXIT_CODE"
  fi
  sleep 1
done

# VM 정의를 해제합니다.
virsh undefine "$VM_ID" || virsh undefine "$VM_ID" --nvram

# VM 디스크를 삭제합니다.
if [ -f "$VM_IMAGE" ]; then
    rm "$VM_IMAGE"
fi