Release candidate: v1.89.0 (#5561)

Author: siddhartha-quad

.github/workflows/cache-metadata.yml

@@ -0,0 +1,65 @@
+# Copyright 2026 "Google LLC"
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Cache Release Metadata for Telemetry
+
+on:
+  push:
+    tags:
+    - 'v*' # Triggers on any tag starting with 'v'
+
+jobs:
+  update-firestore-cache:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: 'read'
+      id-token: 'write' # Required for Workload Identity Federation
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+
+    - name: Setup Go
+      uses: actions/setup-go@v5
+      with:
+        go-version-file: 'go.mod'
+
+    - name: Authenticate to Google Cloud
+      uses: google-github-actions/auth@v2
+      with:
+        workload_identity_provider: 'projects/266450182917/locations/global/workloadIdentityPools/github-pool/providers/github-provider'
+        service_account: 'cache-metadata@hpc-toolkit-gsc.iam.gserviceaccount.com'
+
+    - name: Extract Tag Name
+      id: extract_tag
+      run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+
+    - name: Populate Firestore Cache (with up to 3 retries)
+      run: |
+        for i in 1 2 3; do
+          echo "Attempt $i..."
+          if go run tools/cache_metadata/main.go -version ${{ env.VERSION }}; then
+            echo "Success!"
+            exit 0
+          fi
+
+          echo "Attempt $i failed."
+          if [ $i -lt 3 ]; then
+            echo "Waiting 10 seconds before retrying..."
+            sleep 10
+          fi
+        done
+
+        echo "All 3 attempts failed. Aborting."
+        exit 1

Makefile

@@ -33,7 +33,7 @@ endif
 
 gcluster: warn-go-version warn-terraform-version warn-packer-version $(shell find ./cmd ./pkg gcluster.go -type f)
 	$(info **************** building gcluster ************************)
-	@go build -ldflags="-X 'main.gitTagVersion=$(GIT_TAG_VERSION)' -X 'main.gitBranch=$(GIT_BRANCH)' -X 'main.gitCommitInfo=$(GIT_COMMIT_INFO)' -X 'main.gitCommitHash=$(GIT_COMMIT_HASH)' -X 'main.gitInitialHash=$(GIT_INITIAL_HASH)'" gcluster.go
+	@go build -ldflags="-X 'main.gitTagVersion=$(GIT_TAG_VERSION)' -X 'main.gitBranch=$(GIT_BRANCH)' -X 'main.gitCommitInfo=$(GIT_COMMIT_INFO)' -X 'main.gitCommitHash=$(GIT_COMMIT_HASH)' -X 'main.gitInitialHash=$(GIT_INITIAL_HASH)' -X 'main.gitIsOfficial=$(GIT_IS_OFFICIAL)'" gcluster.go
 	@ln -sf gcluster ghpc
 
 ghpc: gcluster

README.md

@@ -58,9 +58,9 @@ The pre-built bundles are compiled for Linux and macOS execution environments an
 
 1. Download and extract the bundle:
 
-    > **_NOTE:_** The binary is available starting with version 1.82.0 [Only supports x86/amd64 arch]. Multi-architecture builds (amd64 and arm64) are available starting with version 1.85.0.
+    > **_NOTE:_** The binary is available starting with version 1.82.0 [Only supports x86/amd64 arch]. Multi-architecture builds (amd64 and arm64) are available starting with version 1.85.0. Tarball bundles (.tgz) are supported starting with version 1.89.0.
 
-    For versions v1.85.0 and newer (Multi-architecture):
+    For versions v1.85.0 and newer (Multi-architecture Zip):
 
     ```shell
     # Find all available releases at: https://github.com/GoogleCloudPlatform/cluster-toolkit/releases
@@ -71,9 +71,21 @@ The pre-built bundles are compiled for Linux and macOS execution environments an
     ARCH="amd64"
     # Download and extract the platform-specific bundle
     curl -LO https://github.com/GoogleCloudPlatform/cluster-toolkit/releases/download/${TAG}/gcluster_bundle_${OS}_${ARCH}.zip
-    unzip gcluster_bundle_${OS}_${ARCH}.zip -d gcluster-bundle/
-    cd gcluster-bundle
-    chmod +x gcluster
+    unzip gcluster_bundle_${OS}_${ARCH}.zip -d cluster-toolkit/
+    cd cluster-toolkit
+    ```
+
+    For versions v1.89.0 and newer (Multi-architecture Tarball):
+
+    ```shell
+    # Find all available releases at: https://github.com/GoogleCloudPlatform/cluster-toolkit/releases
+    # Set the desired version TAG (e.g., v1.89.0)
+    TAG=vX.Y.Z
+    # Set your OS (linux or mac) and Architecture (amd64 or arm64)
+    OS="linux"
+    ARCH="amd64"
+    # Download and extract the platform-specific bundle in a single step
+    mkdir -p cluster-toolkit && curl -L https://github.com/GoogleCloudPlatform/cluster-toolkit/releases/download/${TAG}/gcluster_bundle_${OS}_${ARCH}.tgz | tar -xz -C cluster-toolkit && cd cluster-toolkit
     ```
 
     For versions v1.82.0 through v1.84.0:
@@ -86,9 +98,8 @@ The pre-built bundles are compiled for Linux and macOS execution environments an
     OS="linux"
     # Download and extract
     curl -LO https://github.com/GoogleCloudPlatform/cluster-toolkit/releases/download/${TAG}/gcluster_bundle_${OS}.zip
-    unzip gcluster_bundle_${OS}.zip -d gcluster-bundle/
-    cd gcluster-bundle
-    chmod +x gcluster
+    unzip gcluster_bundle_${OS}.zip -d cluster-toolkit/
+    cd cluster-toolkit
     ```
 
 2. Verify the Installation:

cluster-toolkit-writers.json

@@ -73,5 +73,8 @@
   },
   {
     "login": "AdarshK15"
+  },
+  {
+    "login": "rahimkhan19"
   }
 ]

cmd/README.md

@@ -19,6 +19,7 @@ gcluster [SUBCOMMAND]
 * [`expand`](#gcluster-expand): Expand the blueprint without creating a new deployment
 * [`completion`](#gcluster-completion): Generate completion script
 * [`help`](#gcluster-help): Display help information for any command
+* [`destroy`](#gcluster-destroy): Destroys all resources in a Toolkit deployment directory
 
 ### Flags - gcluster
 
@@ -41,6 +42,14 @@ gcluster --version
 gcluster deploy (<DEPLOYMENT_DIRECTORY> | <BLUEPRINT_FILE>) [flags]
 ```
 
+### Flags - deploy
+
+* `--only <strings>`: Only apply to groups with the given names (comma-separated).
+* `--skip <strings>`: Skip groups with the given names (comma-separated).
+* `--auto-approve`: Automatically approve proposed changes without prompting.
+
+Refer to the [Selective Deployment and Exclusion Guide](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/examples/machine-learning/README.md#selective-deployment-and-destruction-using---only-and---skip-flags) for more information on managing or skipping specific group deployments.
+
 ## gcluster create
 
 `gcluster create` creates a deployment directory. This deployment directory is used to deploy a cluster on Google Cloud.
@@ -111,3 +120,21 @@ details for a specific command, for example `expand`, run the following command:
 ```bash
 gcluster help expand
 ```
+
+## gcluster destroy
+
+`gcluster destroy` destroys all resources in a Toolkit deployment directory.
+
+### Usage - destroy
+
+```bash
+gcluster destroy DEPLOYMENT_DIRECTORY [flags]
+```
+
+### Flags - destroy
+
+* `--only <strings>`: Only destroy groups with the given names (comma-separated).
+* `--skip <strings>`: Skip destroying groups with the given names (comma-separated).
+* `--robust`: Perform a robust destroy, including firewall rule cleanup.
+
+Refer to the [Selective Deployment and Exclusion Guide](https://github.com/GoogleCloudPlatform/cluster-toolkit/blob/main/examples/machine-learning/README.md#selective-deployment-and-destruction-using---only-and---skip-flags) for more information on managing or skipping specific group destruction.

cmd/root.go

@@ -39,6 +39,7 @@ var (
 	GitCommitInfo  string
 	GitCommitHash  string
 	GitInitialHash string
+	GitIsOfficial  string
 )
 
 var (
@@ -76,7 +77,11 @@ func Execute() error {
 
 	if len(GitCommitInfo) > 0 {
 		if len(GitTagVersion) == 0 {
-			GitTagVersion = "- not built from official release"
+			if GitIsOfficial == "true" {
+				GitTagVersion = "(official binary distribution)"
+			} else {
+				GitTagVersion = "- not built from official release"
+			}
 		}
 		if len(GitBranch) == 0 {
 			GitBranch = "detached HEAD"

community/examples/xpk-n2-filestore/kueue-xpk-configuration.yaml.tftpl

@@ -1,10 +1,10 @@
-apiVersion: kueue.x-k8s.io/v1beta1
+apiVersion: kueue.x-k8s.io/v1beta2
 kind: ResourceFlavor
 metadata:
   name: "1x${machine_type}-${vms_per_slice}"
 spec: {}
 ---
-apiVersion: kueue.x-k8s.io/v1beta1
+apiVersion: kueue.x-k8s.io/v1beta2
 kind: ClusterQueue
 metadata:
   name: cluster-queue
@@ -18,7 +18,7 @@ spec:
       - name: "cpu"
         nominalQuota: ${cpu_count}
 ---
-apiVersion: kueue.x-k8s.io/v1beta1
+apiVersion: kueue.x-k8s.io/v1beta2
 kind: LocalQueue
 metadata:
   name: multislice-queue

community/examples/xpk-n2-filestore/xpk-n2-filestore.yaml

@@ -31,7 +31,7 @@ vars:
   slice_vm_count: 2
   slice_cpu_count: 64
   xpk_version: v0.8.0
-  kueue_version: v0.11.1
+  kueue_version: v0.17.1
   jobset_version: 0.10.1
   kjob_version: f775609365df47bdc3e7c10290d8efae7f512464
 

community/modules/compute/gke-nodeset/versions.tf

@@ -22,6 +22,6 @@ terraform {
     }
   }
   provider_meta "google" {
-    module_name = "blueprints/terraform/hpc-toolkit:gke-nodeset/v1.88.0"
+    module_name = "blueprints/terraform/hpc-toolkit:gke-nodeset/v1.89.0"
   }
 }

community/modules/compute/gke-partition/versions.tf

@@ -22,6 +22,6 @@ terraform {
     }
   }
   provider_meta "google" {
-    module_name = "blueprints/terraform/hpc-toolkit:gke-partition/v1.88.0"
+    module_name = "blueprints/terraform/hpc-toolkit:gke-partition/v1.89.0"
   }
 }