Create a runtime template

Create a runtime template

This page shows you how to create a runtime template in Colab Enterprise.

To run code in your notebook, you use a compute resource called a runtime. You can use the default runtime or a runtime created from a runtime template. By creating a runtime template, you can configure the template to optimize a runtime's performance, cost, and other characteristics based on your needs.

Learn more about runtimes and runtime templates.

Before you begin

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. 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.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Vertex AI, Dataform, and Compute Engine APIs.

   Enable the APIs

5. 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.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Vertex AI, Dataform, and Compute Engine APIs.

   Enable the APIs

Required roles

To ensure that your user account has the necessary permissions to create a runtime template in Colab Enterprise, ask your administrator to grant your user account the Colab Enterprise Admin (roles/aiplatform.colabEnterpriseAdmin) IAM role on the project. For more information about granting roles, see Manage access.

Your administrator might also be able to give your user account the required permissions through custom roles or other predefined roles.

One or more of the required roles includes the dataform.repositories.list permission. Users who are granted the dataform.repositories.list permission or the Code Creator (roles/dataform.codeCreator) role in a project can list the names of code assets in that project by using the Dataform API or the Dataform command-line interface (CLI). Non-administrators using BigQuery Studio can only see code assets that they created or that were shared with them.

Create the runtime template

To create a runtime template:

1. In the Google Cloud console, go to the Colab Enterprise Runtime Templates page.

   Go to Runtime templates

2. Click  New template.

   The Create new runtime template dialog appears.

Runtime basics

1. In the Runtime basics section, enter a Display name.

2. In the Region menu, select the region where you want your runtime template.

3. Optional: Add a Description of your runtime template.

4. Optional: To add a label, click  Add label, and then enter a Key and Value pair. To add more labels, repeat this step.

5. Click Continue.

Configure compute

1. In the Configure compute section, in the Machine type menu, select a machine type. For information on machine types, see the Machine families resource and comparison guide.

   If you select a machine type that has GPUs, select the Accelerator type and Accelerator count. If you're unable to select the number of GPUs that you want, you might need to increase your quota. See submit a quota increase request.

2. In the Disk type menu, select a disk type.

3. In the Disk size field, enter a size in GB.

4. In the Idle shutdown section:

   • To turn off idle shutdown, clear Enable idle shutdown.

   • To change the inactivity time period, in Time of inactivity before shutdown (Minutes), change the number to the number of minutes of inactivity that you want. In the Google Cloud console, this setting can be set to any integer value from 10 to 1440.

   Idle shutdown is an Experimental setting. Learn more about product launch stages.

5. Click Continue.

Networking and security

1. In the Networking and security section, in the Network menu, select a network. If you don't select a network, your default network is selected.

2. In the Subnetwork menu, select a subnetwork.

3. To turn off public internet access, clear Enable public internet access.

4. To turn off end-user credential access, clear Enable end-user credentials.

Finish creating the runtime template

Click Create to finish creating the runtime template.

Your runtime template appears in the list on the Runtime templates tab.

Granting access to the runtime template

After you create a runtime template, you must grant access to it for a principal to be able to use it. A principal can create a runtime from a runtime template only when they have the following:

• Access to the runtime template.
• The required permissions for creating runtimes.

See Manage access to a runtime template.

Troubleshoot

This section shows you how to resolve issues with creating runtime templates in Colab Enterprise.

Unable to select enough GPUs

While creating a runtime template, you can't select the number of GPUs that you want. This might be because you don't have enough quota.

Colab Enterprise uses Compute Engine quota for GPUs. For more information, see the Compute Engine quota and limits overview.

To resolve this issue, request a higher quota limit.

What's next

• Learn more about runtimes and runtime templates.
• Learn how to create a runtime based on a runtime template.