GitHub Actions에서 마이그레이션하기

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

만일 GitHub Actions에서 GitLab CI/CD로 마이그레이션한다면, GitHub Action 워크플로우를 복제하고 개선하는 CI/CD 파이프라인을 생성할 수 있습니다.

주요 유사점과 차이점

GitHub Actions과 GitLab CI/CD는 모두 코드를 빌드, 테스트 및 배포 자동화하기 위한 파이프라인을 생성하는 데 사용됩니다. 이 두 가지는 다음과 같은 유사성을 공유합니다.

  • CI/CD 기능은 프로젝트 저장소에 저장된 코드에 직접 액세스합니다.
  • YAML로 작성된 파이프라인 구성은 프로젝트 저장소에 저장됩니다.
  • 파이프라인은 구성 가능하며 다른 단계에서 실행될 수 있습니다.
  • 작업은 각각 다른 컨테이너 이미지를 사용할 수 있습니다.

또한, 두 가지 사이에 중요한 차이점이 있습니다.

  • GitHub은 3rd-party actions를 다운로드하는 마켓플레이스를 보유하고 있으며, 이는 추가 지원이나 라이선스가 필요할 수 있습니다.
  • Self-managed GitLab 인스턴스는 수평 및 수직 확장을 지원하며, GitHub Enterprise Server는 수직 확장만 지원합니다.
  • GitLab은 모든 기능을 내부에서 유지 및 지원하며, 일부 3rd-party 통합은 템플릿을 통해 접근할 수 있습니다.
  • GitLab은 내장된 컨테이너 레지스트리를 제공합니다.
  • GitLab은 네이티브 Kubernetes 배포를 지원합니다.
  • GitLab은 세분화된 보안 정책을 제공합니다.

기능 및 개념 비교

많은 GitHub 기능과 개념들은 동일한 기능을 제공하는 GitLab의 상응품을 가지고 있습니다.

구성 파일

GitHub Actions는 workflow YAML 파일로 구성될 수 있습니다. GitLab CI/CD는 기본적으로 .gitlab-ci.yml YAML 파일을 사용합니다.

예를 들어, GitHub Actions의 workflow 파일에서:

on: [push]
jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Hello World"

상응하는 GitLab CI/CD의 .gitlab-ci.yml 파일은:

stages:
  - hello

hello:
  stage: hello
  script:
    - echo "Hello World"

GitHub Actions 워크플로우 구문

GitHub Actions 구성은 특정 키워드를 사용하여 workflow YAML 파일에 정의됩니다. GitLab CI/CD는 비슷한 기능을 가지며 보통 YAML 키워드를 사용하여 구성됩니다.

GitHub GitLab 설명
env variables env는 워크플로우, 작업 또는 단계에서 정의된 변수를 정의합니다. GitLab은 CI/CD 변수를 글로벌 또는 작업 수준에서 정의하는 데 variables을 사용합니다. 변수는 UI에서도 추가할 수 있습니다.
jobs stages jobs는 워크플로우에서 실행되는 모든 작업을 그룹화합니다. GitLab은 작업을 그룹화하기 위해 stages를 사용합니다.
on 해당 없음 on은 워크플로우가 언제 트리거되는지를 정의합니다. GitLab은 Git과 긴밀하게 통합되어 있으므로 트리거를 위한 SCM 폴링 옵션이 필요하지 않지만 필요한 경우 각 작업별로 구성할 수 있습니다.
run 해당 없음 작업에서 실행할 명령입니다. GitLab은 각 명령을 실행할 때마다 script 키워드 아래의 YAML 배열을 사용합니다.
runs-on tags runs-on은 작업이 실행되어야 하는 GitHub 러너를 정의합니다. GitLab은 tags를 사용하여 러너를 선택합니다.
steps script steps는 작업에서 실행되는 모든 단계를 그룹화합니다. GitLab은 작업에서 실행되는 모든 명령을 그룹화하기 위해 script를 사용합니다.
uses include usesstep에 추가해야 하는 GitHub Action을 정의합니다. GitLab은 다른 파일에서 작업에 구성을 추가하기 위해 include를 사용합니다.

공통 구성

이 섹션에서는 GitHub Actions에서 GitLab CI/CD로 어떻게 변환할 수 있는 일반적으로 사용되는 CI/CD 구성을 살펴봅니다.

GitHub Action 워크플로우는 특정 이벤트(예: 새 커밋 푸시) 발생 시 트리거되는 자동화된 CI/CD 작업을 생성합니다. GitHub Action 워크플로우는 저장소 루트 디렉토리에 있는 .github/workflows 디렉토리에 정의된 YAML 파일입니다. GitLab 상응품은 저장소 루트 디렉토리에 위치한 .gitlab-ci.yml 구성 파일입니다.

작업

작업은 특정 결과를 얻기 위해 일련의 명령을 순차적으로 실행하는 명령어 집합입니다. 예를 들어, 이 GitHub Actions workflow는 컨테이너를 빌드한 다음 프로덕션으로 배포합니다. deploy 작업은 build 작업이 성공해야 하며 사용자의 커밋 대상 브랜치가 staging이어야 합니다.

on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    container: golang:alpine
    steps:
      - run: apk update
      - run: go build -o bin/hello
      - uses: actions/upload-artifact@v3
        with:
          name: hello
          path: bin/hello
          retention-days: 7
  deploy:
    if: contains( github.ref, 'staging')
    runs-on: ubuntu-latest
    container: golang:alpine
    steps:
      - uses: actions/download-artifact@v3
        with:
          name: hello
      - run: echo "Deploying to Staging"
      - run: scp bin/hello remoteuser@remotehost:/remote/directory

상응하는 GitLab CI/CD .gitlab-ci.yml 파일은:

default:
  image: golang:alpine

stages:
  - build
  - deploy

build-job:
  stage: build
  script:
    - apk update
    - go build -o bin/hello
  artifacts:
    paths:
      - bin/hello
    expire_in: 1 week

deploy-job:
  stage: deploy
  script:
    - echo "Deploying to Staging"
    - scp bin/hello remoteuser@remotehost:/remote/directory
  rules:
    - if: $CI_COMMIT_BRANCH == 'staging'
병렬

GitHub와 GitLab 모두 기본적으로 작업을 병렬로 실행합니다.

예를 들어, GitHub Actions의 workflow 파일에서:

on: [push]
jobs:
  python-version:
    runs-on: ubuntu-latest
    container: python:latest
    steps:
      - run: python --version
  java-version:
    if: contains( github.ref, 'staging')
    runs-on: ubuntu-latest
    container: openjdk:latest
    steps:
      - run: java -version

이 예제는 서로 다른 컨테이너 이미지를 사용하여 Python 작업과 Java 작업을 병렬로 실행합니다. Java 작업은 staging 브랜치가 변경될 때에만 실행됩니다.

동일한 작업을 수행하는 GitLab CI/CD .gitlab-ci.yml 파일의 내용은 다음과 같을 것입니다.

python-version:
  image: python:latest
  script:
    - python --version

java-version:
  image: openjdk:latest
  rules:
    - if: $CI_COMMIT_BRANCH == 'staging'
  script:
    - java -version

이 경우에는 작업을 병렬로 실행하기 위해서 추가 구성이 필요하지 않습니다. 기본적으로 각각의 작업은 병렬로 실행되며, 충분한 러너가 있다면 각각 다른 러너 상에서 실행됩니다. Java 작업은 staging 브랜치가 변경될 때만 실행되도록 설정되어 있습니다.

행렬

GitLab과 GitHub 모두 하나의 파이프라인에서 하나의 작업을 여러 번 병렬로 실행하고 각 작업의 인스턴스마다 다른 변수 값을 사용하는 행렬을 사용할 수 있습니다.

예를 들어, GitHub Actions의 workflow 파일에서:

on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Building $PLATFORM for $ARCH"
    strategy:
      matrix:
        platform: [linux, mac, windows]
        arch: [x64, x86]
  test:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Testing $PLATFORM for $ARCH"
    strategy:
      matrix:
        platform: [linux, mac, windows]
        arch: [x64, x86]
  deploy:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Deploying $PLATFORM for $ARCH"
    strategy:
      matrix:
        platform: [linux, mac, windows]
        arch: [x64, x86]

동일한 작업을 수행하는 GitLab CI/CD .gitlab-ci.yml 파일의 내용은 다음과 같을 것입니다.

stages:
  - build
  - test
  - deploy

.parallel-hidden-job:
  parallel:
    matrix:
      - PLATFORM: [linux, mac, windows]
        ARCH: [x64, x86]

build-job:
  extends: .parallel-hidden-job
  stage: build
  script:
    - echo "Building $PLATFORM for $ARCH"

test-job:
  extends: .parallel-hidden-job
  stage: test
  script:
    - echo "Testing $PLATFORM for $ARCH"

deploy-job:
  extends: .parallel-hidden-job
  stage: deploy
  script:
    - echo "Deploying $PLATFORM for $ARCH"

트리거

GitHub Actions에서는 워크플로우에 대한 트리거를 추가해야 합니다. GitLab은 Git과 긴밀하게 통합되어 있으므로 트리거의 SCM 폴링 옵션이 필요하지 않지만 필요한 경우 작업별로 구성할 수 있습니다.

GitHub Actions 구성 예시:

on:
  push:
    branches:
      - main

이에 대한 GitLab CI/CD 구성은 다음과 같을 것입니다.

rules:
  - if: '$CI_COMMIT_BRANCH == main'

파이프라인은 크론 구문을 사용하여 예약될 수도 있습니다.

컨테이너 이미지

GitLab을 사용하면 image 키워드를 사용하여 별도로 격리된 Docker 컨테이너에서 CI/CD 작업을 실행할 수 있습니다.

예를 들어, GitHub Actions의 workflow 파일에서:

jobs:
  update:
    runs-on: ubuntu-latest
    container: alpine:latest
    steps:
      - run: apk update

이 예제에서는 apk update 명령이 alpine:latest 컨테이너에서 실행됩니다.

동일한 작업을 수행하는 GitLab CI/CD .gitlab-ci.yml 파일의 내용은 다음과 같을 것입니다.

update-job:
  image: alpine:latest
  script:
    - apk update

GitLab은 각 프로젝트에 컨테이너 레지스트리를 제공하여 컨테이너 이미지를 호스팅합니다. 컨테이너 이미지는 GitLab CI/CD 파이프라인에서 직접 빌드하고 저장할 수 있습니다.

예를 들어:

stages:
  - build

build-image:
  stage: build
  variables:
    IMAGE: $CI_REGISTRY_IMAGE/$CI_COMMIT_REF_SLUG:$CI_COMMIT_SHA
  before_script:
    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
  script:
    - docker build -t $IMAGE .
    - docker push $IMAGE

변수

GitLab에서는 실행 시간에 다른 CI/CD 변수를 정의하기 위해 variables 키워드를 사용합니다. 파이프라인에서 구성 데이터를 재사용해야 할 때 변수를 정의합니다. 변수를 전역적으로 또는 작업별로 정의할 수 있습니다.

예를 들어, GitHub Actions의 workflow 파일에서:

env:
  NAME: "fern"

jobs:
  english:
    runs-on: ubuntu-latest
    env:
      Greeting: "hello"
    steps:
      - run: echo "$GREETING $NAME"
  spanish:
    runs-on: ubuntu-latest
    env:
      Greeting: "hola"
    steps:
      - run: echo "$GREETING $NAME"

이 예제에서 변수는 작업에 대해 다른 출력을 제공합니다.

동일한 작업을 수행하는 GitLab CI/CD .gitlab-ci.yml 파일의 내용은 다음과 같을 것입니다.

default:
  image: ubuntu-latest

variables:
  NAME: "fern"

english:
  variables:
    GREETING: "hello"
  script:
    - echo "$GREETING $NAME"

spanish:
  variables:
    GREETING: "hola"
  script:
    - echo "$GREETING $NAME"

변수는 GitLab UI를 통해 설정될 수 있으며, CI/CD 설정에서 보호하거나 마스킹할 수 있습니다. 마스킹된 변수는 작업 로그에서 숨겨지며, 보호된 변수는 보호된 브랜치나 태그에 대한 파이프라인에서만 액세스할 수 있습니다.

예를 들어, GitHub Actions의 workflow 파일에서:

jobs:
  login:
    runs-on: ubuntu-latest
    env:
      AWS_ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY }}
    steps:
      - run: my-login-script.sh "$AWS_ACCESS_KEY"

만약 AWS_ACCESS_KEY 변수가 GitLab 프로젝트 설정에 정의된 경우, 해당하는 GitLab CI/CD .gitlab-ci.yml 파일은 다음과 같을 것입니다.

login:
  script:
    - my-login-script.sh $AWS_ACCESS_KEY

또한, GitHub ActionsGitLab CI/CD에는 파이프라인 및 저장소에 관련된 데이터를 포함하는 내장 변수가 제공됩니다.

조건부문

새로운 파이프라인이 시작되면, GitLab은 파이프라인 구성을 확인하여 해당 파이프라인에서 실행해야 하는 작업을 결정합니다. rules 키워드를 사용하여 변수의 상태나 파이프라인 유형과 같은 조건에 따라 작업을 구성할 수 있습니다.

예를 들어, GitHub Actions workflow 파일에서:

jobs:
  deploy_staging:
    if: contains( github.ref, 'staging')
    runs-on: ubuntu-latest
    steps:
      - run: echo "스테이징 서버에 배포"

해당하는 GitLab CI/CD .gitlab-ci.yml 파일은 다음과 같을 것입니다:

deploy_staging:
  stage: deploy
  script:
    - echo "스테이징 서버에 배포"
  rules:
    - if: '$CI_COMMIT_BRANCH == staging'

러너

러너는 작업을 실행하는 서비스입니다. GitLab.com을 사용하는 경우, 단독으로 러너를 프로비저닝하지 않고도 인스턴스 러너 플리트를 사용할 수 있습니다.

러너에 대한 주요 세부 정보는 다음과 같습니다: - 러너는 인스턴스, 그룹 또는 특정 프로젝트에 걸쳐 구성될 수 있습니다. - 더 정교한 제어를 위해 tags 키워드를 사용하고 특정 작업에 러너를 연결할 수 있습니다. 예를 들어 전용, 강력한 또는 특정 하드웨어가 필요한 작업에 대해 태그를 사용할 수 있습니다. - GitLab은 러너의 자동 스케일링을 제공합니다. 필요할 때만 러너를 프로비저닝하고 필요하지 않을 때는 축소하는 자동 스케일링을 사용할 수 있습니다.

예를 들어, GitHub Actions workflow 파일에서:

linux_job:
  runs-on: ubuntu-latest
  steps:
    - run: echo "안녕하세요, $USER"

windows_job:
  runs-on: windows-latest
  steps:
    - run: echo "안녕하세요, %USERNAME%"

해당하는 GitLab CI/CD .gitlab-ci.yml 파일은 다음과 같을 것입니다:

linux_job:
  stage: build
  tags:
    - linux-runners
  script:
    - echo "안녕하세요, $USER"

windows_job:
  stage: build
  tags:
    - windows-runners
  script:
    - echo "안녕하세요, %USERNAME%"

아티팩트

GitLab에서는 artifacts 키워드를 사용하여 작업이 완료될 때 저장할 아티팩트 세트를 정의할 수 있습니다. Artifacts는 이후 작업에서 사용할 수 있는 파일입니다.

예를 들어, GitHub Actions workflow 파일에서:

on: [push]
jobs:
  generate_cat:
    steps:
      - run: touch cat.txt
      - run: echo "meow" > cat.txt
      - uses: actions/upload-artifact@v3
        with:
          name: cat
          path: cat.txt
          retention-days: 7
  use_cat:
    needs: [generate_cat]
    steps:
      - uses: actions/download-artifact@v3
        with:
          name: cat
      - run: cat cat.txt

해당하는 GitLab CI/CD .gitlab-ci.yml 파일은 다음과 같을 것입니다:

stage:
  - generate
  - use

generate_cat:
  stage: generate
  script:
    - touch cat.txt
    - echo "meow" > cat.txt
  artifacts:
    paths:
      - cat.txt
    expire_in: 1 week

use_cat:
  stage: use
  script:
    - cat cat.txt

캐싱

작업이 하나 이상의 파일을 다운로드하고 나중에 더 빠른 액세스를 위해 이를 저장할 때 캐시가 생성됩니다. 동일한 캐시를 사용하는 이후 작업들은 파일을 다시 다운로드할 필요가 없으므로 더 빠르게 실행됩니다. 캐시는 러너에 저장되며 분산 캐시가 사용 가능한 경우 S3에 업로드됩니다.

예를 들어, GitHub Actions workflow 파일에서:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - run: echo "이 작업은 캐시를 사용합니다."
    - uses: actions/cache@v3
      with:
        path: binaries/
        key: binaries-cache-$CI_COMMIT_REF_SLUG

해당하는 GitLab CI/CD .gitlab-ci.yml 파일은 다음과 같을 것입니다:

cache-job:
  script:
    - echo "이 작업은 캐시를 사용합니다."
  cache:
    key: binaries-cache-$CI_COMMIT_REF_SLUG
    paths:
      - binaries/

템플릿

GitHub에서는 자주 반복되는 복잡한 작업 세트를 저장하고 CI/CD 파이프라인을 다시 정의하지 않고도 재사용할 수 있게 하는 것을 의미하는 액션이 있습니다. GitLab에서는 액션에 해당하는 것은 include 키워드이며, 이를 사용하여 GitLab에 내장된 다른 파일 또는 템플릿 파일에서 CI/CD 파이프라인을 추가할 수 있습니다.

GitHub Action에서의 예제 구성:

- uses: hashicorp/setup-terraform@v2.0.3

해당하는 GitLab CI/CD 구성은 다음과 같을 것입니다:

include:
  - template: Terraform.gitlab-ci.yml

이러한 예시에서 setup-terraform GitHub 액션과 Terraform.gitlab-ci.yml GitLab 템플릿은 정확히 일치하지 않습니다. 이 두 가지 예시는 복잡한 구성을 재사용하는 방법을 보여주기 위한 것입니다.

보안 스캔 기능

GitLab은 보안 스캐너를 여러 가지 제공하여 SLDC의 모든 부분에서 취약점을 감지할 수 있습니다. 이러한 기능을 GitLab CI/CD 파이프라인에 추가하여 사용할 수 있습니다.

예를 들어 SAST 스캐닝을 파이프라인에 추가하려면, 다음을 .gitlab-ci.yml에 추가하세요:

include:
  - template: Jobs/SAST.gitlab-ci.yml

보안 스캐너의 경우 CI/CD 변수를 사용하여 스캐너의 동작을 사용자화할 수 있습니다.

시크릿 관리

“시크릿” 또는 민감 정보는 CI/CD 워크플로에서 필요한 민감한 정보나 자격 증명입니다. 시크릿을 사용하여 보호된 리소스나 도구, 애플리케이션, 컨테이너, 클라우드 네이티브 환경에서 민감한 정보를 해제할 수 있습니다.

GitLab에서 시크릿 관리를 위해 외부 서비스에 대한 지원 통합 중 하나를 사용할 수 있습니다. 이러한 서비스는 GitLab 프로젝트 외부에 안전하게 시크릿을 저장하지만, 해당 서비스의 구독이 필요합니다: - HashiCorp Vault. - Azure Key Vault.

또한 GitLab은 다른 OIDC를 지원하는 서드파티 서비스를 위한 OIDC 인증을 지원합니다.

또한, CI/CD 변수에 시크릿을 저장함으로써 작업에서 자격 증명을 사용할 수 있습니다. 그러나 일반 텍스트로 저장된 시크릿은 실수로 노출될 수 있습니다. 민감한 정보를 항상 마스크된 상태로 유지하고 보호된 상태로 유지해야 합니다.

또한, 프로젝트, 그룹 또는 인스턴스 설정에서만 민감한 정보를 공개 저장하지 않아야 합니다. CI/CD 변수의 안전성을 높이기 위해 보안 지침을 확인하세요.

이주(이전 작업 및 계획)

조직들의 신속한 마이그레이션을 관찰한 후에 다음에 해당하는 목록이 작성되었습니다.

이주 계획 작성

마이그레이션을 시작하기 전에 이주 계획을 만들어 마이그레이션을 위한 준비를 하세요.

전제 조건

마이그레이션 작업을 진행하기 전에, 먼저 다음을 수행해야 합니다:

  1. GitLab을 숙지하세요.
  2. GitLab을 설치하고 구성하세요.
  3. GitLab 인스턴스를 테스트하세요.
    • 런너가 사용 가능한지 확인하세요. GitLab.com의 공유 런너를 사용하거나 새 런너를 설치하여 확인하세요.

마이그레이션 단계

  1. GitHub에서 GitLab으로 프로젝트 마이그레이션:
  2. 각 프로젝트에 .gitlab-ci.yml를 만드세요.
  3. GitHub Actions 작업을 GitLab CI/CD 작업으로 마이그레이션하고, 이들을 합병 요청에 직접 결과를 표시하도록 구성하세요.
  4. 클라우드 배포 템플릿, 환경, 그리고 Kubernetes용 GitLab 에이전트를 사용하여 배포 작업 마이그레이션하세요.
  5. 다른 프로젝트 간에 재사용할 수 있는 CI/CD 구성이 있는지 확인한 후, CI/CD 템플릿을 생성하고 공유하세요.
  6. 파이프라인 효율성 문서를 확인하여 GitLab CI/CD 파이프라인을 더 빠르고 효율적으로 만드는 방법에 대해 알아보세요.

추가 자료

여기서 답변되지 않은 질문이 있다면, GitLab 커뮤니티 포럼을 참고할 수 있습니다.