部署 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 作业运行 Canary 部署

    但是,Cloud Run 服务可以使用 Canary 部署。

准备工作

创建目标配置

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

在目标定义中,创建一个 run 节,用于标识将创建 Cloud Run 服务的位置。

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

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

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

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

    您需要为每个目标执行此操作。我们建议为每项 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 节指定了您希望如何部署清单,具体来说就是项目和位置。“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. 点击 Edit,然后将 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. 点击 Edit,然后将 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 角色和权限

后续步骤