Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,49 @@ is the recommended path to get started with the Cluster Toolkit.

---

If a self directed path is preferred, you can use the following commands to
build the `gcluster` binary:
### Using the Pre-built Bundle (Recommended)

For the easiest setup, download the `gcluster_bundle_linux.zip` (for Linux) or `gcluster_bundle_mac.zip` (for macOS) from the [Releases](https://github.com/GoogleCloudPlatform/cluster-toolkit/releases) page. These bundles include the pre-compiled `gcluster` binary, the `examples` folder, and the `community/examples` folder.

#### Bundle Compatibility Matrix

The pre-built bundles are compiled for Linux and macOS execution environments and support the deployment of the following cluster operating systems.

##### Execution Platform (Where the binary runs)

| Platform | Support Status | Notes |
| :--- | :---: | :--- |
| **Linux** | ✅ | Pre-compiled on Debian Bullseye. |
| **Google Cloud Shell** | ✅ | Native support via the Linux binary. |
| **macOS** | ✅ | Native support via the Mac binary. |
| **Windows** | ❎ | Please [Build from Source](#building-from-source). |

1. Download and extract the bundle:

```shell
# Find all available releases at: https://github.com/GoogleCloudPlatform/cluster-toolkit/releases
# Set the desired version TAG (e.g., v1.82.0)
TAG=vX.Y.Z
# Replace gcluster-bundle.zip with the platform-specific filename (e.g., gcluster_bundle_linux.zip)
curl -LO https://github.com/GoogleCloudPlatform/cluster-toolkit/releases/download/${TAG}/gcluster-bundle.zip
unzip gcluster-bundle.zip -d gcluster-bundle/
Comment thread
sudheer-quad marked this conversation as resolved.
cd gcluster-bundle
chmod +x gcluster
```

> **_NOTE:_** The binary is available starting with version 1.82.0

2. Verify the Installation:

```shell
./gcluster --version
./gcluster --help
```

### Building from Source

If you prefer to build the `gcluster` binary from source,
you can use the following commands:

```shell
git clone https://github.com/GoogleCloudPlatform/cluster-toolkit
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ var (
logging.Fatal("cmd.Help function failed: %s", err)
}
},
Version: "v1.81.0",
Version: "v1.82.0",
Annotations: annotation,
}
)
Expand Down
2 changes: 1 addition & 1 deletion community/modules/compute/gke-nodeset/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:gke-nodeset/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:gke-nodeset/v1.82.0"
}
}
2 changes: 1 addition & 1 deletion community/modules/compute/gke-partition/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:gke-partition/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:gke-partition/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ terraform {
}

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:htcondor-execute-point/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:htcondor-execute-point/v1.82.0"
}
}
2 changes: 1 addition & 1 deletion community/modules/compute/mig/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:mig/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:mig/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@
terraform {
required_version = ">= 1.3"
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-nodeset-dynamic/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-nodeset-dynamic/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ terraform {
required_version = ">= 1.3"

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-nodeset-tpu/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-nodeset-tpu/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-nodeset/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-nodeset/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ terraform {
required_version = ">= 1.3"

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-partition/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-partition/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:slurm-cloudsql-federation/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:slurm-cloudsql-federation/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:slurm-cloudsql-federation/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:slurm-cloudsql-federation/v1.82.0"
}

required_version = ">= 0.13.0"
Expand Down
2 changes: 1 addition & 1 deletion community/modules/file-system/nfs-server/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:nfs-server/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:nfs-server/v1.82.0"
}

required_version = ">= 0.14.0"
Expand Down
4 changes: 2 additions & 2 deletions community/modules/files/fsi-montecarlo-on-batch/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:fsi-montecarlo-on-batch/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:fsi-montecarlo-on-batch/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:fsi-montecarlo-on-batch/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:fsi-montecarlo-on-batch/v1.82.0"
}
}
2 changes: 1 addition & 1 deletion community/modules/internal/slurm-gcp/login/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-controller/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-controller/v1.82.0"
}
}
2 changes: 1 addition & 1 deletion community/modules/project/service-enablement/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:service-enablement/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:service-enablement/v1.82.0"
}

required_version = ">= 0.14.0"
Expand Down
4 changes: 2 additions & 2 deletions community/modules/pubsub/bigquery-sub/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:bigquery-sub/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:bigquery-sub/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:bigquery-sub/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:bigquery-sub/v1.82.0"
}
required_version = ">= 1.0"
}
2 changes: 1 addition & 1 deletion community/modules/pubsub/topic/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:topic/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:topic/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:htcondor-access-point/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:htcondor-access-point/v1.82.0"
}

required_version = ">= 1.1"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:htcondor-central-manager/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:htcondor-central-manager/v1.82.0"
}

required_version = ">= 1.1.0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:htcondor-pool-secrets/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:htcondor-pool-secrets/v1.82.0"
}

required_version = ">= 1.3.0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-controller/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-controller/v1.82.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ terraform {
required_version = ">= 1.3"

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-login/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:schedmd-slurm-gcp-v6-login/v1.82.0"
}
}
2 changes: 1 addition & 1 deletion community/modules/scripts/wait-for-startup/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:wait-for-startup/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:wait-for-startup/v1.82.0"
}

required_version = ">= 0.14.0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

terraform {
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:windows-startup-script/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:windows-startup-script/v1.82.0"
}

required_version = ">= 0.14.0"
Expand Down
4 changes: 2 additions & 2 deletions modules/compute/gke-node-pool/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:gke-node-pool/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:gke-node-pool/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:gke-node-pool/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:gke-node-pool/v1.82.0"
}
}
2 changes: 1 addition & 1 deletion modules/compute/resource-policy/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ terraform {
}

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:resource-policy/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:resource-policy/v1.82.0"
}

required_version = ">= 1.3"
Expand Down
4 changes: 2 additions & 2 deletions modules/compute/vm-instance/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:vm-instance/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:vm-instance/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:vm-instance/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:vm-instance/v1.82.0"
}

required_version = ">= 1.3.0"
Expand Down
4 changes: 2 additions & 2 deletions modules/file-system/cloud-storage-bucket/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:cloud-storage-bucket/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:cloud-storage-bucket/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:cloud-storage-bucket/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:cloud-storage-bucket/v1.82.0"
}
required_version = ">= 0.14.0"
}
4 changes: 2 additions & 2 deletions modules/file-system/filestore/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:filestore/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:filestore/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:filestore/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:filestore/v1.82.0"
}

required_version = ">= 1.3.0"
Expand Down
2 changes: 1 addition & 1 deletion modules/file-system/gke-persistent-volume/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:gke-persistent-volume/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:gke-persistent-volume/v1.82.0"
}
}
2 changes: 1 addition & 1 deletion modules/file-system/gke-storage/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ terraform {
required_version = ">= 1.5"

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:gke-storage/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:gke-storage/v1.82.0"
}
}
4 changes: 2 additions & 2 deletions modules/file-system/managed-lustre/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:managed-lustre/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:managed-lustre/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:managed-lustre/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:managed-lustre/v1.82.0"
}

required_version = ">= 1.3.0"
Expand Down
4 changes: 2 additions & 2 deletions modules/file-system/netapp-storage-pool/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ terraform {
}

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:netapp-storage-pool/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:netapp-storage-pool/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:netapp-storage-pool/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:netapp-storage-pool/v1.82.0"
}

required_version = ">= 1.5.7"
Expand Down
4 changes: 2 additions & 2 deletions modules/file-system/netapp-volume/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:netapp-volume/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:netapp-volume/v1.82.0"
}
provider_meta "google-beta" {
module_name = "blueprints/terraform/hpc-toolkit:netapp-volume/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:netapp-volume/v1.82.0"
}

required_version = ">= 1.5.7"
Expand Down
2 changes: 1 addition & 1 deletion modules/management/kubectl-apply/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ terraform {
}

provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:kubectl-apply/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:kubectl-apply/v1.82.0"
}

required_version = ">= 1.3"
Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring/dashboard/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:dashboard/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:dashboard/v1.82.0"
}

required_version = ">= 0.14.0"
Expand Down
2 changes: 1 addition & 1 deletion modules/network/firewall-rules/versions.tf
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ terraform {
}
}
provider_meta "google" {
module_name = "blueprints/terraform/hpc-toolkit:firewall-rules/v1.81.0"
module_name = "blueprints/terraform/hpc-toolkit:firewall-rules/v1.82.0"
}

required_version = ">= 1.5"
Expand Down
Loading
Loading