Stay organized with collections
Save and categorize content based on your preferences.
Cluster Toolkit uses a cluster blueprint
to define a deployment. For each blueprint, you can use the deployment_groups
setting to define a set of modules that customize your
deployment. These modules specify options such as your compute
resources, networking, schedulers, monitoring applications, and file systems.
This document outlines the core supported module options for Cluster Toolkit
v1.3.0
or higher. For a complete list of supported modules including the experimental
options, see the
modules
page on the Cluster Toolkit GitHub repository documentation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eCluster Toolkit defines deployments using a cluster blueprint, which can be customized with modules for compute resources, networking, schedulers, monitoring, and file systems.\u003c/p\u003e\n"],["\u003cp\u003eSupported file systems include Cloud Storage, Parallelstore, DDN EXAscaler Lustre, Filestore, Network File Sharing (NFS), and the integration of pre-existing file systems or Kubernetes Persistent Volumes.\u003c/p\u003e\n"],["\u003cp\u003eThe toolkit supports various schedulers such as Batch, Google Kubernetes Engine (GKE), HTCondor, PBS Professional, and Slurm.\u003c/p\u003e\n"],["\u003cp\u003eCluster Toolkit offers extensive customization for Compute Engine resources, including all machine types, VM placement policies, GPU integration, advanced networking, and spot VMs.\u003c/p\u003e\n"],["\u003cp\u003eIt also facilitates software installation, including Spack and Ansible, and features like GPU accelerated Chrome Remote Desktop, Google Cloud Observability Ops Agent, and custom image building with Packer.\u003c/p\u003e\n"]]],[],null,["# Supported modules\n\nCluster Toolkit uses a [cluster blueprint](/cluster-toolkit/docs/setup/cluster-blueprint)\nto define a deployment. For each blueprint, you can use the `deployment_groups`\nsetting to define a set of modules that customize your\ndeployment. These modules specify options such as your compute\nresources, networking, schedulers, monitoring applications, and file systems.\n\nThis document outlines the core supported module options for Cluster Toolkit\n[v1.3.0](https://github.com/GoogleCloudPlatform/cluster-toolkit/tags)\nor higher. For a complete list of supported modules including the experimental\noptions, see the\n[modules](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/modules)\npage on the Cluster Toolkit GitHub repository documentation.\n\nSupported file systems\n----------------------\n\nThe following file systems are supported:\n\n- [Cloud Storage](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/community/modules/file-system/cloud-storage-bucket)\n- [Managed Lustre](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/modules/file-system/managed-lustre)\n- [Filestore](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/modules/file-system/filestore)\n- [Network File Sharing (NFS)](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/community/modules/file-system/nfs-server)\n\nYou can also specify that Cluster Toolkit integrates a\n[pre-existing file system](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/modules/file-system/pre-existing-network-storage)\ninto your deployment.\n\nCluster Toolkit also supports the use of\n[Kubernetes Persistent Volumes and Persistent Volume Claims](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/modules/file-system/gke-persistent-volume)\nas a connector to cloud-based file systems.\n\nSupported schedulers\n--------------------\n\nThe following schedulers are supported:\n\n- [Batch](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/modules/scheduler/batch-job-template)\n- [Google Kubernetes Engine (GKE)](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/modules/scheduler/gke-cluster)\n- [HTCondor](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/community/modules/scheduler/htcondor-setup)\n- [PBS Professional](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/community/modules/scheduler/pbspro-server)\n- [Slurm](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/community/modules/compute/schedmd-slurm-gcp-v6-partition)\n\nSupported Compute Engine resources\n----------------------------------\n\nThe following features are supported for [Compute Engine resources](/compute/docs/instances):\n\n- [VM creation](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/modules/compute/vm-instance) - many of the core VM customization options are supported\n including, but not limited to, the following:\n\n - Machine type options: *all machine types*\n - VM instance placement policy options: *both compact and spread placement\n policies*\n - GPU integration: *all GPU types*\n - Advanced networking: *all options including gVNIC support and Tier\n 1 higher bandwidths*\n - Service account setup\n - Disabling simultaneous multithreading (SMT)\n - Startup scripts\n - Spot VMs\n\nSupported monitoring options\n----------------------------\n\nThe following tools are supported for collecting measurements of your service\nand Google Cloud resources:\n\n- [Cloud Monitoring](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/modules/monitoring/dashboard)\n\nSupported networking resources\n------------------------------\n\nThe following features are supported for [Virtual Private Cloud (VPC) resources](/vpc/docs/overview):\n\n- Create a [new VPC network](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/modules/network/vpc)\n- Integrate with [existing VPC networks](https://github.com/GoogleCloudPlatform/cluster-toolkit/tree/main/modules/network/pre-existing-vpc)\n\nSupported software installation and system setup\n------------------------------------------------\n\nCluster Toolkit can be used for the following use cases:\n\n- Automation of application installations by using Spack\n- Ansible installation\n- [GPU accelerated Chrome Remote Desktop](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/community/modules/remote-desktop/chrome-remote-desktop/README.md)\n- Google Cloud Observability [Ops Agent](/stackdriver/docs/solutions/agents/ops-agent) installation and setup\n- Network File System (NFS) client installation and automatic mounting\n- Custom image building [automation with Packer](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/modules/packer/custom-image/README.md)\n\nWhat's next\n-----------\n\n- Review how to [prepare your cluster blueprint](/cluster-toolkit/docs/setup/cluster-blueprint).\n- Try a quickstart tutorial, see [Deploy an HPC cluster with Slurm](/cluster-toolkit/docs/quickstarts/slurm-cluster)."]]