使用 Canary 部署策略

本文档介绍了如何配置和使用 Canary 部署策略。

什么是 Canary 部署？

Canary 部署是一种应用的渐进式发布方式，它会在已部署的版本和新版本之间拆分流量，先面向部分用户发布，然后再全面发布。

支持的目标类型

Cloud Deploy 中的 Canary 部署支持所有目标类型，包括：

• Google Kubernetes Engine
• Cloud Run（仅限服务，不包括作业）。
• GKE Enterprise

Canary 还支持多目标。

为什么要使用 Canary 部署策略？

借助 Canary 部署，您可以部分发布应用。这样，您就可以在向所有用户分发应用的新版本之前，确保该版本可靠无误。

例如，如果您要部署到 GKE 或 GKE Enterprise，则需要将新版应用部署到数量有限的 Pod。旧版将继续运行，但会将更多流量发送到新 pod。

如果您要部署到 Cloud Run，Cloud Run 本身会根据您配置的百分比，在旧修订版本和新修订版本之间拆分流量。

Canary 类型

借助 Cloud Deploy，您可以配置以下类型的 Canary 部署：

• 自动

  使用自动 Canary 版部署时，您可以使用一系列百分比来配置 Cloud Deploy，以表示逐步部署。Cloud Deploy 会代表您执行其他操作，以便在旧版和新版之间分配流量百分比。

• 自定义自动化

  对于自定义自动化 Canary，您可以提供以下信息：

  • 相应阶段的名称
  • 百分比目标
  • 要为相应阶段使用的 Skaffold 配置文件
  • 是否添加验证作业
  • 是否包含预部署作业、后部署作业或两者兼有

  不过，您无需提供流量平衡信息；Cloud Deploy 会创建必要的资源。

• 自定义

  使用自定义 Canary 版时，您可以单独配置每个 Canary 版阶段，包括：

  • 相应阶段的名称
  • 百分比目标
  • 要为相应阶段使用的 Skaffold 配置文件
  • 是否添加验证作业
  • 是否包含预部署作业、后部署作业或两者兼有

  此外，对于完全自定义的 Canary 版本，您需要提供所有流量均衡配置，如此处所述。

Canary 部署的阶段

为 Canary 部署创建版本时，系统会为每个 Canary 增量创建一个阶段，并为最终的 100% 创建一个 stable 阶段。

例如，如果您将 Canary 配置为按 25%、50% 和 75% 递增，则该发布将分为以下阶段：

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

如需详细了解发布阶段、作业和作业运行，请参阅管理发布。

自动或自定义自动 Canary 期间会发生什么

为了支持 Canary 部署，Cloud Deploy 在呈现 Kubernetes 清单或 Cloud Run 服务配置时会包含特殊的处理步骤：

如果您想查看 Canary 部署各个阶段之间的差异，可以查看版本检查器中提供的每个阶段呈现的清单中的更改。您甚至可以在发布前执行此操作。此外，如果您使用的是并行部署，还可以检查每个子项的呈现清单。

配置 Canary 部署

本部分介绍了如何为 Canary 部署配置提交流水线和目标。

此处的说明仅包含与 Canary 配置相关的内容。文档部署应用提供了有关配置和执行部署流水线的一般说明。

确保您拥有所需的权限

除了使用 Cloud Deploy 所需的其他 Identity and Access Management 权限之外，您还需要具备以下权限，才能执行 Canary 部署可能需要的其他操作：

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

如需详细了解哪些可用角色包含这些权限，请参阅 IAM 角色和权限。

准备 skaffold.yaml

与标准部署一样，您的 Canary 需要一个 skaffold.yaml 文件，该文件用于定义如何渲染和部署清单和服务定义。

除了标准部署所需的条件之外，您为 Canary 部署创建的 skaffold.yaml 没有任何特殊要求。

准备清单或服务定义

与标准部署一样，您的 Canary 版本需要 Kubernetes 清单或 Cloud Run 服务定义。

配置自动化 Canary

以下说明适用于 Cloud Run 以及基于 GKE 和 GKE Enterprise 服务的网络目标。如果您将 Kubernetes Gateway API 与 GKE 或 GKE Enterprise 搭配使用，请参阅此文档。

您可以在交付流水线定义中配置自动化 Canary：

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"

配置自定义 Canary

您可以手动配置 Canary 版本，而不是完全依赖 Cloud Deploy 提供的自动化功能。使用自定义 Canary 配置时，您需要在交付流水线定义中指定以下内容：

• 发布阶段名称

  在完全自动化的 Canary 版中，Cloud Deploy 会为您命名各个阶段（例如 canary-25、canary-75、stable）。不过，对于自定义 Canary 版，您可以为每个阶段指定任何名称，只要该名称在该 Canary 版阶段的所有阶段中都是唯一的，并且符合资源名称限制即可。但最终（100%）阶段名称必须为 stable。

• 每个阶段的百分比目标

  请为每个阶段分别指定百分比。

• 要用于相应阶段的 Skaffold 配置文件

  您可以为每个阶段使用单独的 Skaffold 配置文件，也可以使用相同的配置文件，或者任意组合。每个配置文件都可以使用不同的 Kubernetes 清单或 Cloud Run 服务定义。您还可以为给定阶段使用多个配置文件。Cloud Deploy 将它们结合起来。

• 相应阶段是否有验证作业

  请注意，如果您要启用验证功能，还需要配置 skaffold.yaml 以进行验证。

• 相应阶段是否有部署前作业或部署后作业

  如果您要启用部署前作业或部署后作业，则需要为这些作业配置 skaffold.yaml。

自定义 Canary 支持所有目标类型。

自定义 Canary 配置元素

以下 YAML 显示了完全自定义 Canary 部署各个阶段的配置：

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 是否应为相应阶段添加验证作业。请注意，对于要使用“验证”的每个阶段，Skaffold 都会为该阶段的“验证”使用为该阶段的“渲染”和“部署”指定的配置文件。

• PREDEPLOY_ACTION

  与您在 skaffold.yaml 中用于定义要在部署前运行的自定义操作的 ACTION_NAME 相同。

• POSTDEPLOY_ACTION

  与您在 skaffold.yaml 中用于定义要部署后运行的自定义操作的 ACTION_NAME 相同。

最后一个阶段的百分比必须为 100。系统会按照您在此 ​customCanaryDeployment 诗节中配置的顺序执行相应阶段，但如果百分比值不是按升序排列，用于注册传送流水线的命令将会失败并返回错误。

请注意，自定义 Canary 的配置不包含 runtimeConfig 诗节。如果您添加了 runtimeConfig，则系统会将其视为自定义自动化 Canary 版本。

配置自定义自动化 Canary

自定义自动化 Canary 与自定义 Canary 类似，因为您可以使用自定义阶段名称、百分比值、Skaffold 配置文件、验证作业以及预部署和发布后作业来指定单独的 Canary 阶段。不过，使用自定义 Canary 时，您无需提供用于定义流量分配的配置，Cloud Deploy 会为您完成此操作，但您仍然需要提供要用于每个阶段的 Skaffold 配置文件。

如需配置自定义自动化 Canary，请添加 runtimeConfig 诗节（如此处所示），并添加 customCanaryDeployment 诗节（如此处所示）。

使用 Kubernetes Gateway API 服务网格配置 Canary 部署

虽然您可以使用 Cloud Deploy 金丝雀部署来将应用部署到基于服务的 Kubernetes 网络，但另一种方法是使用 Kubernetes Gateway API 服务网格。本部分介绍了具体方法。

您可以将 Gateway API 与 Istio 或任何受支持的实现搭配使用。

1. 设置 Gateway API 资源：

   • 使用 Istio

   • GKE 网关控制器

   以上仅为示例。

2. 在您创建版本时提供给 Cloud Deploy 的 Kubernetes 清单中，添加以下内容：

   • 引用网关资源的 HTTPRoute

   • 部署

   • 服务

3. 配置交付流水线以及要将 Canary 部署到其上的目标：

   • 目标的配置与任何其他目标的配置相同。

   • 在特定目标的进度序列中，提交流水线配置包含一个 gatewayServiceMesh 诗节，用于引用您的 Kubernetes Gateway API HTTPRoute 配置以及您的部署和服务。

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

     其中...

     • ROUTE 是 httpRoute 配置，用于定义所需的路由行为。

     • SERVICE 是您的服务配置，Cloud Deploy 需要此配置才能将 Canary 版部署到 GKE 和 GKE Enterprise。

     • DEPLOYMENT 是您的部署配置，Cloud Deploy 需要此配置才能将 Canary 版部署到 GKE 和 GKE Enterprise。

     • WAIT_TIME 是 Cloud Deploy 等待 HTTPRoute 资源更改完成传播的时间，以避免请求被丢弃。例如：routeUpdateWaitTime: 60s。

       如果您使用 Gateway API 在没有 Istio 的情况下运行 Canary 版，并且 Gateway API 连接到 Google Cloud 负载均衡器，则在缩减 Canary 版实例时可能会丢失少量流量。如果您观察到这种行为，可以配置此设置。

     • LABEL 是 Pod 选择器标签。此标签必须与清单中定义的 Kubernetes 服务和部署中的标签选择器相匹配。您可以选择是否创建 PIN 码。默认值为 app。

将并行部署与 Canary 部署策略搭配使用

您可以使用并行部署运行 Canary 部署。也就是说，您要逐步部署到的目标可以包含两个或更多子目标。例如，您可以同时逐步部署到不同区域中的集群。

并行 Canary 与单目标 Canary 有何不同

• 与单目标 Canary 部署一样，如果您要部署到 GKE 目标，则需要在清单中添加 Kubernetes Deployment 配置和 Kubernetes Service 配置。

• 与单目标 Canary 部署一样，您的交付流水线配置必须在适用阶段的阶段定义中包含 strategy.canary 诗节。

• 此外，您还需要配置多目标，并配置该多目标引用的子目标。

• 创建版本时，系统会创建控制器发布和子发布。

  这两种类型的发布（控制组和子组）都针对所有配置的 Canary 百分比设置了单独的阶段，并针对 100% 的 Canary 设置了 stable 阶段。

• 您无法推进子发布。

  您只能推进控制器发布。当您将控制器发布作业推进到下一阶段时，Cloud Deploy 也会推进子发布作业。

• 您无法在控制器部署中重试失败的作业。

  您只能在子发布中重试作业。

• 您无法在控制器发布中忽略失败的作业。

  您只能忽略子发布中的失败作业。

• 您可以取消控制器发布，但无法取消子发布。

• 您只能在子发布（而非控制器发布）下终止作业运行。

如果 Canary 版本中的并行发布失败，该怎么办

当子发布失败时，控制器发布可能会转换到不同的状态，具体取决于子发布的具体情况：

• 如果一项或多项子发布失败，但至少一项子发布仍处于 IN_PROGRESS 状态，则控制器发布仍处于 IN_PROGRESS 状态。

• 如果一项或多项子发布失败，但至少有一项子发布成功，并且当前阶段后面还有其他阶段，则控制器发布状态为 HALTED。

  如果这是 stable 阶段，则控制器发布版本为 FAILED。

  HALTED 可让您忽略、重试失败的子发布中的失败作业，或取消控制器发布并阻止对子发布执行进一步操作。

• 如果控制器发布因子发布失败而处于 HALTED 状态，并且您忽略了子发布中的失败作业，则控制器发布会恢复为 IN_PROGRESS 状态。

将 HTTPRoute 部署到其他集群

使用 Gateway API 服务网格配置 Canary 后，您可以指定一个非目标集群作为备用集群来部署 HTTPRoute。

为此，您可以在 Canary 策略配置中使用 routeDestinations 诗节来识别 HTTPRoute 的目标集群，并使用布尔值设置将服务传播到同一非目标集群。您还需要在目标配置中创建 associatedEntities 诗节来标识这些集群。

1. 在目标设备上配置 associatedEntities。

   每个实体都是一个集群，Cloud Deploy 将在其中部署 HTTPRoute 和（可选）Kubernetes 服务。在目标定义中，添加 associatedEntities 诗节：

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

   其中：

   • KEY 是这组关联实体的任意名称。您将使用此名称在 Canary 配置中引用 routeDestinations 中的实体。

   • PATH 是标识将部署 HTTPRoute（以及可选的 Service）的 GKE 集群的资源路径。

   • 如果集群同时配置了内部 IP 和公共 IP，internalIp 用于指示您是否要使用内部 IP（专用 IP）。默认值为 false。

   您可以添加任意数量的集群，无论是否包含 internalIp。

2. 在 Canary 配置中配置 routeDestinations。

   每条路由目的地都引用一个 associatedEntities 诗节，并指明是否还要将服务部署到备用集群。在 Canary 配置的 gatewayServiceMesh 节中添加以下代码：

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

   其中：

   • KEY 是您在目标 associatedEntities 中配置的名称。您可以使用此名称在 Canary 配置中引用 routeDestinations 中的实体。

     除了关联的目标之外，您还可以提供值 @self 将 HTTPRoute 部署到目标集群。

   • propagateService 用于指明您是否希望将服务部署到关联的集群（除了 HTTPRoute 之外）。默认值为 false。

执行已配置的 Canary

如需运行 Canary 部署，请执行以下操作：

1. 注册已配置的交付流水线和目标。

   gcloud deploy apply --file=PIPELINE
   

   该提交流水线包含针对您所选运行时的自动或自定义 Canary 配置。

   此命令假定您的目标在同一文件中定义，或者已以其他方式注册。如果没有，请务必注册您的目标平台。

2. 创建版本：

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

   由 PIPELINE_NAME 标识的交付流水线包含本文档中所述的自动化或自定义 Canary 配置。

3. 推进 Canary 版：

   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. 点击推进发布。

      发布作业会推进到下一阶段。

已跳过的阶段

如果您部署了 Canary 版本，但应用尚未部署到该运行时，Cloud Deploy 会跳过 Canary 阶段并运行稳定阶段。如需了解出现这种情况的原因，请参阅首次跳过阶段。

后续步骤

• 试用Canary 部署快速入门。

• 了解如何管理 Canary 版本的生命周期。

• 详细了解并行部署。