GoogleCloudPlatform/cluster-toolkit

Google Cloud Cluster Toolkit（原 HPC Toolkit）

简介 – 这是一个由 Google 提供的开源工具，帮助您在 Google Cloud 上快速创建和管理 AI/ML 或高性能计算（HPC）集群。它通过让您用简单的 YAML 蓝图 描述集群，然后生成预置资源所需的 Terraform/Packer 代码来实现。

核心组件

• 蓝图 – 捕获所需基础设施（网络、存储、计算、Slurm、GKE 等）的 YAML 文件。
• 模块 – 可复用的 Terraform 或 Packer 构建块（例如 Slurm 控制器、GPU 节点池），由蓝图组装。
• gcluster CLI – 命令行驱动程序，将蓝图转换为自包含的部署文件夹，并为您运行 terraform apply/destroy。
• 部署文件夹 – 包含生成的 Terraform/Packer 文件的目录；您可以对其进行版本控制或用于 CI/CD。

典型工作流程

1. 安装 gcluster 二进制文件（预构建捆绑包或从源代码构建）。
2. 选择或编写蓝图（例如 examples/hpc-slurm.yaml）。
3. 运行 gcluster create <blueprint> → 创建部署文件夹。
4. 运行 gcluster deploy <folder> → 通过 Terraform 预置集群。
5. 使用 gcluster job submit … 在 GKE 集群上启动 AI/ML 工作负载（支持预构建镜像或即时容器构建）。
6. 完成后，运行 gcluster destroy <folder> 删除所有内容。

主要功能

• 部署基于 Slurm 的 HPC 集群（包括 A4、H4D 或自定义虚拟机类型）。
• 部署具有 Kueue、JobSet 以及可选 TPU 切片或 Pathways 支持的 AI 优化 GKE 集群。
• 自动下载缺失的 Terraform/Packer 二进制文件（--download-dependencies）。
• 内置蓝图验证和遥测（可选择退出）。
• 与 Google Cloud AI Hypercomputer 集成，用于大规模 AI 训练。

适用对象

• 需要在 GCP 上获得可复制、可重复的 HPC 或 AI 集群，而不想手动编写 Terraform 的研究人员或工程师。
• 希望通过单一 CLI 同时预置基础设施和提交容器化 AI 作业的团队。
• 需要为基准测试或训练运行快速创建临时集群的 CI/CD 流水线。

安装

• 预构建捆绑包（推荐）：从发布页面下载特定操作系统的 gcluster_bundle_*.tgz，解压后运行 ./gcluster --help。
• 从源代码：git clone https://github.com/GoogleCloudPlatform/cluster-toolkit && make && ./gcluster --version。
• 需要 Go、Terraform，以及（对于 Windows）如果使用基于 shell 的预置器，则需要 WSL2。

快速入门

• 启用所需的 GCP API（Compute、Filestore、Cloud Storage、Service Usage）。
• 使用 gcloud auth application-default login 进行身份验证。
• 选择快速入门指南，例如 Deploy an HPC cluster with Slurm 或 Create a self-managed Slurm cluster with an A4 VM。
• 遵循三步 create → deploy → destroy 周期。

作业提交

• gcluster job submit 适用于启用了 Kueue/JobSet 的 GKE 集群。
• 支持预构建容器镜像和即时构建（--base-image、--build-context）。
• 提供帮助程序来设置默认项目/集群/位置、列出作业、查看日志和取消作业。

高级功能

• 动态 TPU 切片、Pathways 分布式训练编排以及用于大型 AI 工作负载的 GKE Node Auto-Provisioning 标志。

开发

• 使用 pre-commit、TFLint 和 ShellCheck 进行代码检查。
• 贡献指南位于 CONTRIBUTING.md 中。

总结 – Google Cloud Cluster Toolkit 是一个生产级、开源的框架，它抽象了基于 Terraform 的集群预置的复杂性，并提供了统一的 CLI 来管理 Google Cloud 上的基础设施和 AI 作业。