Stay organized with collections Save and categorize content based on your preferences.
To use Cluster Toolkit, you need a Google Cloud project. In your project, you need to enable APIs, permissions, and grant credentials to Terraform. You also need to clone and build the Cluster Toolkit repository.
Before you beginIn the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.Verify that billing is enabled for your Google Cloud project.
Enable the Compute Engine, Filestore, Cloud Storage, Service Usage, and Resource Manager APIs.
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.Verify that billing is enabled for your Google Cloud project.
Enable the Compute Engine, Filestore, Cloud Storage, Service Usage, and Resource Manager APIs.
To set up Cluster Toolkit, you need to complete the following steps:
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
Note: If you are using a local shell, ensure that you have installed the dependencies. If you use Cloud Shell, the dependencies are already pre-installed. Set a default projectTo set a default project, run the following command:
Replace PROJECT_ID
with your project ID.
gcloud config set project PROJECT_IDEnsure that the default Compute Engine service account is enabled
Cluster Toolkit requires that the default Compute Engine service account is enabled in your project and that the roles/editor
IAM role is enabled on the service account. This is the default setting that is set up by Google Cloud for projects.
However, if you had disabled the default Compute Engine service account and the roles/editor
IAM role in your project, complete the following steps to enable these settings:
Enable the default Compute Engine service account.
gcloud iam service-accounts enable \ --project PROJECT_ID \ PROJECT_NUMBER-compute@developer.gserviceaccount.com
Grant the roles/editor
IAM role to the service account.
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/editor
Replace the following:
PROJECT_ID
: your project IDPROJECT_NUMBER
: the automatically generated unique identifier for your project
For more information, see Identifying projects.
To generate cloud credentials associated with your Google Cloud account, run the following command:
gcloud auth application-default login
This grants the Application Default Credentials (ADC) to Terraform.
Enable OS Login at the project-levelTo be able to connect to a VM in your cluster by using ssh
, you must enable OS Login. If OS Login is already enabled at the organization level, you don't need to enable it on your project.
gcloud compute project-info add-metadata \ --metadata enable-oslogin=TRUEClone the Cluster Toolkit GitHub repository
Clone the GitHub repository:
git clone https://github.com/GoogleCloudPlatform/cluster-toolkit.git
Go to the main working directory:
cd cluster-toolkit/
To build the Cluster Toolkit binary from source, run the following command:
make
To verify the build, run the following command:
./gcluster --version
After building the binary, you are now ready to deploy clusters to run your jobs or workloads.
What's nextExcept as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["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-07 UTC."],[[["Cluster Toolkit requires a Google Cloud project with enabled APIs, permissions, and granted credentials for Terraform."],["Setting up Cluster Toolkit involves configuring your CLI, setting a default project, and enabling the default Compute Engine service account with the `roles/editor` IAM role."],["User access credentials for Terraform can be granted using `gcloud auth application-default login`, but are not required in cloud shell."],["OS Login must be enabled at the project level (or organization level) to allow SSH access to VMs in your cluster."],["The Cluster Toolkit repository needs to be cloned and its binary built using `make`, after which you can deploy clusters."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4