Cloud Run에 카나리아 배포

이 문서에서는 카나리아 배포를 구성하고 사용하여 Cloud Deploy를 통해 Cloud Run (서비스만 해당, 작업은 아님)에 애플리케이션을 배포하는 방법을 설명합니다.

카나리아 배포는 애플리케이션의 새 버전을 점진적으로 출시하는 배포 방식입니다. 애플리케이션의 성능을 모니터링하면서 새 버전으로 전송되는 트래픽의 비율을 점진적으로 늘립니다. 이렇게 하면 잠재적인 문제를 조기에 파악하고 사용자에게 미치는 영향을 최소화할 수 있습니다.

Cloud Run의 카나리아 배포 작동 방식

카나리아 배포 전략을 사용하여 Cloud Run에 배포하면 Cloud Deploy가 새 버전으로 기존 서비스를 업데이트합니다. 새 버전은 지정된 트래픽 비율을 수신하고 이전 버전은 나머지 트래픽을 계속 수신합니다. 시간이 지남에 따라 새 버전으로의 트래픽 분할을 점진적으로 늘립니다.

Cloud Deploy를 사용하면 단일 스테이지 또는 여러 스테이지에서 Cloud Run에 카나리아 배포를 구성할 수 있습니다.

이 안내에는 카나리아 구성과 관련된 내용만 포함됩니다. 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 파일은 Cloud Run 서비스 정의가 렌더링되고 배포되는 방식을 정의합니다. Cloud Run에 카나리아 배포를 하는 경우 서비스 정의 파일을 올바르게 가리키고 컨테이너 이미지와 같은 필요한 빌드 아티팩트를 정의해야 합니다. skaffold.yaml 자체에는 표준 배포에 필요한 항목 이외의 특별한 카나리아 관련 구성이 필요하지 않습니다. Skaffold 프로필을 사용하여 맞춤 카나리아 단계의 다양한 서비스 정의 변형을 관리할 수 있습니다.

서비스 정의 준비

일반 Cloud Run 서비스 정의 파일로 충분하지만 traffic 스탠자가 없습니다. Cloud Deploy는 마지막으로 성공한 수정과 신규 수정 사이에 트래픽 분할을 관리합니다.

service.yaml 예 (traffic 스탠자 없음):

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: my-cloudrun-service
spec:
  template:
    spec:
      containers:
      - image: gcr.io/my-project/my-cloudrun-app
        ports:
        - containerPort: 8080

자동화된 카나리아 구성

특정 Cloud Run 단계의 배포 파이프라인 정의 내에서 직접 자동화된 카나리아를 구성합니다. Cloud Deploy는 지정된 비율에 따라 마지막 안정적인 버전과 새 버전 간에 트래픽을 분할하도록 Cloud Run에 자동으로 지시합니다.

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"

이 구성에서

  • PERCENTAGES는 카나리아 증분을 나타내는 쉼표로 구분된 백분율 값 목록입니다(예: [25, 50, 75]). 카나리아에서 100% 배포가 간주되고 stable 단계에서 처리되므로 여기에는 100이 포함되지 않습니다.

  • 배포 확인(verify: true)을 사용 설정할 수 있습니다. 이렇게 하면 verify 작업이 각 카나리아 단계에 추가됩니다.

  • PREDEPLOY_ACTION

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

  • POSTDEPLOY_ACTION

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

커스텀 카나리아 구성

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

  • 출시 단계 이름

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

  • 단계별 백분율 목표

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

  • 단계에 사용할 Skaffold 프로필

    각 단계 또는 동일한 프로필 또는 모든 조합에 대해 별도의 Skaffold 프로필을 사용할 수 있습니다. 각 프로필은 서로 다른 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를 포함하면 커스텀 자동 카나리아로 간주됩니다.

커스텀 자동 카나리아 구성

이렇게 하면 맞춤 단계 정의 (이름, 비율, 프로필, 확인, 후크)가 Cloud Run용 Cloud Deploy의 자동 트래픽 관리와 결합됩니다. 단계를 정의하면 Cloud Deploy에서 비율에 따라 Cloud Run에 트래픽을 이동하도록 지시합니다.

이를 구성하려면 strategy.canary 블록 내에 runtimeConfig.cloudRun.automaticTrafficControl: true 설정과 customCanaryDeployment 섹션 (phaseConfigs 정의)을 모두 포함합니다. Cloud Deploy는 지정된 Skaffold 프로필을 사용하여 서비스 정의를 렌더링하지만 (여전히 traffic 스탠자가 없어야 함) 단계 비율에 따라 트래픽을 자동으로 관리합니다.

serialPipeline:
  stages:
  - targetId: cloudrun-prod
    profiles: []
    strategy:
      canary:
        # Include runtimeConfig for automatic traffic management
        runtimeConfig:
          cloudRun:
            automaticTrafficControl: true
        # Include customCanaryDeployment for phase customization
        customCanaryDeployment:
          phaseConfigs:
          - phaseId: "warmup-cr"
            percentage: 10
            profiles: ["base-config"] # Profile rendering service def (no traffic stanza)
            verify: true
          - phaseId: "scaling-cr"
            percentage: 50
            profiles: ["base-config"] # Can use the same profile
            verify: true
          - phaseId: "stable"
            percentage: 100
            profiles: ["base-config"]
            verify: true

Cloud Run 카나리아 실행

  1. 파이프라인 및 대상 등록: 배포 파이프라인 및 Cloud Run 대상 구성 파일을 적용합니다.

    
    gcloud deploy apply --file=delivery-pipeline.yaml --region=REGION
    gcloud deploy apply --file=cloudrun-targets.yaml --region=REGION
    

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

  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. 출시 탭의 배포 파이프라인 세부정보에서 출시 이름을 클릭합니다.

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

       Google Cloud 콘솔의 출시 세부정보

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

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

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

건너뛴 단계

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

다음 단계