배포 후 마이그레이션

배포 후 마이그레이션은 선택적으로 실행될 수 있는 일반적인 Rails 마이그레이션입니다. 기본적으로 이러한 마이그레이션은 기타 마이그레이션과 함께 실행됩니다. 이러한 마이그레이션을 건너뛰려면 rake db:migrate를 실행할 때 환경 변수 SKIP_POST_DEPLOYMENT_MIGRATIONS를 비어 있지 않은 값으로 설정해야 합니다.

예를 들어, 다음 명령은 모든 마이그레이션을 실행하고 배포 후 마이그레이션도 실행합니다:

bundle exec rake db:migrate

그러나 다음 명령은 배포 후 마이그레이션을 건너뜁니다:

SKIP_POST_DEPLOYMENT_MIGRATIONS=true bundle exec rake db:migrate

GitLab.com의 경우, 릴리즈 매니저의 재량으로 배포 후 마이그레이션 파이프라인을 통해 이러한 마이그레이션은 매일 실행됩니다.

배포 통합

예를 들어, GitLab의 새 버전을 배포한 후에 배포 후 마이그레이션을 실행하고 싶다고 가정해봅시다. 이를 위해 일반적으로 chef-client 명령을 사용한다고 가정해봅시다. 이 기능을 사용하려면 다음과 같이 명령을 실행해야 합니다:

SKIP_POST_DEPLOYMENT_MIGRATIONS=true sudo chef-client

모든 서버가 업데이트된 후에는 환경 변수 없이 단일 서버에서 chef-client를 다시 실행할 수 있습니다.

다른 배포 기술에 대해서도 유사한 프로세스를 따릅니다: 환경 변수를 설정한 상태로 배포한 후에는 이를 해제한 상태로 단일 서버를 다시 배포합니다.

마이그레이션 생성

배포 후 마이그레이션을 생성하기 위해 다음 Rails 생성기를 사용할 수 있습니다:

bundle exec rails g post_deployment_migration migration_name_here

이렇게 하면 db/post_migrate에 마이그레이션 파일이 생성됩니다. 이러한 마이그레이션은 일반적인 Rails 마이그레이션과 정확히 동작합니다.

사용 사례

배포 후 마이그레이션을 사용하여 기존 GitLab 버전이 의존하는 상태를 변이시키는 마이그레이션을 수행할 수 있습니다. 예를 들어, 테이블에서 열을 제거하려고 한다고 가정해봅시다. 이 작업은 GitLab 인스턴스가 실행 중일 때에 해당 열이 존재해야 하므로 다운타임이 필요합니다. 이러한 경우 보통 다음 단계를 따릅니다:

  1. GitLab 인스턴스 중지
  2. 열을 제거하는 마이그레이션 실행
  3. GitLab 인스턴스 다시 시작

하지만 배포 후 마이그레이션을 사용하면 다음 단계를 따를 수 있습니다:

  1. 열을 더 이상 필요로 하지 않는 새 버전이 배포된 상태에서 새 버전의 GitLab을 배포
  2. 환경 변수를 설정하지 않고 rake db:migrate 다시 실행

이렇게 하면 새 버전이(더 이상 해당 열에 의존하지 않는) 배포된 후에 마이그레이션이 진행되므로 다운타임이 필요하지 않습니다.

다른 유용한 사용 사례로는 다음과 같은 경우가 있습니다:

  • GitLab에서 버그로 인해 생성된 데이터 정리
  • 테이블 제거
  • 작업을 하나의 Sidekiq 대기열에서 다른 대기열로 마이그레이션