Manage runtimes

Manage runtimes

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

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

Required roles

To ensure that your user account has the necessary permissions to manage a Colab Enterprise runtime, ask your administrator to grant your user account 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.

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.

Start a runtime

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

Console

To start a runtime:

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

   Go to Runtimes

2. In the Region menu, select the region that contains your runtime.

3. Select the runtime that you want to start.

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

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

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

Windows (PowerShell)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

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

Windows (cmd.exe)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

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.

Disconnect from a runtime

To disconnect from a runtime:

1. In the Google Cloud console, go to the Colab Enterprise My notebooks page.

   Go to My notebooks

2. In the Region menu, select the region that contains your notebook.

3. Open the notebook that you want to disconnect from the runtime.

4. In the header toolbar, click Runtime > Manage sessions. If you don't see the header toolbar, click  Toggle header visibility.

5. In the Active sessions pane, click the  End session button.

6. Click Terminate.

Reconnect to a runtime

To reconnect to a runtime:

1. In the Google Cloud console, go to the Colab Enterprise My notebooks page.

   Go to My notebooks

2. In the Region menu, select the region that contains your notebook.

3. Open a notebook that was recently disconnected from a runtime.

4. 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:

1. In the Google Cloud console, go to the Colab Enterprise My notebooks page.

   Go to My notebooks

2. In the Region menu, select the region that contains your notebook.

3. Open a notebook that is connected to a runtime.

4. In the top right corner of the notebook, click  Additional connection options > Change runtime type.

5. Complete the dialog to connect to a runtime.

Delete a runtime

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

Console

To delete a runtime:

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

   Go to Runtimes

2. In the Region menu, select the region that contains your runtime.

3. Select the runtime that you want to delete.

4. Click  Delete.

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

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

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

Windows (PowerShell)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

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

Windows (cmd.exe)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running either gcloud init; or gcloud auth login and gcloud config set project.

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.

What's next

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