部署 Cloud Run 服务或作业

本文档介绍了如何部署应用，包括 Cloud Run 服务和 Cloud Run 作业。

借助 Cloud Deploy，您可以将基于容器的工作负载部署到任何 Cloud Run 服务或作业。当您为 Cloud Run 服务部署到 Cloud Run 目标时，系统支持所有 Cloud Deploy 功能，但不支持为 Cloud Run 作业进行 Canary 部署。

本文档介绍了您需要完成的三项主要配置，才能部署到 Cloud Run：

限制

  • 每个目标只能部署一项 Cloud Run 服务或作业。

  • 您无法针对 Cloud Run 作业运行灰度部署。

    不过，Cloud Run 服务可以使用 Canary 部署。

  • 如需使用 Cloud Deploy 部署 Cloud Run 函数，您需要修改 CI 工作流，以将函数构建到容器中并将其部署为 Cloud Run 服务。

准备工作

创建目标配置

目标可以在交付流水线 YAML 中配置，也可以在单独的文件中配置。此外，您还可以在同一文件中配置多个目标。

目标必须在与交付流水线相同的项目和区域中定义。 但目标部署到的服务或作业可以位于不同的项目和区域中，前提是服务账号有权访问这些项目。

在目标定义中，创建一个 run stanza 来标识 Cloud Run 服务的创建位置。

在目标定义中指定 Cloud Run 服务或作业的语法如下：

run:
 location: projects/[project_name]/locations/[region_name]

此资源标识符使用以下元素：

  • [project_name] 是 Google Cloud 项目的名称，您的 Cloud Run 服务或作业将在此项目中创建。

    您需要针对每个目标执行此操作。我们建议为每个 Cloud Run 服务或作业使用不同的项目。如果您想在同一项目中运行多个服务或作业，需要在 skaffold.yaml 配置文件中使用 Skaffold 配置文件。

  • [region_name] 是将创建服务或作业的区域。您的服务或作业可以位于Cloud Run 支持的任何区域。

以下是一个目标配置示例，用于定义要创建的 Cloud Run 服务或作业：

      apiVersion: deploy.cloud.google.com/v1
      kind: Target
      metadata:
       name: dev
      description: development service
      run:
       location: projects/my-app/locations/us-central1

您可以在 Cloud Deploy 交付流水线定义中定义此目标，也可以单独定义。无论采用哪种方式，您都必须在创建版本之前注册目标，才能部署 Cloud Run 服务或作业。

创建 Skaffold 配置

以下是 Cloud Run 部署的 示例 skaffold.yaml 文件：

apiVersion: skaffold/v4beta7
kind: Config
metadata: 
  name: cloud-run-application
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}

在此 skaffold.yaml 文件中...

  • manifests.rawYaml 提供 Cloud Run 服务定义的名称。

    在此示例中，service.yaml 是定义 Skaffold 将部署的 Cloud Run 服务的文件。此文件名可以是任何名称，但按照惯例，对于服务，该文件名为 service.yaml；对于作业，该文件名为 job.yaml。

  • deploy stanza 用于指定您希望如何部署清单，具体而言，即项目和位置。必须提供 deploy。

    建议您保留空白的 {}。Cloud Deploy 会在渲染期间根据目标定义中的项目和位置填充此字段。

    不过，对于本地开发，您可以在此处提供值。不过，无论此处是否提供值，Cloud Deploy 始终使用目标定义中的项目和位置。

创建 Cloud Run 服务定义

如需创建 Cloud Run 服务定义，您可以手动创建，也可以从现有服务中复制。本部分将介绍这两种方法。

选项 1：创建新的 Cloud Run service.yaml

service.yaml 定义了您的 Cloud Run 服务。创建发布版本时，Skaffold 会使用此定义来部署服务。

下面是一个简化示例：

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
 name: [SERVICE_NAME]
spec:
 template:
  spec:
   containers:
   - image: [IMAGE_PATH]

其中：

  • [SERVICE_NAME] 是此 Cloud Run 服务的名称。

  • [IMAGE_PATH] 指向您要通过此服务部署的容器映像。

方法 2：使用 Google Cloud 控制台从现有服务复制 service.yaml

您可以使用 Google Cloud 控制台创建服务或使用现有服务，然后从该服务中复制 service.yaml。

如需使用 Google Cloud CLI 获取 service.yaml，请执行以下操作：

gcloud run services describe [service_name] --format=export

如需从 Google Cloud 控制台获取 service.yaml，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 Cloud Run 服务页面。

  2. 选择要使用其定义的现有服务。

或者，您也可以新建一个，然后选择该项目。选择服务后，系统会显示“服务详情”页面：

服务详情页面 -Google Cloud 控制台，显示 YAML 标签页

  1. 选择 YAML 标签页。

  2. 点击修改，然后将 YAML 的内容复制到文件系统中的一个名为 service.yaml 的新文件中，以便 Skaffold 在您创建版本时可以使用该文件。

创建 Cloud Run 作业定义

如需部署 Cloud Run 作业定义，您可以手动创建一个，也可以从现有作业中复制一个。本部分将介绍这两种方法。

请注意，作业不一定会在 Cloud Deploy 部署后立即运行。这与服务不同，服务是指部署后正在运行的应用。作业的调用方式取决于作业本身。

选项 1：创建新的 Cloud Run job.yaml

job.yaml 定义了 Cloud Run 作业。创建发布版本时，Skaffold 会使用此定义来部署作业。

下面是一个简化示例：

apiVersion: run.googleapis.com/v1
kind: Job
metadata:
 name: [JOB_NAME]
spec:
  template:
  spec:
   containers:
   - image: [IMAGE_PATH]

其中：

  • [JOB_NAME] 是此 Cloud Run 作业的名称。

  • [IMAGE_PATH] 指向您为此作业部署的容器映像。

方案 2：使用 Google Cloud 控制台从现有作业中复制 job.yaml

您可以使用 Google Cloud 控制台创建作业或使用现有作业，然后从中复制 job.yaml。

如需使用 Google Cloud CLI 获取 job.yaml，请执行以下操作：

gcloud run jobs describe [job_name] --format=export

如需从 Google Cloud 控制台获取 job.yaml，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 Cloud Run 作业页面。

  2. 选择要使用其定义的现有作业。

或者，您也可以新建一个，然后选择该项目。选择作业后，系统会显示“作业详情”页面：

作业详情页面Google Cloud 控制台，显示 YAML 标签页

  1. 选择 YAML 标签页。

  2. 点击修改，然后将 YAML 的内容复制到文件系统中的一个名为 job.yaml 的新文件中，以便 Skaffold 在您创建版本时可以使用该文件。

综合应用

现在，您已拥有 Cloud Run 服务或作业定义、skaffold.yaml 配置和 Cloud Deploy 目标定义，并且已将目标注册为 Cloud Deploy 资源，接下来可以调用交付流水线来创建版本，并按照流水线中定义的目标进展来推进版本。

快速入门使用 Cloud Deploy 将应用部署到 Cloud Run展示了所有这些操作。

不同修订版本中服务的行为

重新部署服务时，新修订版本基于新部署的 service.yaml。除非新部署的 YAML 中也包含先前修订版本中的内容，否则系统不会保留先前修订版本中的任何内容。例如，如果之前的修订版本中存在新的 YAML 中没有的配置设置或标签，那么这些设置或标签将不会出现在新的修订版本中。

触发 Cloud Run 作业

部署作业后，您可以按照 Cloud Run 文档中的说明触发作业。

在多个项目中部署 Cloud Run 服务和作业

如果您需要部署位于不同项目中的服务或作业，则您的执行服务账号需要有权访问定义这些服务或作业的项目。

如需了解详情，请参阅 Cloud Deploy 执行服务账号和 Identity and Access Management 角色和权限。

部署 Cloud Run functions 函数

Cloud Run functions 会在每次部署函数时构建源代码。因此，流水线中的每个目标运行时可能会获得略有不同的制品。这与 Cloud Deploy 中的最佳实践相悖。我们建议您直接使用 Cloud Run 服务。这样一来，您就可以构建单个制品，并在各个环境中对其进行升级。

  1. 在 service.yaml 中查看 Cloud Run functions 函数。

    您可以通过运行以下命令来获取此信息：

    gcloud run services describe FUNCTION_NAME \
--format=export \
--region=REGION \
--project=PROJECT

  2. 移除以下注释（如果存在）：

    • run.googleapis.com/build-base-image
    • run.googleapis.com/build-name
    • run.googleapis.com/build-source-location
    • run.googleapis.com/build-enable-automatic-updates

  3. 将 spec.spec.containers.image 中的值替换为 IMAGE_TAG。

  4. 创建交付流水线和目标，并将 Cloud Run 服务作为目标。

  5. 在 CI 流程中将构建步骤与部署步骤分开。请勿使用 Google Cloud CLI 部署函数，而是按以下步骤操作：

    1. 使用 Cloud Build 将函数构建到容器中：

      gcloud builds submit --pack image=REGION-docker.pkg.dev/PROJECT/cloud-run-source-deploy/IMAGE_NAME \
--project=PROJECT \
--region=REGION

    2. 使用 Cloud Deploy 创建发布版本：

      gcloud deploy releases create RELEASE_NAME \
--project=PROJECT \
--region=REGION \
--delivery-pipeline=DELIVERY_PIPELINE
--image=IMAGE_TAG=REGION-docker.pkg.dev/PROJECT/cloud-run-source-deploy/IMAGE_NAME

后续步骤