更新 SaaS 产品

本文档介绍了如何使用 App Lifecycle Manager 更新 SaaS 产品。

App Lifecycle Manager 支持使用发布功能在多个已配置的单元中进行更新。发布会根据单元的 UnitKind 定位单元，并可选择使用 Google Cloud CLI 应用过滤条件 (unit_filter) 来定位特定单元子集。这样，您就可以在整个部署基础中进行代管式更新。您可以通过将单元升级到先前版本来执行回滚。

如需对单个特定单元执行操作，请使用单元详情页面上的可用控件。

准备工作

在更新应用产品之前，您应：

创建版本

您必须先创建版本，然后才能更新应用产品。发布版本表示 SaaS 应用的特定版本，由蓝图软件包及其关联的配置定义。从本质上讲，发布版本包含对单元的更新。

控制台

  1. 前往 App Lifecycle Manager。

    前往 App Lifecycle Manager

  2. 点击版本。

  3. 在版本页面上，点击创建。

  4. 在创建发布版本页面上：

    1. 在版本名称框中，为您的版本输入一个唯一的名称。
    2. 在单元种类框中，选择与此发布版本关联的单元种类。
    3. 在仅可从以下版本升级（可选）部分中，您可以选择要将哪些版本的单元升级至此版本。这样，您就可以控制升级路径。
    4. 在创建蓝图和存储蓝图步骤中，选择或创建蓝图。如需详细了解蓝图创建选项，请参阅蓝图文档。

    5. 在变量（可选）部分中，您可以选择为此版本设置输入变量。如需详细了解如何设置变量，请参阅变量文档。

  5. 点击创建。

  6. 您已创建版本。您可以在版本详情页面上查看版本详情。您可以在创建发布时引用此版本。

gcloud

如需使用 Google Cloud 控制台创建版本，请执行以下操作：

gcloud beta app-lifecycle-manager releases create RELEASE_NAME --blueprint-package=BLUEPRINT_PACKAGE_URI --unit-kind=UNIT_KIND [--location=LOCATION] [--labels=[KEY=VALUE,...]] [--upgradeable-from-releases=[RELEASE_NAME,...]] [--input-variable-defaults=[variable=VARIABLE,value=VALUE,type=TYPE,...]]

将

  • RELEASE_NAME：您要创建的版本 ID。这将成为发布版本的完整资源名称的一部分。
  • BLUEPRINT_PACKAGE_URI：要用于此版本的蓝图软件包的 URI。蓝图是托管在 Artifact Registry 或其他 OCI 注册表中的 OCI 映像。
    • 蓝图软件包包含预配单元所需的工件，并包含有关所用引擎 (Terraform) 以及版本的元数据。
    • 如果您在 URI 中省略主机名，则默认为区域级 Artifact Registry 路径（例如 us-east1-docker.pkg.dev）。
    • 如需详细了解如何创建蓝图，请参阅蓝图文档。
  • UNIT_KIND：此版本对应的单元种类的 ID 或完全限定标识符。创建发布版本后，UNIT_KIND 便无法更改。
  • LOCATION：您要在其中创建版本的位置。如果未提供完整的 URI 路径，此标志会为发布位置提供后备值。默认为 Google Cloud CLI 环境中配置的位置。
  • LABELS：（可选）要应用于版本以进行分类的标签。标签是键值对。
    • 键必须以小写字符开头，并且只能包含连字符、下划线、小写字符和数字。
    • 值只能包含连字符、下划线、小写字符和数字。
    • 例如：--labels=environment=staging,team=app-lifecycle-manager
  • UPGRADEABLE_FROM_RELEASES：（可选）以逗号分隔列表形式指定的版本名称，用于指定哪些现有版本可以更新为您创建的新版本。
    • 如果您将此标志留空，则可以更新到此发布版本的发布版本不受任何限制。
    • 如果提供，对此版本的单元更新请求将强制执行此限制。
  • INPUT_VARIABLE_DEFAULTS：（可选）蓝图所需的输入变量的默认值。
    • 您可以以内嵌方式或通过引用 YAML 或 JSON 文件来指定变量默认值。
    • 此处定义的变量可在创建发布时被覆盖。

如需详细了解如何设置变量，请参阅变量文档。 如需详细了解版本，请参阅 Release Google Cloud CLI 参考文档。

创建发布种类

在创建发布之前，您需要创建一个发布种类，作为将版本部署到单元的模板。

控制台

  1. 前往 App Lifecycle Manager。

    前往 App Lifecycle Manager

  2. 点击发布类型。

  3. 在发布种类页面上，点击创建。

  4. 在创建发布种类页面上：

    1. 在发布种类名称框中，输入发布种类的名称。
    2. 在单元种类框中，选择单元种类，详细说明您要使用发布版本更新的单元类型。

    3. 在发布策略下拉菜单中，选择要用于将发布版本部署到单元的策略：

      • 一次一个位置（简单）：一次更新一个位置（没有过渡时间）。同时更新最多 5% 的单元。
      • 一次全部（简单）：所有位置同时开始更新（非常适合开发环境和紧急情况）。
      • 渐进式（逐步）：在多个位置（具有过渡时间）以指数方式按百分比批次逐步部署更新。
      • 渐进式（单个位置）：按百分比分批更新单元，并延长过渡时间，以便在单个位置内检测问题。

      如需详细了解发布策略，请参阅发布策略。

  5. 点击创建。

  6. 您已创建发布种类。在发布种类详情页面上，您可以查看和修改发布种类的参数。

gcloud

如需使用 Google Cloud 控制台创建发布种类，请执行以下操作：

  gcloud beta app-lifecycle-manager rollout-kinds create ROLLOUT_KIND_NAME --unit-kind=UNIT_KIND --location=LOCATION --rollout_strategy=ROLLOUT_STRATEGY --error_budget=ERROR_BUDGET --unit_filter=UNIT_FILTER --update_unit_kind_default=UPDATE_UNIT_KIND_DEFAULT

将

  • ROLLOUT_KIND_NAME：发布种类的名称。
  • UNIT_KIND：定义要将版本应用于哪些单元。版本会应用于所选单元种类的所有单元。
  • LOCATION：您要在其中创建发布种类的位置。

  • ROLLOUT_STRATEGY：定义发布类型的发布策略。可能的值包括：

    • Google.Cloud.Simple.OneLocationAtATime：一次更新一个位置（无过渡时间）。同时更新最多 5% 的单元。
    • Google.Cloud.Simple.AllAtOnce：所有位置同时开始更新（非常适合开发环境和紧急情况）。
    • Google.Cloud.Progressive.Gradual.v1：在多个位置（具有过渡时间）以指数方式按百分比批次逐步部署更新。
    • Google.Cloud.Progressive.SingleLocation.v1：按百分比分批更新单元，并延长过渡时间，以便在单个位置内检测问题。

    如需详细了解发布策略，请参阅发布策略。

  • ERROR_BUDGET：错误预算的配置。如果失败单元的数量超过 error_budget 上限（由 allowed_count、allowed_ratio * total_units 定义），发布作业将暂停。如果未设置 error_budget，App Lifecycle Manager 将尝试更新所有单元，无论遇到多少次失败。

  • UNIT_FILTER：针对单元使用的 CEL 格式过滤条件字符串。系统将应用该过滤条件来确定符合条件的单元群体。此过滤条件只能缩小发布范围。它无法扩大发布范围。

  • UPDATE_UNIT_KIND_DEFAULT：用于更新单位种类的配置。默认情况下，单元种类将在发布开始时更新。可能的值包括：

    • UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED：未指定单元种类更新策略。
    • UPDATE_UNIT_KIND_STRATEGY_ON_START：在发布开始时更新单元种类策略。
    • UPDATE_UNIT_KIND_STRATEGY_NEVER：从不更新单元种类策略。

如需了解详情，请参阅 RolloutKind Google Cloud CLI 参考文档。

错误预算功能

App Lifecycle Manager 包含错误预算功能（RolloutKind 中的 ErrorBudget），作为一种保障措施。如果单元更新失败（例如在基础架构应用期间）的数量或百分比超过配置的阈值，此功能可以自动暂停发布，从而有助于限制更新期间潜在问题的影响。

创建发布

创建发布种类后，您可以创建一个发布，指定要用于更新单元的版本。

创建发布后，App Lifecycle Manager 会根据单元类型中定义的策略更新单元。

控制台

  1. 前往 App Lifecycle Manager。

    前往 App Lifecycle Manager

  2. 点击发布。

  3. 在发布列表页面上，点击创建。

  4. 在创建发布页面上：

    1. 在发布作业种类框中，选择发布作业种类，其中详细说明了如何将发布版本部署到指定单元。
    2. 在发布版本框中，指定要用于更新单元的发布版本。
    3. 在发布名称框中，输入发布名称。

  5. 点击创建。

  6. 您的发布已创建。

    在全球发布详情页面上，您可以监控发布详情，包括发布状态、发布进度（按单元数）和发布失败。

gcloud

如需使用 Google Cloud 控制台创建发布，请执行以下操作：

  gcloud beta app-lifecycle-manager rollouts create ROLLOUT_NAME --rollout-kind=ROLLOUT_KIND_NAME --release=RELEASE_NAME --location=LOCATION

将

  • ROLLOUT_NAME：发布作业的名称。
  • ROLLOUT_KIND_NAME：定义要使用哪种发布类型将版本应用于单元。版本会应用于发布种类中定义的单元种类的所有单元。
  • RELEASE_NAME：定义要部署到单元的发布二进制文件。
  • LOCATION：要在其中创建发布的位置。

如需了解详情，请参阅 Rollout Google Cloud CLI 参考文档。

后续步骤