더 최신 Auto Deploy 종속성으로 배포 업그레이드하기

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

Auto Deploy는 애플리케이션을 Kubernetes 클러스터에 배포하는 기능입니다. 여러 종속성으로 구성됩니다:

  • Auto Deploy 템플릿은 auto-deploy-image를 사용하는 일련의 파이프라인 작업과 스크립트입니다.
  • auto-deploy-image는 Kubernetes 클러스터와 통신하는 실행 가능한 이미지입니다.
  • auto-deploy-app 차트는 애플리케이션을 배포하기 위한 Helm 차트입니다.

auto-deploy-image와 auto-deploy-app 차트는 Semantic Versioning을 사용합니다. 기본적으로 Auto DevOps 프로젝트는 안정적이고 호환되지 않는 버전을 계속 사용합니다. 그러나 이러한 종속성은 GitLab의 주요 버전 릴리스에서 업그레이드될 수 있으며, 이는 배포를 업그레이드해야 하는 파편적인 변화를 요구할 수 있습니다.

이 안내서에서는 최신이나 다른 주요 버전의 Auto Deploy 종속성으로 배포를 업그레이드하는 방법을 설명합니다.

종속성 버전 확인

현재 버전을 확인하는 프로세스는 사용 중인 템플릿에 따라 다릅니다. 먼저 사용 중인 템플릿을 확인하세요:

사용 중인 템플릿을 알고 있다면:

  • auto-deploy-image 버전이 템플릿에 있습니다 (예: auto-deploy-image:v1.0.3).
  • auto-deploy-app 차트 버전은 auto-deploy-image 저장소 에 있습니다 (예: version: 1.0.3).

호환성

다음 표는 GitLab과 Auto Deploy 종속성 간의 버전 호환성을 설명합니다:

GitLab 버전 auto-deploy-image 버전 노트
v10.0에서 v14.0 v0.1.0에서 v2.0.0 v0 및 v1 auto-deploy-image은 하위 호환됩니다.
v13.4 이상 v2.0.0 이상 v2 auto-deploy-image에는 파손을 일으키는 변경 사항이 포함되어 있으며, 업그레이드 가이드에 설명되어 있습니다.

현재 안정 버전의 auto-deploy-image를 Auto Deploy 안정적인 템플릿 에서 찾을 수 있습니다.

업그레이드 안내

Auto DevOps를 사용하는 프로젝트는 GitLab에서 관리하는 수정되지 않은 차트를 사용해야 합니다. 사용자 정의 차트는 지원되지 않습니다.

v1 auto-deploy-image로 배포 업그레이드

v1 차트는 v0 차트와 하위 호환되므로 구성 변경이 필요하지 않습니다.

v2 auto-deploy-image로 배포 업그레이드

v2 auto-deploy-image에는 여러 종속성 및 아키텍처 변경이 포함되어 있습니다. Auto DevOps 프로젝트에 v1 auto-deploy-image로 배포된 활성 환경이 있는 경우, 다음 업그레이드 안내를 진행하세요. 그렇지 않은 경우, 이 과정을 건너뛸 수 있습니다.

Kubernetes 1.16+

v2 auto-deploy-image는 Kubernetes 1.15 및 이전 버전을 더 이상 지원하지 않습니다. Kubernetes 클러스터를 업그레이드해아하는 경우, 클라우드 제공업체의 지침을 따르세요. 다음은 GKE에서의 예시입니다.

Helm v3

auto-deploy-image는 릴리스를 조작하기 위해 Helm 이진 파일을 사용합니다. 이전에 auto-deploy-image는 Tiller를 클러스터에서 사용한 Helm v2를 사용했습니다. v2 auto-deploy-image에서는 더 이상 Tiller가 필요하지 않은 Helm v3를 사용합니다.

Auto DevOps 프로젝트에 v1 auto-deploy-image로 배포된 활성 환경이 있는 경우 Helm v3을 사용하도록 v2로 업그레이드하려면 다음 단계를 수행하세요:

  1. Helm 2to3 마이그레이션 CI/CD 템플릿을 포함:

    • GitLab.com 또는 GitLab 14.0.1 이상의 경우 Auto DevOps에 이미 이 템플릿이 포함되어 있습니다.

    • 다른 GitLab 버전의 경우 .gitlab-ci.yml을 수정하여 다음 템플릿을 포함할 수 있습니다: 

      include:
  - template: Auto-DevOps.gitlab-ci.yml
  - remote: https://gitlab.com/gitlab-org/gitlab/-/raw/master/lib/gitlab/ci/templates/Jobs/Helm-2to3.gitlab-ci.yml

  2. 다음 CI/CD 변수를 설정하세요:

    • MIGRATE_HELM_2TO3를 true로 설정하세요. 이 변수가 없는 경우 마이그레이션 작업이 실행되지 않습니다.
    • AUTO_DEVOPS_FORCE_DEPLOY_V2를 1로 설정하세요.

    • 선택 사항: BACKUP_HELM2_RELEASES를 1로 설정하세요. 이 변수를 설정하면 마이그레이션 작업이 helm-2-release-backups라는 작업 artifact에 1 주일 동안 백업을 저장합니다. 준비가 되기 전에 실수로 Helm v2 릴리스를 삭제할 경우 이 백업을 사용하여 Kubernetes 매니페스트 파일에서 복원할 수 있습니다. 이는 공개 파이프라인인 경우에는 사용하지 마십시오. 이 artifact에는 비밀이 포함되어 있고 작업을 볼 수 있는 모든 사용자에게 표시됩니다.

      경고: 공개 파이프라인을 사용하지 마십시오. 이 artifact에는 비밀이 포함되어 있고 작업을 볼 수 있는 모든 사용자에게 표시됩니다.

  3. 파이프라인을 실행하고 <환경 이름>:helm-2to3:migrate 작업을 트리거하세요.
  4. 환경을 보통대로 배포하세요. 이 배포는 Helm v3를 사용합니다.
  5. 배포가 성공하면 <환경 이름>:helm-2to3:cleanup을 안전하게 실행할 수 있습니다. 이렇게 하면 네임스페이스에서 모든 Helm v2 릴리스 데이터가 삭제됩니다.
  6. MIGRATE_HELM_2TO3 CI/CD 변수를 제거하거나 false로 설정하세요. 환경 범위를 사용하여 한 번에 한 환경씩 수행할 수 있습니다.

In-Cluster PostgreSQL 채널 2

v2 auto-deploy-image는 레거시 인클러스터 PostgreSQL를 더 이상 지원하지 않습니다. Kubernetes 클러스터가 이에 의존하는 경우 데이터를 업그레이드 및 마이그레이션하세요(특정 버전의 auto-deploy 종속성 사용).

카나리아 배포 및 점진적 롤아웃을 위한 트래픽 라우팅 변경

Auto Deploy는 카나리아 배포 및 점진적 롤아웃과 같은 심화 배포 전략을 지원합니다.

이전에 auto-deploy-image는 안정적인 트랙과 불안정한 트랙 간의 트래픽을 레플리카 비율을 변경하여 균형을 유지하기 위해 하나의 서비스를 생성했습니다. v2 auto-deploy-image에서는 카나리아 인그레스를 사용하여 트래픽을 제어합니다.

자세한 내용은 v2 auto-deploy-app 차트 리소스 아키텍처를 참조하세요.

만약 Auto DevOps 프로젝트에 v1 auto-deploy-image로 배포된 production 환경에 활성 canary 또는 rollout 트랙 릴리스가 있는 경우 v2로 업그레이드하려면 다음 단계를 수행하세요:

  1. 프로젝트가 v1 auto-deploy-image를 사용하는지 확인. 그렇지 않은 경우 버전을 지정하세요.
  2. canary 또는 rollout 배포를 수행 중이라면 먼저 이를 production으로 프로모트하여 불안정한 트랙을 삭제하세요.
  3. 프로젝트가 v2 auto-deploy-image를 사용하는지 확인. 그렇지 않은 경우 버전을 지정하세요.
  4. GitLab CI/CD 설정에서 AUTO_DEVOPS_FORCE_DEPLOY_V2 CI/CD 변수를 true의 값으로 추가하세요.
  5. 새로운 파이프라인을 만들고 production 작업을 실행하여 v2 auto-deploy-app 차트로 리소스 아키텍처를 갱신하세요.
  6. AUTO_DEVOPS_FORCE_DEPLOY_V2 변수를 제거하세요.

특정 버전의 Auto Deploy 의존성 사용

특정 버전의 Auto Deploy 의존성을 사용하려면 원하는 버전의 auto-deploy-image 및 auto-deploy-app을 포함하는 이전 Auto Deploy 안정적인 템플릿을 지정하십시오.

예를 들어, 템플릿이 GitLab 13.3에 번들로 제공된 경우, .gitlab-ci.yml을 다음과 같이 변경하십시오: 

include:
  - template: Auto-DevOps.gitlab-ci.yml
  - remote: https://gitlab.com/gitlab-org/gitlab/-/raw/v13.3.0-ee/lib/gitlab/ci/templates/Jobs/Deploy.gitlab-ci.yml

또는 v13.12 Auto DevOps 템플릿 아카이브를 사용할 수 있습니다.

경고를 무시하고 배포 계속하기

새 차트 버전을 배포해도 안전하다고 확신한다면, AUTO_DEVOPS_FORCE_DEPLOY_V<주요-버전-번호> CI/CD 변수를 추가하여 배포를 계속하도록 할 수 있습니다.

예를 들어, 이전에 v0.17.0 차트를 사용했던 배포에 v2.0.0 차트를 배포하려면 AUTO_DEVOPS_FORCE_DEPLOY_V2를 추가하세요.

초기 채택자

최신 Beta 또는 불안정한 버전의 auto-deploy-image를 사용하려면 최신 Auto Deploy 템플릿을 .gitlab-ci.yml에 포함시키세요.

주의: Beta나 불안정한 auto-deploy-image를 사용하는 것은 환경에 재복구할 수 없는 손상을 일으킬 수 있습니다. 중요한 프로젝트나 환경에서는 테스트하지 마세요.

다음 안정적인 템플릿 업데이트는 GitLab v14.0에 계획되어 있습니다.

auto-deploy-app 차트의 리소스 아키텍처

v0 및 v1 차트 리소스 아키텍처

graph TD; subgraph gl-managed-app Z[Nginx Ingress] end Z[Nginx Ingress] --> A(Ingress); Z[Nginx Ingress] --> B(Ingress); subgraph stg namespace B[Ingress] --> H(...); end subgraph prd namespace A[Ingress] --> D(Service); D[Service] --> E(Deployment:Pods:app:stable); D[Service] --> F(Deployment:Pods:app:canary); D[Service] --> I(Deployment:Pods:app:rollout); E(Deployment:Pods:app:stable)---id1[(Pods:Postgres)] F(Deployment:Pods:app:canary)---id1[(Pods:Postgres)] I(Deployment:Pods:app:rollout)---id1[(Pods:Postgres)] end

v2 차트 리소스 아키텍처

graph TD; subgraph gl-managed-app Z[Nginx Ingress] end Z[Nginx Ingress] --> A(Ingress); Z[Nginx Ingress] --> B(Ingress); Z[Nginx Ingress] --> |canary가 존재하거나 점진적인 롤아웃이 있는 경우| J(Canary Ingress); subgraph stg namespace B[Ingress] --> H(...); end subgraph prd namespace subgraph stable track A[Ingress] --> D[Service]; D[Service] --> E(Deployment:Pods:app:stable); end subgraph canary track J(Canary Ingress) --> K[Service] K[Service] --> F(Deployment:Pods:app:canary); end E(Deployment:Pods:app:stable)---id1[(Pods:Postgres)] F(Deployment:Pods:app:canary)---id1[(Pods:Postgres)] end

문제 해결

주요 버전 불일치 경고

이전 차트와 주요 버전이 다른 차트를 배포하면, 새 차트가 올바르게 배포되지 않을 수 있습니다. 이것은 아키텍처 변경 때문일 수 있습니다. 그런 경우, 배포 작업은 다음과 유사한 메시지와 함께 실패합니다: 

*************************************************************************************
                                   [경고]
현재 배포 중인 차트(auto-deploy-app-v0.7.0)와 이전에 배포된 차트(auto-deploy-app-v1.0.0) 간의 주요 버전 차이가 검출되었습니다.
새 주요 버전이 현재 릴리즈(프로덕션)와 역호환성을 가질 수 없을 수도 있습니다. 배포가 실패하거나 복구할 수 없는 상태에 갇힐 수 있습니다.
...

이 오류 메시지를 해결하고 배포를 재개하려면 다음 중 하나를 수행해야 합니다:

오류: missing key "app.kubernetes.io/managed-by": must be set to "Helm"

클러스터에 v1 auto-deploy-image로 배포된 배포가 있는 경우 다음 오류가 발생할 수 있습니다:

  • Error: rendered manifests contain a resource that already exists. Unable to continue with install: Secret "production-postgresql" in namespace "<project-name>-production" exists and cannot be imported into the current release: invalid ownership metadata; label validation error: missing key "app.kubernetes.io/managed-by": must be set to "Helm"; annotation validation error: missing key "meta.helm.sh/release-name": must be set to "production-postgresql"; annotation validation error: missing key "meta.helm.sh/release-namespace": must be set to "<project-name>-production"

이전 배포가 Helm2로 배포되어 Helm3과 호환되지 않는 것입니다. 문제를 해결하려면 업그레이드 가이드를 따르세요.