ランタイム テンプレートを管理する

このページでは、Colab Enterprise ランタイム テンプレートを管理する方法について説明します。これには、次のタスクが含まれます。

  • ランタイム テンプレートを編集する。
  • ランタイム テンプレートを削除する。

必要なロール

Colab Enterprise ランタイム テンプレートを管理するために必要な権限を取得するには、プロジェクトに対するColab Enterprise 管理者 （roles/aiplatform.colabEnterpriseAdmin）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

ランタイム テンプレートを編集する

Python バージョンや暗号鍵構成など、ランタイム テンプレートの仕様の一部を変更できます。ランタイム テンプレートに対する変更は、このテンプレートから新しく作成されたランタイムにのみ適用されます。

ランタイム テンプレートを編集するには、 Google Cloud コンソールまたは REST API を使用します。

コンソール

ランタイム テンプレートを編集する手順は次のとおりです。

  1. コンソールで、Colab Enterprise の [Runtime templates] ページに移動します。 Google Cloud

    [ランタイム テンプレート] に移動

  2. [**リージョン**] メニューで、ランタイム テンプレートを含むリージョンを選択します。

  3. [ID] 列で、編集するランタイム テンプレートの ID 番号をクリックします。

  4. [Edit] をクリックします。

  5. [ランタイム テンプレートの編集] パネルで、ランタイム テンプレートを変更します。

  6. [更新] をクリックします。

REST

リクエストのデータを使用する前に、 次のように置き換えます。

  • REGION: ランタイム テンプレートが配置されているリージョン。
  • PROJECT_ID: プロジェクト ID。
  • NOTEBOOK_RUNTIME_TEMPLATE_ID: ランタイム テンプレートの ID。
  • RELEASE_NAME: 使用するイメージのリリース名。 たとえば、py311 は Python 3.11 イメージのリリース名です。イメージを Latest に設定するには、RELEASE_NAME を空のままにします。

HTTP メソッドと URL: 

PATCH https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates/NOTEBOOK_RUNTIME_TEMPLATE_ID?updateMask=software_config.colab_image.release_name

リクエストの本文（JSON）: 

{
  softwareConfig: {
    colabImage: {
      releaseName: "RELEASE_NAME"
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates/NOTEBOOK_RUNTIME_TEMPLATE_ID?updateMask=software_config.colab_image.release_name"

PowerShell

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates/NOTEBOOK_RUNTIME_TEMPLATE_ID?updateMask=software_config.colab_image.release_name" | Select-Object -Expand Content
成功した場合、レスポンスの本文には Operationのインスタンスが含まれます。

使用可能なクエリ パラメータについては、 notebookRuntimeTemplates.patch REST API ドキュメントをご覧ください。

ランタイム テンプレートを削除する

ランタイム テンプレートを削除するには、 Google Cloud コンソール、 gcloud CLI、または REST API を使用します。

コンソール

ランタイム テンプレートを削除する手順は次のとおりです。

  1. コンソールで、Colab Enterprise の [Runtime templates] ページに移動します。 Google Cloud

    [ランタイム テンプレート] に移動

  2. [**リージョン**] メニューで、ランタイム テンプレートを含むリージョンを選択します。

  3. 削除するランタイム テンプレートを選択します。

  4. [ Delete] をクリックします。

  5. [確認] をクリックします。

gcloud

後述のコマンドデータを使用する前に、次のように置き換えます。

  • RUNTIME_ID: ランタイムの ID。
  • PROJECT_ID: プロジェクト ID。
  • REGION: ランタイムが配置されているリージョン。

次のコマンドを実行します。

Linux、macOS、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

コマンドラインからランタイム テンプレートを削除するコマンドの詳細については、gcloud CLI ドキュメントをご覧ください。

REST

リクエストのデータを使用する前に、 次のように置き換えます。

  • REGION: ランタイムが配置されているリージョン。
  • PROJECT_ID: プロジェクト ID。
  • RUNTIME_ID: ランタイムの ID。

HTTP メソッドと URL: 

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

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

次のコマンドを実行します。

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

次のコマンドを実行します。 

$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
成功した場合、レスポンスの本文には Operationのインスタンスが含まれます。

詳細については、notebookRuntimeTemplates.delete REST API ドキュメントをご覧ください。

次のステップ