Auto Deploy 의존성 업그레이드

Tier: Free, Premium, Ultimate Offering: GitLab.com, 자체 관리, GitLab 전담 서비스

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

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

auto-deploy-image 및 auto-deploy-app 차트는 의미론적 버전을 사용합니다. 기본적으로 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 to v14.0 v0.1.0 to 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로 배포된 활성 환경이 있는 경우, 다음 단계를 사용하여 v2로 업그레이드하세요. v2는 Helm v3를 사용합니다:

  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라는 Job artifact에 1 주일 동안 백업을 저장합니다. 준비가 되기 전에 실수로 Helm v2 릴리스를 삭제하는 경우,이 백업을 사용하여 Kubernetes manifest 파일에서 복원할 수 있습니다. kubectl apply -f $backup을 사용하세요.

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

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

In-Cluster PostgreSQL Channel 2

v2 자동 배포 이미지는 이전 클러스터 내 PostgreSQL에 대한 지원을 중단합니다. 귀하의 Kubernetes 클러스터가 여전히 이에 의존하는 경우, 업그레이드하고 데이터를 마이그레이션해야 합니다. v1 자동 배포 이미지 사용를 참고하세요.

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

자동 배포는 canary 배포와 점진적 롤아웃과 같은 고급 배포 전략을 지원합니다.

이전에 auto-deploy-image는 불안정 및 안정적 트랙 사이의 트래픽을 레플리카 비율을 변경하여 조정하는 서비스를 하나 생성했습니다. v2 auto-deploy-image에서는 Canary Ingress를 사용하여 트래픽을 제어합니다.

자세한 정보는 v2 auto-deploy-app 차트 리소스 아키텍처를 참고하세요.

v1 auto-deploy-image로 배포된 production 환경에서 활성 canary 또는 rollout 트랙 릴리스를 갖는 경우 다음 단계를 따라 v2로 업그레이드하세요:

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

특정 버전의 자동 배포 종속성 사용

특정 버전의 자동 배포 종속성을 사용하려면, desired version of auto-deploy-image 및 auto-deploy-app를 포함하는 이전 Auto Deploy stable 템플릿을 지정하십시오.

예를 들어, 템플릿이 GitLab 16.10에 번들되어 있는 경우, .gitlab-ci.yml을 다음과 같이 변경하십시오: 

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

경고 무시 및 배포 계속 진행

새 차트 버전이 안전하게 배포될 수 있다고 확신하는 경우, CI/CD 변수를 사용하여 배포를 계속 진행할 수 있습니다.

예를 들어, 이전에 v0.17.0 차트를 사용한 배포에 v2.0.0 차트를 배포하려는 경우 AUTO_DEVOPS_FORCE_DEPLOY_V2를 추가하십시오.

초기 채택자

최신 베타 또는 불안정한 버전의 auto-deploy-image를 사용하려는 경우, 최신 Auto Deploy 템플릿을 .gitlab-ci.yml에 포함하십시오: 

include:
  - template: Auto-DevOps.gitlab-ci.yml
  - template: Jobs/Deploy.latest.gitlab-ci.yml

경고: beta 또는 불안정한 auto-deploy-image를 사용하면 환경에 되돌릴 수 없는 손상을 일으킬 수 있습니다. 중요한 프로젝트나 환경에서 테스트하지 마십시오.

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

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

%%{init: { "fontFamily": "GitLab Sans" }}%% graph TD; accTitle: v0 및 v1 차트 리소스 아키텍처 accDescr: v0 및 v1 차트 구성 요소 간의 관계를 보여줍니다. 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 차트 리소스 아키텍처

%%{init: { "fontFamily": "GitLab Sans" }}%% graph TD; accTitle: v2 차트 리소스 아키텍처 accDescr: v2 차트 구성 요소 간의 관계를 보여줍니다. subgraph gl-managed-app Z[Nginx Ingress] end Z[Nginx Ingress] --> A(Ingress); Z[Nginx Ingress] --> B(Ingress); Z[Nginx Ingress] --> |캐너리 또는 점진적 롤아웃이 존재하는 경우/|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과 호환되지 않기 때문입니다. 문제를 해결하려면 업그레이드 가이드를 따르십시오.