Skip to content

Commit fd73473

Browse files
Readme changes for prebuilt gcluster usage (GoogleCloudPlatform#5153)
1 parent aaf82e3 commit fd73473

1 file changed

Lines changed: 43 additions & 2 deletions

File tree

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,49 @@ is the recommended path to get started with the Cluster Toolkit.
3939

4040
---
4141

42-
If a self directed path is preferred, you can use the following commands to
43-
build the `gcluster` binary:
42+
### Using the Pre-built Bundle (Recommended)
43+
44+
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.
45+
46+
#### Bundle Compatibility Matrix
47+
48+
The pre-built bundles are compiled for Linux and macOS execution environments and support the deployment of the following cluster operating systems.
49+
50+
##### Execution Platform (Where the binary runs)
51+
52+
| Platform | Support Status | Notes |
53+
| :--- | :---: | :--- |
54+
| **Linux** || Pre-compiled on Debian Bullseye. |
55+
| **Google Cloud Shell** || Native support via the Linux binary. |
56+
| **macOS** || Native support via the Mac binary. |
57+
| **Windows** || Please [Build from Source](#building-from-source). |
58+
59+
1. Download and extract the bundle:
60+
61+
```shell
62+
# Find all available releases at: https://github.com/GoogleCloudPlatform/cluster-toolkit/releases
63+
# Set the desired version TAG (e.g., v1.82.0)
64+
TAG=vX.Y.Z
65+
# Replace gcluster-bundle.zip with the platform-specific filename (e.g., gcluster_bundle_linux.zip)
66+
curl -LO https://github.com/GoogleCloudPlatform/cluster-toolkit/releases/download/${TAG}/gcluster-bundle.zip
67+
unzip gcluster-bundle.zip -d gcluster-bundle/
68+
cd gcluster-bundle
69+
chmod +x gcluster
70+
```
71+
72+
> **_NOTE:_** The binary is available starting with version 1.82.0
73+
74+
2. Verify the Installation:
75+
76+
```shell
77+
./gcluster --version
78+
./gcluster --help
79+
```
80+
81+
### Building from Source
82+
83+
If you prefer to build the `gcluster` binary from source,
84+
you can use the following commands:
4485

4586
```shell
4687
git clone https://github.com/GoogleCloudPlatform/cluster-toolkit

0 commit comments

Comments
 (0)