开始在 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/v4beta7
  kind: Config
  

• manifests 诗节（适用于 GKE、GKE Enterprise 或 Cloud Run），用于列出所有原始 Kubernetes 清单（除非您使用的是清单管理工具，例如 Helm 或 Kustomize）。

  下面是一个使用原始 Kubernetes 清单的示例：

  manifests:
    rawYaml:
    - deployment.yaml
  

  如果您打算使用渲染程序（例如 Helm 或 Kustomize）来渲染清单，请参阅向 skaffold.yaml 添加 Helm 支持和向 skaffold.yaml 添加 Kustomize 支持，了解如何配置 Skaffold 以使用这些工具。

  如需查看 Helm 和 Kustomize 示例，请参阅管理清单

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

  对于 GKE 和 GKE Enterprise 目标：

  deploy:
    kubectl: {}
  

  部署诗节会部署在清单诗节中提供的应用清单。

  对于 Cloud Run 目标：

  deploy:
    cloudrun: {}
  

  部署诗节会部署清单诗节中提供的应用清单。

如果您使用的是自定义目标，则 skaffold.yaml 必须包含标头 (apiVersion 和 kind:)，以及自定义目标类型尚未引用远程 Skaffold 配置时自定义目标将使用的自定义操作。

创建 skaffold.yaml 文件

Cloud Deploy 使用 Skaffold 渲染和部署应用。

对于每个版本，您至少需要提供一个 skaffold.yaml 文件来标识要使用的清单。如需有关此文件中需要包含的内容的指导，请参阅上一部分。

注意：适用于 VS Code 和 适用于 IntelliJ 的 Cloud Code 插件可帮助您在 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 文件不适用于生产工作负载。

注意：除了让 Cloud Deploy 为您生成文件之外，您还可以让 Skaffold 生成该文件。如需了解详情，请参阅 Skaffold 文档。

使用生成的 skaffold.yaml 文件

生成的 skaffold.yaml 适合初始配置、学习和演示 Cloud Deploy。熟悉 Cloud Deploy 后，对于生产工作负载，您可能需要使用 Skaffold 配置文件来区分目标。

使用生成的 skaffold.yaml 文件作为起点来创建自己的差异化 Skaffold 配置时，请务必使用渲染源代码库中的文件，而不是渲染的文件。您可以从 **版本详情 **页面上的工件标签页下载渲染源代码。

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

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

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

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

  

使用 Skaffold 进行本地开发

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

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

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

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

使用 Skaffold 进行 CI/CD

除了使用 Skaffold 进行持续本地构建和部署之外，您还可以使用 Skaffold 进行 CI/CD。在使用 Cloud Build 等 CI 工具和 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 诗节。

   以下是 Skaffold 配置示例，它会按配置显示 deploy 诗节，并使用名为 my-app 的虚构示例应用：

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

   此处显示的 Skaffold 配置为 test、staging 和 prod 目标提供了单独的配置文件。它还会显示用于本地开发的配置文件。在每个配置文件中，都有一个 deploy.kustomize 诗节，其路径指向要为该目标使用 Kustomization 的位置。

注意： 虽然此配置位于 deploy 诗节中，但 Skaffold 会使用它为预期目标呈现清单，而不是进行部署。

向 skaffold.yaml 添加 Helm 支持

您可以使用 Helm 渲染清单。Cloud Deploy 不会使用 Helm 部署应用，并且仅支持 kubectl 作为部署程序。

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

如需使用 Helm 图表，您需要向 skaffold.yaml 文件添加 helm 节。

注意： 您还可以将 Helm 与 Skaffold 配置文件搭配使用。

apiVersion: skaffold/v4beta7
kind: Config
build:
  artifacts:
  - image: skaffold-helm-image
manifests:
  helm:
    releases:
    - name: skaffold-helm-image
      chartPath: charts
deploy:
  kubectl: {}

skaffold.yaml 参考文档显示了此 helm 诗节中所需的内容。

不受支持的 Skaffold 功能

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

• 生命周期钩子

• 动态 Skaffold 模块

  不支持使用 --module= 为 build、render、apply 等选择特定模块。支持静态模块。

• 在 Helm 中，如果命名空间不存在，则能够创建命名空间。

后续步骤

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

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

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

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