部署您的应用

本页面介绍了如何使用 Cloud Deploy 将您的应用部署到预期的目标运行时环境。在此之前,您需要创建交付流水线和目标

准备工作

本部分介绍在使用 Cloud Deploy 部署应用之前需要做好哪些准备工作。

  • 确保您的执行服务帐号具有必要的 IAM 角色和权限

  • 创建交付流水线和目标

    Cloud Deploy 可以部署到 Google Kubernetes Engine、Cloud Run 和 GKE Enterprise 集群。目标配置因您要部署到的目标配置而异。

  • 拥有容器映像和清单。

    您需要部署一个或多个容器映像以及一个或多个 Kubernetes 清单(部署到 GKE)或服务 YAML 文件(部署到 Cloud Run)。

    您需要持续集成流水线或一些其他流程来构建和放置映像。您的 CI 工具可以是 Cloud Build、Jenkins 或可生成可提供给 Cloud Deploy 交付流水线的容器映像的任何工具。

  • 有一个 skaffold.yaml 配置文件

    Cloud Deploy 调用 skaffold render 以使用此文件渲染 Kubernetes 清单,并调用 skaffold apply 将其部署到目标中。为此,Skaffold 至少需要一个 skaffold.yaml。您可以通过以下两种方式之一来获取该 ID:

    • 创建您自己的模板。

      请注意,skaffold.yaml 文件必须在第一行中引用与受支持的 Skaffold 版本对应的命名空间,如以下示例所示:

      `apiVersion: skaffold/v4beta7`
      
    • 让它为您生成。

      如果您还没有 skaffold.yaml 文件,可以让 Cloud Deploy 为您创建一个。此文件适用于对 Cloud Deploy 进行初始配置、学习或演示,不应用于生产工作负载。

    如需了解详情,请参阅将 Skaffold 与 Cloud Deploy 搭配使用。此外,在 Cloud Deploy 中管理清单详细介绍了如何将 Skaffold 和 Cloud Deploy 与清单管理工具(如 Helm、Kustomize 和 kpt)搭配使用。

为您选择的运行时环境设置 Cloud Deploy

Cloud Deploy 可以将您的应用部署到以下任何运行时环境:

调用交付流水线以创建版本

将 Cloud Deploy 配置为部署到运行时后,您现在可以根据您创建的交付流水线提交要部署的应用。

  1. 运行常规持续集成 (CI) 流程,以创建一个或多个可部署的工件。

  2. 通过调用 Cloud Deploy 创建一个版本来启动交付流水线。

    从包含 Skaffold 配置的目录中运行以下命令:

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

    由于此命令会创建一个包含目录及其所有子目录的 tar 文件,因此您可能不希望从主目录或根目录运行此命令。您可以从包含 Skaffold 配置的目录中运行该命令,也可以添加 --source= 选项(如后文所述)。

    在此命令中...

    RELEASE_NAME 是为此版本指定的名称。该名称在此交付流水线的所有版本中必须是唯一的。

    您可以通过添加 '$DATE' 和/或 '$TIME' 来指定动态版本名称。例如,如果您在世界协调时间 (UTC) 下午 3:07 调用此命令,则 'rel-$TIME' 将解析为 rel-1507'$DATE''$TIME' 必须采用英文单引号,时间是您调用该命令的机器上的世界协调时间 (UTC)。

    PIPELINE_NAME 是交付流水线的名称,该流水线将在目标的进展过程中管理此版本的部署。此名称必须与流水线定义中的 name 字段匹配。

    REGION 是您要在其中创建版本的区域的名称,例如 us-central1。这是必填项。

此命令将包含您的配置的 tar 文件上传到 Cloud Storage 存储桶并创建发布。Cloud Deploy 还会自动创建发布,并将您的映像部署到交付流水线中定义的第一个目标。

除了此命令中显示的参数之外,您还可以添加以下选项之一:

  • --images=<name=path/name:$IMAGE_SHA>,<name=path/name:$IMAGE_SHA>

    映像名称的集合到映像完整路径替换。

  • --build-artifacts=<path/file>

    对 Skaffold 构建工件输出文件的引用,可以传入该文件来表示映像完整路径替换项。

这两个选项是互斥的。

您还可以添加以下标志之一,让 Cloud Deploy 为您生成 skaffold.yaml 文件:

这两个选项是互斥的。

如果您不希望目录中包含任何文件包含在 tar 文件中,也可以添加 .gcloudignore 文件。

通过 Google Cloud 控制台创建版本

您可以使用 Google Cloud 控制台为交付流水线创建版本。这对于试用 Cloud Deploy 非常有用,但不适合生产工作负载。

以下过程假定您已创建交付流水线以及一个或多个目标。(您也可以使用 Google Cloud 控制台)创建交付流水线。)

  1. 交付流水线详情页面中,对于特定交付流水线,点击创建版本

    显示“创建版本”按钮的交付流水线详细信息

  2. 选择容器字段中,粘贴或输入要部署的容器映像的路径。您也可以使用预先填充在此字段中的默认容器进行评估。

    您还可以点击选择,从 Artifact Registry 或 Container Registry 中选择容器映像。

  3. 版本名称字段中为此版本提供一个唯一的名称,或使用提供的默认名称。

  4. 发布名称字段中提供发布的名称,或使用提供的默认名称。

    此名称用于在此版本中发布到第一个目标。对于后续目标,您可以在升级对话框中或通过 gcloud deploy releases promote 命令为发布命名。

  5. (可选)在说明字段中添加此版本的说明。

  6. 部署详情下,输入 GKE 部署或 Cloud Run 服务的名称,或使用提供的默认名称。

    对于 GKE,Cloud Deploy 会为您生成清单。对于 Cloud Run,Cloud Deploy 会生成用于创建服务的服务定义。

  7. 点击创建

    “创建版本”对话框

Cloud Deploy 使用生成的清单或 Cloud Run 服务定义以及生成的 skaffold.yaml 来创建版本。

更改部署超时时间

对于 GKE 和 GKE Enterprise 目标集群的部署,存在三个单独的超时,它们会影响系统等待 Kubernetes 报告稳定部署的时间:

  • 对于 Cloud Build 对 Cloud Deploy 执行的操作,Cloud Build 将超时操作为 1 小时。

    您可以在执行环境的配置中更改此超时值。

  • Skaffold 具有健康检查超时 (deploy.statusCheckDeadlineSeconds),这是等待部署稳定下来所需的时间(以秒为单位)。

    默认值是 600 秒(10 分钟)。如需使用此超时,必须将 deploy.statusCheck 设置为 true。默认情况下,是的。如果 statusCheckfalse,则不进行状态检查,则在 kubectl apply 成功完成后,发布会被标记为成功。

  • 对于 kind: Deployment 的 Kubernetes 资源,有 Deployment.spec.progressDeadlineSeconds,这是 Kubernetes 等待 Deployment 报告为处于稳定状态的时间。

    此超时仅适用于 Deployment 资源。前两种超时如何协同工作的方法如下:

    • 如果在 Kubernetes 中未设置 Deployment.spec.progressDeadlineSeconds,则 Skaffold 健康检查超时为有效超时,无论是默认超时还是已明确设置。

    • 如果在 Kubernetes 中设置了 Deployment.spec.progressDeadlineSeconds,则 Skaffold 会忽略自己的健康检查超时,而 Kubernetes 进度截止时间为有效超时。但是,如果 Kubernetes 超时被明确设置为 600(10 分钟),则 Skaffold 会假定这是默认值(未设置),并忽略它,并使用 Skaffold 超时(如果已设置)。

    • 如果二者均未设置,则有效超时时间为 Skaffold 默认值 600(10 分钟)。

    Deployment 之外,其他 Kubernetes 资源可能还有超时,这不会影响稳定性超时。如果存在上述任何情况,请检查它们,以确保它们不与稳定性超时冲突。

    如果 Skaffold(或 Cloud Build)超时,GKE 部署将继续运行。Cloud Deploy 显示失败,但仍然可以在 GKE 集群上成功或失败。

如需更改部署稳定性超时设置,请执行以下操作:

  1. 确保在 skaffold.yaml 中将 deploy.statusCheck 设置为 true

    默认为 true。如果值为 true,Skaffold 会等待健康检查以报告稳定的部署,具体取决于下一步中的超时值。

  2. skaffold.yaml 中,将 statusCheckDeadlineSeconds 设置为您要等待的秒数。

    deploy:
      ...
      statusCheck: true
      statusCheckDeadlineSeconds: 600
      ...
    

    默认值为 600(10 分钟)。Skaffold 会等待此时长以获得稳定部署。如果在部署稳定之前超过此时间,则部署将失败。

  3. (可选)您可以在 statusCheckDeadlineSeconds 后面添加 tolerateFailuresUntilDeadline: true

    此设置会指示 Skaffold 在单个部署失败时不退出,但会在 statusCheckDeadlineSeconds 到期之前容忍失败情况。如果您的资源可能需要更多时间(直到状态检查截止时间)才能达到稳定状态,此设置会很有帮助。

    例如,如果您使用的是 Istio 或 Cloud Service Mesh,则部署可能会失败,并显示类似如下的消息:

    error iptables validation failed; workload is not ready for Istio.
    When using Istio CNI, this can occur if a pod is scheduled before the node is ready.
    

    此设置仅适用于 Skaffold 2.0 或更高版本。

  4. 在 Kubernetes 清单中,对于 kind: Deployment 的资源,将 Deployment.spec.progressDeadlineSeconds 设置为与为 statusCheckDeadlineSeconds 设置的值相同的值。

后续步骤