GCP¶

The GCP backend type allows provisioning infrastructure and storing artifacts in a GCP account.

Follow the step-by-step guide below to configure this backend in your project.

Enable APIs¶

First, ensure that the required APIs are enabled in your GCP project.

Required APIs

Here's the list of APIs that have to be enabled for the project.

cloudapis.googleapis.com
compute.googleapis.com 
logging.googleapis.com
secretmanager.googleapis.com
storage-api.googleapis.com
storage-component.googleapis.com 
storage.googleapis.com

Create a storage bucket¶

Once the APIs are enabled, proceed and create a storage bucket. dstack will use this bucket to store state and artifacts.

NOTE:

Make sure that the bucket is created in the same region where you plan to provision infrastructure.

Set up GCP credentials¶

dstack support two methods to authenticate with GCP: Default credentials and Service account key.

Default credentials¶

dstack can automatically pick up GCP default credentials set up on your machine. You can use default credentials if you don't want to enter and store GCP credentials in dstack.

Service account key¶

dstack also support authentication using a service account key. Follow this guide to create a service account and configure the following roles for it: Service Account User, Compute Admin, Storage Admin, Secret Manager Admin, and Logging Admin.

Once the service account is set up, create a key for it and download the corresponding JSON file.

Configure the backend¶

Now, log in to the UI, open the project's settings, click Edit, then click Add backend, and select GCP in the Type field.

Fields reference¶

The following fields are required:

Location - (Required) The location where dstack will provision infrastructure and store state and artifacts
Region - (Required) The region where dstack will provision infrastructure and store state and artifacts
Zone - (Required) The zone where dstack will provision infrastructure and store state and artifacts
Bucket - (Required) The storage bucket to store state and artifacts (must be in the same region)

The following arguments are optional:

Service account - (Optional) The JSON file of the service account key to authenticate dstack
Subnet - (Optional) The VPC subnet where dstack will provision infrastructure. If not specified, dstack will use the default VPC and subnet.