同时部署到多个目标

使用 Cloud Deploy,您可以部署到配置为代表多个目标的目标,并且您的应用会并行(并发)部署到这些目标。您在流水线中标识为阶段的目标称为多目标,而多目标包含的目标称为子目标

您可以将并行部署与 Cloud Deploy 支持的任何目标类型搭配使用。

为何要并行部署

例如,您可以使用并行部署将应用部署到多个生产目标。在这种情况下,您无需依次部署到每个目标,因为没有进度(例如,从开发到预发布再到生产)。

这种并行部署可以作为正常交付流水线的一部分:
dev -> staging -> prod [prod1, prod2, prod3, prod4, ...]

用于并行部署的 Cloud Deploy 资源

并行部署使用以下 Cloud Deploy 专用资源:

  • 多目标

    多目标是指使用属性 multiTarget 在目标配置 YAML 的顶层进行配置的目标,它不引用运行时集群或服务,而是使用 multiTarget.targetIds 引用一个或多个其他目标。

  • 子目标

    子目标是指多目标以 multiTarget.targetIds 形式引用的任何目标。

  • 控制器发布

    控制器发布作业是与多目标对应的发布作业。

    如需详细了解控制器发布可以实现哪些功能,请参阅限制

  • 儿童发布

    如需详细了解子发布可以执行和不可以执行哪些操作,请参阅限制

设置并行部署

设置并行部署包括定义一个多目标和所需数量的子目标(最多达到限制)。目标定义与所有目标相同,但以下情况除外:

  • 多目标包含 multiTarget 属性。
  • 子目标不包含 multiTarget 属性,但会使用 multiTarget.targetIds 属性从多目标进行引用。
  • 您可以为审批配置多目标,但不能为子目标配置,子目标不能包含 requireApproval:true

多目标和子目标可以包含自定义执行环境配置。如果子目标未指定执行环境,则会继承多目标定义中定义的执行环境或默认执行环境。如需了解详情,请参阅执行环境和并行部署

配置多重目标

多目标是指在交付流水线中被标识为阶段的单个目标,但指向一个或多个子目标。

多目标配置包含 multiTarget 属性。多目标不能具有 gkerunanthosCluster 属性。无论您部署到哪个运行时,多目标的配置都是相同的。

在交付流水线 YAML 或单独的 YAML 文件中,创建基本目标定义,包括 multiTarget

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
 name: TARGET_NAME
description: TARGET_DESCRIPTION
multiTarget:
 targetIds: [ CHILD_TARGET1, CHILD_TARGET2, CHILD_TARGETn ]

在此 YAML 中…

  • TARGET_NAME 是此多目标的名称,用于交付流水线定义stages.targetId 属性中。

  • CHILD_TARGET1, CHILD_TARGET2,...CHILD_TARGETn 是此多目标部署到的子目标的名称。每个名称都与子目标定义中的 name 属性对应。

如果存在 multiTarget.targetIds 属性,则表示相应目标是多目标。

配置子目标

对于在多目标配置中标识为子目标的每个目标,请配置另一个目标作为子目标:

交付流水线 YAML 或单独的 YAML 文件中,创建基本目标定义:

GKE

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
 name: CHILD_TARGET1
description: TARGET_DESCRIPTION
gke:
 cluster: projects/PROJECT_ID/locations/REGION/clusters/CLUSTER_NAME

在此 YAML 中…

  • CHILD_TARGET1 是相应子目标的名称。该名称对应于多目标定义multiTarget.targetIds 属性中的目标列表中的一个成员。

  • gke.cluster 属性的值是相应目标所指集群的资源名称,其中包括项目 ID、区域和集群名称。

此目标平台的配置与标准 GKE 目标平台相同。使其成为子目标的唯一原因是,多目标中的 multiTarget.targetIds 属性引用了它。

Cloud Run

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
 name: CHILD_TARGET1
description: TARGET_DESCRIPTION
run:
 location: projects/PROJECT_ID/locations/REGION

在此 YAML 中…

  • CHILD_TARGET1 是相应子目标的名称。该名称对应于多目标定义multiTarget.targetIds 属性中的目标列表中的一个成员。

  • run.location 属性的值是此目标所指的 Cloud Run 服务的资源名称,包括项目 ID 和区域。

此目标的配置与标准 Cloud Run 目标相同。使其成为子目标的唯一原因是,它在多目标中由 multiTarget.targetIds 属性引用。

GKE 关联集群

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
 name: CHILD_TARGET1
description: TARGET_DESCRIPTION
anthosCluster:
 membership: projects/PROJECT_ID/locations/global/memberships/MEMBERSHIP_NAME

在此 YAML 中…

  • CHILD_TARGET1 是相应子目标的名称。该名称对应于多目标定义multiTarget.targetIds 属性中的目标列表中的一个成员。

  • MEMBERSHIP_NAME 是您在将集群注册到舰队时选择的名称。

自定义目标

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
 name: CHILD_TARGET1
description: TARGET_DESCRIPTION
customTarget:
  customTargetType: CUSTOM_TARGET_TYPE_NAME

在此 YAML 中…

  • CHILD_TARGET1 是相应子目标的名称。该名称对应于多目标定义multiTarget.targetIds 属性中的目标列表中的一个成员。

  • CUSTOM_TARGET_TYPE_NAME 是相应目标所使用的自定义目标类型的名称。

向目标传递部署参数

您可以在清单中添加参数,并在交付流水线定义中添加值,以区分不同的子目标。这些值可以根据相应目标上的标签匹配情况,单独应用到单独的清单中。

例如,您可能希望为每个子目标设置不同的副本数。为此,您需要在交付流水线的 progression 中添加参数和值,同时在子目标上添加标签,以匹配每个参数-值对。

详细了解部署参数

创建版本

配置多重目标和子目标后,创建交付流水线和目标资源,然后像往常一样创建发布版本。

交付流水线的生命周期与任何 Cloud Deploy 流水线和目标相同,不同之处在于,当交付流水线到达包含多目标的阶段时,Cloud Deploy 会为多目标创建一个控制器部署,并为每个子目标创建一个子部署,以将应用部署到每个子目标。

针对 Cloud Deploy 操作的 Pub/Sub 消息会区分控制器部署和子部署。

限制

  • 一个多目标最多可以有 100 个子目标。

  • 单个多目标的全部子目标必须具有相同的目标运行时(例如,全部为 GKE 或全部为 Cloud Run)。

  • 在交付流水线中,子目标只能有一个父级多目标。

  • 多目标不能没有子目标,也不能将自身或其他多目标作为子目标进行引用。

  • 您无法在单个交付流水线中多次使用子目标,但可以在不同的流水线中重复使用它们。

  • 如果子定位条件是自定义定位条件,则它们必须全部引用同一 CustomTargetType

  • 默认池有并发限制,但专用池没有。

    当您部署到多目标时,所有子发布都会同时部署,但不得超过 Cloud Build 并发限制。如果子目标数量超过此限制,则某些目标的部署作业将不会运行,直到其他目标完成部署为止,这意味着在这种情况下,Cloud Deploy 不会同时部署到所有子目标。

    此外,如果目标包含验证作业,则其中一个或多个验证作业可能会在应用部署到所有子目标之前开始。

    如果您需要能够同时部署到比 Cloud Build 文档中指定的限制更多的目标平台,则有两种选择:

执行环境和并行部署

每个目标都可以配置为使用非默认执行环境。

  • 如果多目标具有非默认执行环境,则使用默认执行环境的所有子目标都会从多目标继承非默认执行环境

  • 如果多目标使用默认执行环境,则配置为使用非默认执行环境的任何子目标都会使用该非默认执行环境。

借助这些规则,您可以更轻松地将执行环境从多目标传播到子目标,这样您就不必为每个子目标定义或更改执行环境,同时仍然可以根据需要自定义一个或多个子目标的执行环境。

如需详细了解 Cloud Deploy 中的执行环境,请参阅使用 Cloud Deploy 执行环境

回滚并行部署

如果您需要回滚来自多个并行目标平台的部署,请按照回滚目标平台中所述回滚多目标平台。

并行部署的审批

与任何目标一样,您可以将并行部署配置为需要审批。不过,如果采用并行部署,您只能在多目标上配置审批。批准或拒绝会同时影响所有子目标。

在 Google Cloud 控制台中查看并行部署

您可以在 Google Cloud 控制台中查看多目标、子目标、控制器发布和子发布的相关详细信息。

在“交付流水线详情”中查看给定交付流水线的目标列表时,系统会列出多目标,但不会列出子目标。不过,在查看版本详情时,您可以看到控制器发布和子发布。您还可以在“交付流水线”详情页面的发布标签页中查看控制器和子发布。

版本检查器中,您可以查看并区分子发布版本的已渲染清单。

使用并行部署和部署策略

使用灰度部署策略时,您可以并行部署。如需了解详情,请参阅将并行部署与 Canary 部署策略搭配使用

后续步骤