Using Spanner in a virtual machine instance  |  Google Cloud (2024)

• Home
• Spanner
• Documentation
• Guides

This page describes how to grant your Compute Enginevirtual machine instance permission to access aSpanner database.

Your instance can access the Cloud Spanner API from Compute Engine byusing a service account to act on your behalf. The service account providesapplication default credentialsfor your applications so that you don't need to configure eachCompute Engine instance to use your personal user credentials.

Configure the service account on your instance with one of the followingoptions:

• For easy development and testing, configure your instance touse the default service account with full access to all Cloud APIs.
• For production environments,create a service account with read and write access to your Spanner databasesand apply it to your instance.

Configure an instance with access to all Cloud APIs

To quickly allow your instance to access the Cloud Spanner API, create a new instanceto use the default service account and a scope with full access to all CloudAPIs.

1. Go to the Compute Engine VM instances page.

   Go to the VM instances page

2. Select your project and click Continue.

3. Click Create Instance to start creating a new instance.

4. In the Identity and API access section, click Allow full access to all Cloud APIs.

5. Configure other instance settings as needed, then click Create.

Now that the service account on your Compute Engine instance has accessto the Cloud Spanner API, use a client library to readand write data in your Spanner database. The instance uses thecredentials from the default service account to authenticate with theCloud Spanner API.

Configure an instance with a service account

To restrict instance access to specific APIs and roles, create a serviceaccount with permission only to access your Spannerdatabases. Then, apply the service account to your instance.

1. Select a service account that will act on your behalf to accessSpanner. Use one of the following options:

   • Create a new service account.
   • Identify an existing service accountthat you can use for your instance.

2. Grant a role to the service accountso that it has the necessary permissions to access Spanner. For alist of roles that apply to Spanner, seeAccess Control for Spanner.

3. Go to the Compute Engine VM instances page.

   Go to the VM instances page

4. Select your project and click Continue.

5. Click Create Instance to start creating a new instance.

6. In the Identity and API access section, select the service accountfrom the list under Service account.

7. Configure other instance settings as needed, then click Create.

Now that the service account on your Compute Engine instance has accessto the Cloud Spanner API, use a client library to readand write data in your Spanner database. The instance uses theservice account credentials to authenticate with the Cloud Spanner API.

What's next

• Connect to your instanceand follow a client library tutorial to learn howto read and write data to Spanner from your instance.
• Learn more about service accounts on Compute Engineand how you can use them to grant IAM roles and API access scopes tothe applications that run on your instances.
• Learn how tochange service accounts on existing instances.
• Learn more aboutcreating and starting an Compute Engine instances.