Manage runtimes

This page describes how to manage a Colab Enterprise runtime, including the following tasks:

Start a runtime.
Stop a runtime.
Disconnect from a runtime.
Reconnect to a runtime.
Change the runtime that you are connected to.
Delete a runtime.

Required roles

To get the permissions that you need to manage a Colab Enterprise runtime, ask your administrator to grant you the Colab Enterprise User ( roles/aiplatform.colabEnterpriseUser ) IAM role on the project. For more information about granting roles, see Manage access to projects, folders, and organizations .

You might also be able to get 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.

Start a runtime

To start a runtime, you can use the Google Cloud console, the gcloud CLI, or the REST API.

Console

To start a runtime:

In the Google Cloud console, go to the Colab Enterprise Runtimespage.

Go to Runtimes
In the Regionmenu, select the region that contains your runtime.
Select the runtime that you want to start.
Click Start.

gcloud

Before using any of the command data below, make the following replacements:

RUNTIME_ID : the ID of your runtime.
PROJECT_ID : your project ID.
REGION : the region where your runtime is located.

Execute the following command:

Linux, macOS, or Cloud Shell

gcloud  
colab  
runtimes  
start  
 RUNTIME_ID 
  
 \ 
  
--project = 
 PROJECT_ID 
  
 \ 
  
--region = 
 REGION

Windows (PowerShell)

gcloud  
colab  
runtimes  
start  
 RUNTIME_ID 
  
 ` 
  
--project = 
 PROJECT_ID 
  
 ` 
  
--region = 
 REGION

Windows (cmd.exe)

gcloud  
colab  
runtimes  
start  
 RUNTIME_ID 
  
^  
--project = 
 PROJECT_ID 
  
^  
--region = 
 REGION

For more information about the command for creating a runtime template from the command line, see the gcloud CLI documentation .

REST

Before using any of the request data, make the following replacements:

REGION : the region where your runtime is located.
PROJECT_ID : your project ID.
RUNTIME_ID : the ID of your runtime.

HTTP method and URL:

POST https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
:start

To send your request, choose one of these options:

curl

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell , which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list .

Execute the following command:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d "" \
"https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
:start"

PowerShell

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list .

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
:start" | Select-Object -Expand Content

If successful, the response body contains an instance of Operation .

For more information, see the notebookRuntimes.start REST API documentation .

Stop a runtime

To stop a runtime, you can use the gcloud CLI or the REST API.

gcloud

Before using any of the command data below, make the following replacements:

RUNTIME_ID : the ID of your runtime.
PROJECT_ID : your project ID.
REGION : the region where your runtime is located.

Execute the following command:

Linux, macOS, or Cloud Shell

gcloud  
colab  
runtimes  
stop  
 RUNTIME_ID 
  
 \ 
  
--project = 
 PROJECT_ID 
  
 \ 
  
--region = 
 REGION

Windows (PowerShell)

gcloud  
colab  
runtimes  
stop  
 RUNTIME_ID 
  
 ` 
  
--project = 
 PROJECT_ID 
  
 ` 
  
--region = 
 REGION

Windows (cmd.exe)

gcloud  
colab  
runtimes  
stop  
 RUNTIME_ID 
  
^  
--project = 
 PROJECT_ID 
  
^  
--region = 
 REGION

For more information about the command for stopping a runtime from the command line, see the gcloud CLI documentation .

REST

Before using any of the request data, make the following replacements:

REGION : the region where your runtime is located.
PROJECT_ID : your project ID.
RUNTIME_ID : the ID of your runtime.

HTTP method and URL:

POST https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
:start

To send your request, choose one of these options:

curl

Execute the following command:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d "" \
"https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
:start"

PowerShell

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
:start" | Select-Object -Expand Content

If successful, the response body contains an instance of Operation .

For more information, see the notebookRuntimes.stop REST API documentation .

Disconnect from a runtime

To disconnect from a runtime:

In the Google Cloud console, go to the Colab Enterprise My notebookspage.

Go to My notebooks
In the Regionmenu, select the region that contains your notebook.
Open the notebook that you want to disconnect from the runtime.
In the header toolbar, click Runtime > Manage sessions. If you don't see the header toolbar, click Toggle header visibility.
In the Active sessionspane, click the End sessionbutton.
Click Terminate.

Reconnect to a runtime

To reconnect to a runtime:

In the Google Cloud console, go to the Colab Enterprise My notebookspage.

Go to My notebooks
In the Regionmenu, select the region that contains your notebook.
Open a notebook that was recently disconnected from a runtime.
In the top right corner of the notebook, click Reconnect.

If the runtime that the notebook was previously connected to is still running, Colab Enterprise connects to it. If that runtime isn't running anymore, it connects to the default runtime.

Change the runtime

To change the runtime that you are connected to:

In the Google Cloud console, go to the Colab Enterprise My notebookspage.

Go to My notebooks
In the Regionmenu, select the region that contains your notebook.
Open a notebook that is connected to a runtime.
In the top right corner of the notebook, click Additional connection options > Change runtime type.
Complete the dialog to connect to a runtime .

Delete a runtime

To delete a runtime, you can use the Google Cloud console, the gcloud CLI, or the REST API.

Console

To delete a runtime:

In the Google Cloud console, go to the Colab Enterprise Runtimespage.

Go to Runtimes
In the Regionmenu, select the region that contains your runtime.
Select the runtime that you want to delete.
Click Delete.
Click Confirm.

gcloud

Before using any of the command data below, make the following replacements:

RUNTIME_ID : the ID of your runtime.
PROJECT_ID : your project ID.
REGION : the region where your runtime is located.

Execute the following command:

Linux, macOS, or Cloud Shell

gcloud  
colab  
runtimes  
delete  
 RUNTIME_ID 
  
 \ 
  
--project = 
 PROJECT_ID 
  
 \ 
  
--region = 
 REGION

Windows (PowerShell)

gcloud  
colab  
runtimes  
delete  
 RUNTIME_ID 
  
 ` 
  
--project = 
 PROJECT_ID 
  
 ` 
  
--region = 
 REGION

Windows (cmd.exe)

gcloud  
colab  
runtimes  
delete  
 RUNTIME_ID 
  
^  
--project = 
 PROJECT_ID 
  
^  
--region = 
 REGION

For more information about the command for creating a runtime template from the command line, see the gcloud CLI documentation .

REST

Before using any of the request data, make the following replacements:

REGION : the region where your runtime is located.
PROJECT_ID : your project ID.
RUNTIME_ID : the ID of your runtime.

HTTP method and URL:

DELETE https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID

To send your request, choose one of these options:

curl

Execute the following command:

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
"

PowerShell

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https:// REGION 
-aiplatform.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ REGION 
/notebookRuntimes/ RUNTIME_ID 
" | Select-Object -Expand Content

If successful, the response body contains an instance of Operation .

For more information, see the notebookRuntimes.delete REST API documentation .

What's next

Learn more about runtimes and runtime templates .
Create a runtime template .