Dpl을 배포 도구로 사용하기

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

Dpl (D-P-L로 발음)은 Travis CI에서 개발 및 사용되는 연속적인 배포를 위한 배포 도구이지만 GitLab CI/CD에서도 사용할 수 있습니다.

Prerequisite

Dpl을 사용하려면 적어도 Ruby 1.9.3 이상 버전 및 gem을 설치할 수 있는 능력이 필요합니다.

기본 사용법

Dpl은 다음과 같이 모든 머신에 설치할 수 있습니다. 

gem install dpl

이를 통해 CI 서버에서 테스트하는 대신 로컬 터미널에서 모든 명령을 테스트할 수 있습니다.

루비가 설치되어 있지 않은 경우 데비안 호환 리눅스에서 다음을 수행할 수 있습니다. 

apt-get update
apt-get install ruby-dev

Dpl은 Heroku, Cloud Foundry, AWS/S3 등 많은 서비스를 지원하며, 해당 서비스를 사용하려면 공급업체를 정의하고 공급업체에서 필요로 하는 추가 매개변수를 지정해야 합니다.

예를 들어, Heroku에 애플리케이션을 배포하려면 공급업체를 heroku, api_key 및 app을 지정해야 합니다. 모든 가능한 매개변수는 Heroku API 섹션에서 찾을 수 있습니다. 

staging:
  stage: deploy
  script:
    - gem install dpl
    - dpl heroku api --app=my-app-staging --api_key=$HEROKU_STAGING_API_KEY
  environment: staging

위 예에서는 Dpl을 사용하여 my-app-staging을 Heroku 서버에 배포하며, API 키는 HEROKU_STAGING_API_KEY 안전 변수에 저장됩니다.

다른 공급업체를 사용하려면 지원되는 공급업체 디렉터리을 확인하세요.

Docker와 함께 Dpl 사용하기

대부분의 경우, GitLab Runner를 구성하여 서버의 쉘 명령을 사용합니다. 이는 모든 명령이 로컬 사용자 (예: gitlab_runner 또는 gitlab_ci_multi_runner) 컨텍스트에서 실행된다는 것을 의미합니다. 또한 Docker 컨테이너에서는 아마도 루비 런타임이 설치되어 있지 않을 가능성이 높습니다. 따라서 이를 설치해야 합니다. 

staging:
  stage: deploy
  script:
    - apt-get update -yq
    - apt-get install -y ruby-dev
    - gem install dpl
    - dpl heroku api --app=my-app-staging --api_key=$HEROKU_STAGING_API_KEY
  rules:
    - if: $CI_COMMIT_BRANCH == "main"
  environment: staging

첫 번째 줄인 apt-get update -yq는 사용 가능한 패키지 디렉터리을 업데이트하고, 두 번째 줄 apt-get install -y ruby-dev은 시스템에 루비 런타임을 설치합니다. 위 예제는 모든 데비안 호환 시스템에 유효합니다.

스테이징 및 프로덕션에서의 사용

개발 작업 흐름에서 스테이징(개발) 및 프로덕션 환경을 보유하는 것은 상당히 일반적입니다.

다음 예를 살펴보겠습니다. main 브랜치를 staging에, 모든 태그를 production 환경에 배포하려면 최종 .gitlab-ci.yml은 다음과 같습니다. 

staging:
  stage: deploy
  script:
    - gem install dpl
    - dpl heroku api --app=my-app-staging --api_key=$HEROKU_STAGING_API_KEY
  rules:
    - if: $CI_COMMIT_BRANCH == "main"
  environment: staging

production:
  stage: deploy
  script:
    - gem install dpl
    - dpl heroku api --app=my-app-production --api_key=$HEROKU_PRODUCTION_API_KEY
  rules:
    - if: $CI_COMMIT_TAG
  environment: production

다양한 이벤트에서 실행되는 두 배포 작업을 만들었습니다.

  • staging: main 브랜치로 푸시된 모든 커밋에 대해 실행
  • production: 모든 푸시된 태그에 대해 실행

또한 두 안전한 변수를 사용했습니다.

  • HEROKU_STAGING_API_KEY: 스테이징 앱을 배포하는 데 사용되는 Heroku API 키
  • HEROKU_PRODUCTION_API_KEY: 프로덕션 앱을 배포하는 데 사용되는 Heroku API 키

API 키 저장

API 키를 안전 변수로 저장하려면:

  1. 왼쪽 사이드 바에서 프로젝트를 찾아 설정 > CI/CD > 변수를 선택합니다.

프로젝트 설정에서 정의한 변수는 빌드 스크립트와 함께 러너에게 전송됩니다. 안전한 변수는 리포지터리 외부에 저장됩니다. 비밀을 .gitlab-ci.yml 파일에 저장하지 말아야 합니다. 또한 시크릿 값이 작업 로그에서 숨겨져야 하는 것도 중요합니다.

추가한 변수는 다음과 같이 접근할 수 있습니다(Windows 러너가 아닌 경우):

  • $VARIABLE: Windows 러너가 아닌 경우 사용
  • %VARIABLE%: Windows Batch 러너의 경우 사용

CI/CD 변수에 대해 더 알아보세요.