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 서버에서 테스트하지 않아도 로컬 터미널에서 모든 명령을 테스트할 수 있습니다.

Ruby가 설치되지 않은 경우, Debian 호환 Linux에서 다음을 수행할 수 있습니다: 

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 서버에 HEROKU_STAGING_API_KEY 보안 변수에 저장된 API 키를 사용하여 배포합니다.

다른 공급업체를 사용하려면 지원되는 공급업체 목록을 확인하세요.

Docker에서 Dpl 사용하기

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

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는 시스템에 Ruby 런타임을 설치합니다. 위 예는 모든 Debian 호환 시스템에 대해 유효합니다.

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

개발 워크플로우에서 스테이징(개발) 및 프로덕션 환경을 갖는 것은 매우 일반적입니다.

다음 예를 살펴보겠습니다: 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. 왼쪽 사이드바에서 검색 또는 이동하여 프로젝트를 찾습니다.
  2. 설정 > CI/CD를 선택합니다.
  3. 변수를 확장합니다.

프로젝트 설정에서 정의된 변수는 빌드 스크립트와 함께 러너로 전송됩니다. 안전한 변수는 저장소 외부에 저장됩니다. 비밀을 .gitlab-ci.yml 파일에 저장하지 마십시오. 또한 시크릿 값은 작업 로그에서 숨겨져야 합니다.

추가한 변수는 변수 이름을 $로 접두사 붙이면(Windows 러너가 아닌 경우) 또는 %로 접두사 붙이면(Windows Batch 러너의 경우) 액세스할 수 있습니다.

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

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