카나리아 배포 전략 사용

이 문서에서는 카나리아 배포 전략을 구성하고 사용하는 방법을 설명합니다.

카나리아 배포란 무엇인가요?

카나리아 배포는 이미 배포된 버전과 새 버전 간에 트래픽을 분할하여 완전히 배포되기 전에 일부 사용자에게 배포하는 애플리케이션의 점진적 출시입니다.

지원되는 대상 유형

Cloud Deploy에서 카나리아 배포는 다음을 포함하여 모든 대상 유형을 지원합니다.

• Google Kubernetes Engine
• Cloud Run(작업 아님, 서비스만)
• GKE Enterprise

카나리아는 다중 대상에서도 작동합니다.

카나리아 배포 전략을 사용하는 이유는 무엇인가요?

카나리아 배포를 사용하면 애플리케이션을 부분적으로 출시할 수 있습니다. 이렇게 하면 모든 사용자에게 새 버전의 애플리케이션을 제공하기 전에 안정성을 확인할 수 있습니다.

예를 들어 GKE 또는 GKE Enterprise에 배포하는 경우 제한된 수의 포드에 애플리케이션의 새 버전을 배포할 수 있습니다. 이전 버전은 계속 실행되지만 더 많은 트래픽이 새 포드로 전송됩니다.

Cloud Run에 배포하는 경우 Cloud Run은 구성한 백분율에 따라 자체적으로 이전 버전과 새 버전 간에 트래픽을 분할합니다.

카나리아 유형

Cloud Deploy를 사용하면 다음 유형의 카나리아 배포를 구성할 수 있습니다.

• 자동

  자동 카나리아 배포의 경우 점진적 배포를 표현하는 일련의 백분율로 Cloud Deploy를 구성합니다. Cloud Deploy는 추가 작업을 자동으로 수행해서 이전 및 신규 버전 사이에 트래픽 백분율을 할당합니다.

• 커스텀 자동

  커스텀 자동화 카나리아의 경우 다음을 제공할 수 있습니다.

  • 단계 이름
  • 백분율 목표
  • 단계에 사용할 Skaffold 프로필
  • 확인 작업 포함 여부
  • 사전 배포 또는 사후 배포 작업을 포함할지 여부 또는 둘 다 포함할지 여부

  하지만 트래픽 균형 조정 정보를 제공할 필요가 없습니다. Cloud Deploy에서 필요한 리소스를 만듭니다.

• 커스텀

  커스텀 카나리아를 사용하여 다음을 포함하여 각 카나리아 단계를 개별적으로 구성합니다.

  • 단계 이름
  • 백분율 목표
  • 단계에 사용할 Skaffold 프로필
  • 확인 작업 포함 여부
  • 사전 배포 또는 사후 배포 작업을 포함할지 여부 또는 둘 다 포함할지 여부

  또한 완전 커스텀 카나리아의 경우 여기의 설명대로 모든 트래픽 분산 구성을 제공합니다.

카나리아 배포 단계

카나리아 배포용 출시 버전을 만들면 각 카나리아 증분 단계와 100%를 위한 최종 stable 단계로 출시가 생성됩니다.

예를 들어 카나리아를 25%, 50%, 75% 단위로 구성하는 경우 출시 단계는 다음과 같습니다.

• canary-25
• canary-50
• canary-75
• stable

출시 단계, 작업, 작업 실행에 대한 자세한 내용은 출시 관리를 참조하세요.

자동 카나리아 또는 커스텀 자동 카나리아에서 발생하는 일

카나리아 배포를 지원하기 위해 Cloud Deploy에는 Kubernetes 매니페스트 또는 Cloud Run 서비스 구성을 렌더링할 때 특수한 처리 단계가 포함됩니다.

카나리아 배포의 단계 간 차이를 보려면 출시 버전 검사기에서 제공되는 단계별 렌더링 매니페스트의 변경사항을 확인하면 됩니다. 출시가 시작되기 전에도 이 작업을 수행할 수 있습니다. 또한 병렬 배포를 사용하는 경우 각 하위 항목의 렌더링된 매니페스트를 조사할 수 있습니다.

카나리아 배포 구성

이 섹션에서는 카나리아 배포를 위한 배포 파이프라인 및 대상을 구성하는 방법을 설명합니다.

이 안내에는 카나리아 구성과 관련된 내용만 포함됩니다. 애플리케이션 배포 문서에는 배포 파이프라인 구성 및 실행에 대한 일반 안내가 포함되어 있습니다.

필수 권한 필요

Cloud Deploy를 사용하는 데 필요한 다른 Identity and Access Management 권한 외에도 카나리아 배포에 필요할 수 있는 추가 작업을 수행하기 위해 다음 권한이 필요합니다.

• clouddeploy.rollouts.advance
• clouddeploy.rollouts.ignoreJob
• clouddeploy.rollouts.cancel
• clouddeploy.rollouts.retryJob
• clouddeploy.jobRuns.get
• clouddeploy.jobRuns.list
• clouddeploy.jobRuns.terminate

이러한 권한이 포함된 사용 가능한 역할에 대한 자세한 내용은 IAM 역할 및 권한을 참조하세요.

skaffold.yaml 준비

표준 배포와 마찬가지로 카나리아에는 매니페스트와 서비스 정의가 렌더링되고 배포되는 방법을 정의하는 skaffold.yaml 파일이 필요합니다.

카나리아 배포를 위해 만드는 skaffold.yaml에는 표준 배포에 필요한 항목 이외의 특별한 요구사항이 없습니다.

매니페스트 또는 서비스 정의 준비

표준 배포와 마찬가지로 카나리아에는 Kubernetes 매니페스트나 Cloud Run 서비스 정의가 필요합니다.

자동화된 카나리아 구성

다음은 Cloud Run, GKE 및 GKE Enterprise 서비스 기반 네트워킹 대상에 대한 안내입니다. GKE 또는 GKE Enterprise에서 Kubernetes Gateway API를 사용하는 경우 이 문서를 참조하세요.

배포 파이프라인 정의에서 자동화된 카나리아를 구성합니다.

serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          kubernetes:
            serviceNetworking:
              service: "SERVICE_NAME"
              deployment: "DEPLOYMENT_NAME"
              podSelectorLabel: "LABEL"
        canaryDeployment:
          percentages: [PERCENTAGES]
          verify: true|false
          predeploy:
            actions: "PREDEPLOY_ACTION"
          postdeploy:
            actions: "POSTDEPLOY_ACTION"

serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          cloudRun:
            automaticTrafficControl: true
        canaryDeployment:
          percentages: [PERCENTAGES]
          verify: true|false
          predeploy:
            actions: "PREDEPLOY_ACTION"
          postdeploy:
            actions: "POSTDEPLOY_ACTION"

커스텀 카나리아 구성

Cloud Deploy에서 제공하는 자동화에 완전히 의존하는 대신 카나리아를 수동으로 구성할 수 있습니다. 커스텀 카나리아 구성을 사용하면 배포 파이프라인 정의에 다음을 지정합니다.

• 출시 단계 이름

  완전 자동화된 카나리아에서 Cloud Deploy는 단계 이름을 지정합니다(예: canary-25, canary-75, stable). 그러나 커스텀 카나리아를 사용하면 이 카나리아 단계의 모든 단계에서 고유하고 리소스 이름 제한을 준수하는 한 각 단계에 이름을 지정할 수 있습니다. 하지만 최종(100%) 단계 이름은 stable이어야 합니다.

• 단계별 백분율 목표

  단계별로 별도로 백분율을 지정합니다.

• 단계에 사용할 Skaffold 프로필

  각 단계 또는 동일한 프로필 또는 모든 조합에 대해 별도의 Skaffold 프로필을 사용할 수 있습니다. 각 프로필은 서로 다른 Kubernetes 매니페스트나 Cloud Run 서비스 정의를 사용할 수 있습니다. 또한 지정된 단계에 대해 하나를 초과하는 프로필을 사용할 수 있습니다. Cloud Deploy는 이를 결합합니다.

• 단계에 확인 작업이 있는지 여부

  확인을 사용 설정하는 경우 확인에 사용할 skaffold.yaml도 구성해야 합니다.

• 단계에 배포 전 또는 배포 후 작업이 있는지 여부

  배포 전 또는 배포 후 작업을 사용 설정할 경우 이러한 작업의 skaffold.yaml을 구성해야 합니다.

커스텀 카나리아에서는 모든 대상 유형이 지원됩니다.

커스텀 카나리아 구성 요소

다음 YAML에서는 완전 커스텀 카나리아 배포 단계 구성을 보여줍니다.

strategy:
  canary:
    # Custom configuration for each canary phase
    customCanaryDeployment:
      phaseConfigs:
      - phaseId: "PHASE1_NAME"
        percentage: PERCENTAGE1
        profiles: [ "PROFILE_NAME" ]
        verify: true | false
        predeploy:
          actions: "PREDEPLOY_ACTION"
        postdeploy:
          actions: "POSTDEPLOY_ACTION"
      - …
      - phaseId: "stable"
        percentage: 100
        profiles: [ "LAST_PROFILE_NAME" ]
        verify: true|false
        predeploy:
          actions: "PREDEPLOY_ACTION"
        postdeploy:
          actions: "POSTDEPLOY_ACTION"

이 YAML에서

• PHASE1_NAME

  단계 이름입니다. 각 단계 이름은 고유해야 합니다.

• [ "PROFILE_NAME" ]

  단계에 사용할 프로필의 이름입니다. 각 단계에 동일한 프로필을 사용하거나 단계마다 다른 프로필을 사용하거나 이를 조합하여 사용할 수 있습니다. 또한 프로필을 하나 넘게 지정할 수 있습니다. Cloud Deploy는 지정된 모든 프로필과 함께 전체 단계에서 사용되는 프로필 또는 매니페스트를 사용합니다.

• stable

  마지막 단계의 이름은 stable이어야 합니다.

• PERCENTAGE1

  첫 번째 단계에 배포할 백분율입니다. 각 단계에는 고유한 백분율 값이 있어야 하며 해당 값은 전체 백분율(예: 10.5 아님)이어야 하며 단계는 오름차순이어야 합니다.

• verify: true|false

  단계에 대해 확인 작업을 포함할지 여부를 Cloud Deploy에 알려줍니다. 확인을 사용할 각 단계에 대해 Scaffold는 해당 단계에 대해 렌더링 및 배포에 지정된 동일한 프로파일을 확인에 사용합니다.

• PREDEPLOY_ACTION

  skaffold.yaml에서 배포 전에 실행할 맞춤 액션을 정의하는 데 사용한 ACTION_NAME과 동일합니다.

• POSTDEPLOY_ACTION

  skaffold.yaml에서 배포 후 실행할 맞춤 액션을 정의하는 데 사용한 ACTION_NAME과 동일합니다.

마지막 단계의 백분율은 100이어야 합니다. 이 ​customCanaryDeployment 스탠자에서 구성한 순서에 따라 단계가 실행되지만 백분율 값이 오름차순이 아닌 경우 배포 파이프라인을 등록하는 명령어가 실패하고 오류가 발생합니다.

커스텀 카나리아 구성에는 runtimeConfig 스탠자가 포함되지 않습니다. runtimeConfig를 포함하면 커스텀 자동 카나리아로 간주됩니다.

커스텀 자동 카나리아 구성

커스텀 단계 이름, 백분율 값, Skaffold 프로필, 작업 확인, 배포 전 및 배포 후 작업으로 별도의 카나리아 단계를 지정하므로 커스텀 자동 카나리아는 커스텀 카나리아와 비슷합니다. 그러나 개발자가 커스텀 카나리아를 사용하면 트래픽 할당을 정의하는 구성을 제공하지 않습니다. Cloud Deploy가 이를 대신 수행합니다. 그러나 개발자는 각 단계에 사용될 Skaffold 프로필을 계속 제공합니다.

커스텀 자동 카나리아를 구성하려면 여기에 표시된 대로 runtimeConfig 스탠자를 포함하고 여기에 표시된 대로 customCanaryDeployment 스탠자를 포함합니다.

Kubernetes Gateway API 서비스 메시를 사용하여 카나리아 배포 구성

Cloud Deploy 카나리아 배포를 사용할 수 하여 Kubernetes 서비스 기반 네트워킹에 애플리케이션 배포할 수 있지만 Kubernetes Gateway API 서비스 메시를 사용하는 다른 대안이 있습니다. 이 섹션에서는 이를 수행하는 방법을 모두 설명합니다.

Istio 또는 모든 지원되는 구현에 Gateway API를 사용할 수 있습니다.

1. Gateway API 리소스를 설정합니다.

   • Istio 사용

   • GKE 게이트웨이 컨트롤러

   다음은 이해를 돕기 위한 예시입니다.

2. 출시 버전을 만들 때 Cloud Deploy에 제공되는 Kubernetes 매니페스트에는 다음이 포함됩니다.

   • 게이트웨이 리소스를 참조하는 HTTPRoute입니다.

   • 배포

   • 서비스

3. 배포 파이프라인과 카나리아 배포를 수행할 대상을 구성합니다.

   • 대상 구성은 모든 대상에서 동일합니다.

   • 특정 대상에 대한 진행 시퀀스의 배포 파이프라인 구성에는 Kubernetes Gateway API HTTPRoute 구성, 배포, 서비스를 참조하는 gatewayServiceMesh 스탠자가 포함되어 있습니다.

     strategy:
      canary:
        runtimeConfig:
          kubernetes:
            gatewayServiceMesh:
              httpRoute: "ROUTE"
              service: "SERVICE"
              deployment: "DEPLOYMENT"
              routeUpdateWaitTime: "WAIT_TIME"
              podSelectorLabel: "LABEL"
        canaryDeployment:
          percentages:
          - 50
     

     각 항목의 의미는 다음과 같습니다.

     • ROUTE는 원하는 라우팅 동작을 정의하는 httpRoute 구성입니다.

     • SERVICE는 GKE 및 GKE Enterprise에 대한 카나리아 배포를 위해 Cloud Deploy에 필요한 서비스 구성입니다.

     • DEPLOYMENT는 GKE 및 GKE Enterprise에 대한 카나리아 배포를 위해 Cloud Deploy에 필요한 배포 구성입니다.

     • WAIT_TIME은 삭제된 요청이 없도록 HTTPRoute 리소스 변경사항이 전파를 완료할 때까지 Cloud Deploy에서 대기하는 시간입니다. 예를 들면 routeUpdateWaitTime: 60s입니다.

       Istio 없이 Gateway API를 사용해서 카나리아를 실행하는 중이고 Gateway API가 Google Cloud 부하 분산기에 연결되어 있으면 카나리아 인스턴스를 축소할 때 소량의 트래픽이 손실될 수 있습니다. 이 동작이 관찰되면 이 설정을 구성할 수 있습니다.

     • LABEL은 포드 선택기 라벨입니다. 이 라벨은 매니페스트에 정의된 Kubernetes 서비스 및 배포의 라벨 선택기와 일치해야 합니다. 이는 선택사항입니다. 기본값은 app입니다.

카나리아 배포 전략으로 동시 배포 사용

동시 배포를 사용하여 카나리아 배포를 실행할 수 있습니다. 즉, 점진적으로 배포하는 대상에서 하위 대상을 2개 이상 구성할 수 있습니다. 예를 들어 별도의 리전의 클러스터에 동시에 점진적으로 배포할 수 있습니다.

동시 카나리아와 단일 대상 카나리아의 차이점

• 단일 대상 카나리아 배포와 마찬가지로 GKE 대상에 배포하는 경우 매니페스트에 Kubernetes 배포 구성과 Kubernetes 서비스 구성이 필요합니다.

• 단일 대상 카나리아 배포와 마찬가지로 배포 파이프라인 구성에는 해당 단계에 대한 단계 정의 내에 strategy.canary 스탠자가 포함되어야 합니다.

• 또한 다중 대상을 구성해야 하며 이 다중 대상이 참조하는 하위 대상을 구성해야 합니다.

• 출시 버전을 만들면 컨트롤러 출시와 하위 출시가 생성됩니다.

  컨트롤러와 하위 출시 유형 모두 구성된 모든 카나리아 백분율에 대해 별도의 단계가 있으며 카나리아 100%에 대한 stable 단계가 있습니다.

• 하위 출시를 진행할 수 없습니다.

  컨트롤러 출시만 진행할 수 있습니다. 컨트롤러 출시를 다음 단계로 진행하면 하위 항목 출시도 Cloud Deploy에서 진행됩니다.

• 컨트롤러 출시에서 실패한 작업은 재시도할 수 없습니다.

  하위 출시에서만 작업을 재시도할 수 있습니다.

• 컨트롤러 출시에서는 실패한 작업을 무시할 수 없습니다.

  하위 출시에서만 실패한 작업을 무시할 수 있습니다.

• 컨트롤러 출시를 취소할 수 있지만 하위 출시를 취소할 수 없습니다.

• 컨트롤러 출시가 아닌 하위 출시에서만 작업 실행을 종료할 수 있습니다.

카나리아에서 동시 출시가 실패할 경우 취해야 할 조치

하위 출시가 실패하면 하위 출시에서 발생하는 상황에 따라 컨트롤러 출시가 다른 상태로 전환될 수 있습니다.

• 하나 이상의 하위 출시가 실패하지만 하위 출시 중 하나라도 여전히 IN_PROGRESS인 경우, 컨트롤러 출시가 IN_PROGRESS 상태로 유지됩니다.

• 하나 이상의 하위 출시가 실패하지만 하위 출시 중 하나라도 성공하는 경우, 현재 단계 이후 단계가 더 있으면 컨트롤러 출시는 HALTED됩니다.

  stable 단계인 경우 컨트롤러 출시는 FAILED입니다.

  HALTED를 사용하면 실패한 하위 출시 내의 실패한 작업을 무시 또는 재시도할 수 있거나 컨트롤러 출시를 취소하여 하위 출시에서 추가 작업을 방지할 수 있습니다.

• 컨트롤러 출시가 실패한 하위 출시로 인해 HALTED 상태이고 하위 출시에서 실패한 작업을 무시하면 컨트롤러 출시가 IN_PROGRESS 상태로 되돌아갑니다.

다른 클러스터에 HTTPRoute 배포

Gateway API 서비스 메시를 사용하여 구성된 카나리아가 있는 경우 HTTPRoute를 배포할 타겟이 아닌 대체 클러스터를 지정할 수 있습니다.

이렇게 하려면 카나리아 전략 구성에서 routeDestinations 스탠자를 사용하여 HTTPRoute의 대상 클러스터 또는 클러스터를 식별하고 불리언 설정을 사용하여 서비스를 동일한 타겟 외 클러스터에 전파합니다. 그리고 대상 구성에서 associatedEntities 스탠자를 만들어 클러스터를 식별합니다.

1. 대상에서 associatedEntities를 구성합니다.

   각 항목은 Cloud Deploy가 HTTPRoute 및 선택적으로 Kubernetes 서비스를 배포하는 클러스터입니다. 대상 정의에 associatedEntities 스탠자를 포함합니다.

   associatedEntities:
     [KEY]:
       gkeClusters:
       - cluster: [PATH]
         internalIp: [true|false]
         proxyUrl:
   

   각 항목의 의미는 다음과 같습니다.

   • KEY은 연결된 항목 그룹의 임의 이름입니다. 이 이름을 사용하여 카나리아 구성의 routeDestinations에서 항목을 참조합니다.

   • PATH은 HTTPRoute (및 선택적으로 서비스)가 배포될 GKE 클러스터를 식별하는 리소스 경로입니다.

   • internalIp는 클러스터에 내부 IP와 공개 IP가 모두 구성된 경우 내부 IP (비공개 IP)를 사용할지 여부를 나타냅니다. 기본값은 false입니다.

   internalIp 유무와 관계없이 원하는 수만큼 클러스터를 포함할 수 있습니다.

2. 카나리아 구성에서 routeDestinations를 구성합니다.

   각 경로 대상은 associatedEntities 스탠자를 참조하며 서비스도 대체 클러스터에 배포할지 여부를 나타냅니다. 카나리아 구성의 gatewayServiceMesh 스탠자 내에 다음을 추가합니다.

   routeDestinations:
     destinationIds: ["KEY"]
     propagateService: [true|false]
   

   각 항목의 의미는 다음과 같습니다.

   • KEY은 associatedEntities의 타겟에서 구성한 이름입니다. 이 이름을 사용하여 카나리아 구성에서 routeDestinations의 항목을 참조합니다.

     @self 값을 제공하여 연결된 대상 외에도 HTTPRoute를 대상 클러스터에 배포할 수도 있습니다.

   • propagateService는 HTTPRoute 외에도 연결된 클러스터에 서비스를 배포할지 여부를 나타냅니다. 기본값은 false입니다.

구성된 카나리아 실행

카나리아 배포를 실행하려면 다음 안내를 따르세요.

1. 구성된 배포 파이프라인 및 대상 등록

   gcloud deploy apply --file=PIPELINE
   

   배포 파이프라인에는 선택한 런타임에 자동 또는 커스텀 카나리아 구성이 포함됩니다.

   이 명령어는 대상이 같은 파일에 정의되었거나 이미 등록되었다고 가정합니다. 그렇지 않으면 대상도 등록해야 합니다.

2. 출시 버전 만들기

   gcloud deploy releases create RELEASE_NAME \
                                 --delivery-pipeline=PIPELINE_NAME \
                                 --region=REGION
   

   PIPELINE_NAME으로 식별된 배포 파이프라인에는 이 문서에 설명된 자동 또는 커스텀 카나리아 구성이 포함되어 있습니다.

3. 카나리아를 진행합니다.

   gcloud CLI

   gcloud deploy rollouts advance ROLLOUT_NAME \
                               --release=RELEASE_NAME \
                               --delivery-pipeline=PIPELINE_NAME \
                               --region=REGION
   

   각 항목의 의미는 다음과 같습니다.

   ROLLOUT_NAME은 다음 단계로 진행하려는 현재 출시의 이름입니다.

   RELEASE_NAME은 이 출시가 속한 출시 버전의 이름입니다.

   PIPELINE_NAME은 이 출시 버전의 배포를 관리하는 데 사용하는 배포 파이프라인의 이름입니다.

   REGION은 출시 버전이 생성된 리전의 이름입니다(예: us-central1). 필수 항목입니다.

   gcloud deploy rollouts advance 명령어에 대한 자세한 내용은 Google Cloud SDK 참조를 확인하세요.

   Google Cloud 콘솔

   1. 배포 파이프라인 페이지를 엽니다.

   2. 배포 파이프라인 목록에 표시된 파이프라인을 클릭합니다.

      배포 파이프라인 세부정보 페이지에는 배포 파이프라인의 진행 상태가 그래픽으로 표시됩니다.

   3. 출시 탭의 배포 파이프라인 세부정보에서 출시 이름을 클릭합니다.

      해당 출시의 출시 세부정보 페이지가 표시됩니다.

      

      이 예시에서는 출시에 canary-50 단계와 stable 단계가 있습니다. 출시에 더 많은 단계나 다른 단계가 있을 수 있습니다.

   4. 출시 진행을 클릭합니다.

      출시가 다음 단계로 진행됩니다.

건너뛴 단계

카나리아를 배포할 때 애플리케이션이 이 런타임에 아직 배포되지 않았으면 Cloud Deploy가 카나리아 단계를 건너뛰고 안정 단계를 실행합니다. 왜 이렇게 되는지 확인하려면 처음으로 단계 건너뛰기를 참조하세요.

다음 단계

• 카나리아 배포 빠른 시작 사용해 보기

• 카나리아 출시 수명 주기 관리 방법 알아보기

• 동시 배포 자세히 알아보기