开始在 Cloud Deploy 中使用 Skaffold

本文档介绍如何在 Cloud Deploy 中开始使用 Skaffold，具体内容如下：

  • 配置 Skaffold 以与 Cloud Deploy 交付流水线搭配使用
  • 将 Skaffold 和 Cloud Deploy 与第三方渲染工具（例如 Helm 和 Kustomize）搭配使用
  • （可选）使用 Skaffold 进行本地开发
  • （可选）使用 Skaffold 实现持续集成和持续部署 (CI/CD)

为什么选择 Skaffold？

想知道 Cloud Deploy 为何使用 Skaffold，以及为什么需要管理 Skaffold 配置？请继续阅读。

我拥有 CI/CD 方面的经验，但目前不使用 Skaffold

Skaffold 是一个开源命令行工具，可提高开发者的工作效率。它可以编排持续开发、持续集成 (CI) 和持续交付 (CD)。

Skaffold 使用可插入架构提供声明性可移植配置，允许您在渲染阶段使用不同的工具。

创建版本后，Cloud Deploy 会调用 Skaffold 来呈现清单。在部署时，Cloud Deploy 会再次调用 Skaffold 以应用这些清单，从而将您的应用部署到进度中的每个目标。部署后，Skaffold 会执行健康检查，以监控目标运行时是否成功部署。

使用 Skaffold 实现持续开发

如果您使用 Skaffold 进行持续开发，系统会在您更改代码时构建和测试映像，并将其部署到集群（或 Minikube）。Cloud Code for VS Code 和 Cloud Code for IntelliJ IDE 扩展程序将 Skaffold 集成到 Visual Studio Code 和 JetBrains IDE 中，以实现持续开发。

使用 Skaffold 实现持续交付

您还可以使用 Skaffold 实现持续交付，包括构建、部署、渲染和应用步骤。Cloud Deploy 使用 Skaffold 的渲染和应用功能。如需使用 Cloud Deploy，您至少需要一个有效的 skaffold.yaml 配置文件。

通过 Skaffold，您还可以与第三方清单管理工具集成，例如 Helm 和 Kustomize。通过以这种方式使用 Skaffold，您可以使用这些工具的功能来呈现清单。kubectl 仍然是这些清单的deployer。

我刚开始接触 Kubernetes 的部署

借助 Skaffold，您可以为所有部署配置一组基本清单。然后，您可以通过 Cloud Deploy 使用 Skaffold 的渲染引擎，通过其中一个基本清单渲染和部署每个特定于部署的清单。

详细了解如何管理清单，包括将 Skaffold 和 Cloud Deploy 与常用清单模板工具（如 Helm 和 Kustomize）搭配使用的示例。

Cloud Deploy 正常运行需要满足什么条件？

如需使用基本的 Cloud Deploy 交付流水线，skaffold.yaml 配置文件至少需要以下配置：

  • 所有 skaffold.yaml 配置都需要的标头信息：

    apiVersion: skaffold/v2beta28
Kind: Config

  • deploy Stanza，包含 deploy.kubectl（用于部署到 GKE 或 GKE Enterprise）或 deploy.cloudrun（用于部署到 Cloud Run）。

    对于 GKE：

    deploy:
  kubectl:
    manifests:
    - ...

    在 manifests stanza 中，包含所有 Kubernetes 原始清单的列表。如果您打算使用渲染程序（如 Helm 或 Kustomize）来呈现清单，请参阅向 skaffold.yaml 添加 Kustomize 支持和向 skaffold.yaml 添加 Helm 支持，以获得有关如何配置 Skaffold 以使用这些工具的指导。

    对于 Cloud Run：

    metadata:
  name:
manifests:
  rawYaml:
  - ...
deploy:
  cloudrun: {}

创建 skaffold.yaml 文件

Google Cloud Deploy 使用 Skaffold 呈现和部署应用。

您至少需要提供一个 skaffold.yaml 文件来识别要使用的清单。示例如下：

apiVersion: skaffold/v2beta28
kind: Config
deploy:
  kubectl:
    manifests:
      - MANIFEST

在此配置中，MANIFEST 是指向要由 Skaffold 处理的清单的路径。

让 Cloud Deploy 生成 skaffold.yaml

如果您没有 skaffold.yaml 文件，但有单个 Kubernetes 清单或 Cloud Run 服务定义文件，则 Cloud Deploy 可以为您生成 skaffold.yaml 文件。

发布完成后，生成的 Skaffold 文件将出现在 Cloud Storage 源暂存目录中。

以下命令包含 --from-k8s-manifest 标志，用于传递 Kubernetes 清单。Cloud Deploy 使用清单中的信息生成 skaffold.yaml，然后将其用于版本。

gcloud deploy releases create  RELEASE_NAME --delivery-pipeline=PIPELINE_NAME --from-k8s-manifest=MANIFEST --region=REGION

如需从 Cloud Run 服务 YAML 生成 skaffold.yaml，请使用同一命令，但要用 --from-run-manifest 而不是 --from-k8s-manifest

将其中一个标志与 --skaffold-file 标志或 --source 标志一起使用会产生错误。

使用生成的 skaffold.yaml 文件

生成的 skaffold.yaml 适合进行 Cloud Deploy 新手入门、学习和演示。熟悉 Cloud Deploy 后，对于生产工作负载，您可能需要 Skaffold 配置以区分您的目标（使用 Skaffold 配置文件）。

使用生成的 skaffold.yaml 文件作为基础来创建您自己的差异化 Skaffold 配置时，请确保在渲染源归档（而非渲染的文件）中使用该文件。您可以从 **版本详情 **页面上的工件标签页下载渲染源代码。

  • 生成的 skaffold.yaml 包含在 Cloud Storage 存储桶中存储的渲染源中。

    您可以通过下载 .tar.gz 文件并将其解压缩来查看此文件。

  • 渲染的 skaffold.yaml 可在 Target 工件中找到。

    在目标工件部分中，点击查看工件。

    版本详情页面，其中显示了渲染来源和目标工件

使用 Skaffold 进行本地开发

Skaffold 的优势之一是可用于本地开发和 CI/CD。在 dev 模式下，Skaffold 会监控源文件，并在检测到更改时，Skaffold 会重新构建映像、重新测试并重新将容器部署到本地机器上的 minikube 集群（举例而言）。

以这种方式使用 Skaffold 时，您可以在本地使用与远程部署相同的命令。

如果您使用 Skaffold 进行本地开发，则可以为目标定义单独的 Skaffold 配置文件，并为本地开发定义默认的部署节。

当您停止 dev 模式时，Skaffold 会从集群中清理已部署的工件。

使用 Skaffold 实现 CI/CD

除了使用 Skaffold 实现持续的本地构建和部署之外，您还可以使用 Skaffold 实现 CI/CD。给定使用 CI 工具（如 Cloud Build）和映像注册表（如 Artifact Registry）构建的容器映像，Cloud Deploy 利用 Skaffold 中的 CI/CD 功能来渲染和应用清单，并将应用部署到定义的目标。

渲染、部署和应用

Skaffold 将清单呈现流程与部署流程分开。Cloud Deploy 会调用 skaffold render 以呈现清单，并调用 skaffold apply 以将其应用于目标。

通过将渲染与应用分开，您可以在配置中捕获应用的完整声明状态，以便安全、可重复地应用状态（例如，用于回滚）。此方法还可以使审批变得更加简单。由于系统会在首次发布之前为所有目标渲染清单，因此您可以看到将应用于每个目标的渲染 YAML。

Cloud Deploy 不支持使用其他部署者部署应用。不过，您可以使用 Helm 或 Kustomize 等工具进行渲染。

如需详细了解 Cloud Deploy 如何使用 kubectl 作为部署者进行部署，请参阅 Cloud Deploy 服务架构。

Skaffold 配置文件简介

您可以在 profiles: 节中创建单独的 Skaffold 配置文件（在 skaffold.yaml 中标识）。

将 Skaffold 配置文件与 Cloud Deploy 搭配使用时，您可以为所有或部分目标创建单独的配置文件。例如，dev、staging 和 prod 的不同配置文件。

若要在 Cloud Deploy 中使用 Skaffold，并不需要用到配置文件，但配置文件可用于在目标中定义清单自定义，例如为每个目标使用不同的 Kustomize kustomization.yaml 文件。

为您的skaffold.yaml添加 Kustomize 支持

将 Kustomize 配置与 Cloud Deploy/Skaffold 配置集成包括以下步骤：

  1. 在您的配置文件中添加 kustomization.yaml 文件。

    您可以将配置文件存储在本地目录或 Cloud Storage 存储桶中。

  2. 在 skaffold.yaml 文件中，为每个配置文件创建一个 deploy 节。

    如果您未使用配置文件或使用了未与配置文件关联的默认部署配置，则您也可以在任何已定义的配置文件之外添加一个 deploy 节。示例如下：

    apiVersion: skaffold/v2beta28
kind: Config
build:
  artifacts:
    - image: leeroy-web-profiles
      context: leeroy-web-profiles
    - image: leeroy-app-profiles
      context: leeroy-app-profiles
  googleCloudBuild:
    projectId: ${PROJECT_ID}
profiles:
- name: local
  deploy:
    kustomize:
      paths:
        - leeroy-app-profiles/kubernetes/local
- name: test
  deploy:
    kustomize:
      paths:
        - leeroy-app-profiles/kubernetes/test
- name: staging
  deploy:
    kustomize:
      paths:
        - leeroy-app-profiles/kubernetes/staging
- name: prod
  deploy:
    kustomize:
      paths:
        - leeroy-app-profiles/kubernetes/prod

    此处显示的 Skaffold 配置针对 test、staging 和 prod 目标具有单独的配置文件。它还显示用于本地开发的配置文件。 每个配置文件中都有一个 deploy.kustomize 节，其中包含的路径指向要用于该目标的 kustomization 位置。

向 skaffold.yaml 添加 Helm 支持

您可以使用 Helm 呈现清单。Cloud Deploy 不使用 Helm 部署应用，并且仅支持使用 kubectl 作为部署者。

如需使用 Helm，您需要将 Helm 图表或图表存储在 skaffold.yaml 中可引用的任何位置。此位置可以位于文件系统、代码库中（可能与您的 skaffold.yaml 一起），或开放式容器计划 (OCI) 代码库中。

如需使用 Helm 图表，请将 helm 节添加到 skaffold.yaml 文件中。

apiVersion: skaffold/v2beta28
kind: Config
build:
  artifacts:
  - image: skaffold-helm-image
deploy:
  helm:
    releases:
    - name: skaffold-helm-image
      chartPath: charts

skaffold.yaml 参考文档显示了此 helm 节中的要求。

将 kpt 与 Skaffold 搭配使用

我们建议您不要在 Cloud Deploy 中将 kpt 与 Skaffold V1 搭配使用。

不受支持的 Skaffold 功能

无法在 Cloud Deploy 中使用 Skaffold 的以下功能：

后续步骤

  • 访问 Skaffold 网站，了解其工作原理以及用途。

  • 练习如何将 Google Cloud Deploy 与 Kustomize 和 Skaffold 配置文件搭配使用。

  • 了解 Cloud Deploy 如何选择要使用的 Skaffold 版本、Skaffold 版本在何时发生更改，以及如何确定正在使用的版本。

  • 了解如何将 Skaffold 配置文件与 Helm、Kustomize 和 kpt 等高级清单管理工具搭配使用。