このページは Cloud Translation API によって翻訳されました。

起動後のスクリプトを使用する

このガイドでは、Colab Enterprise で起動後スクリプトを使用する方法について説明します。このガイドでは、起動後スクリプトで使用する環境変数を設定する方法についても説明します。

概要

起動後スクリプトを使用すると、Colab Enterprise ランタイムの起動プロセス後にタスクを実行できます。たとえば、起動後のスクリプトを使用して、特定のパッケージをインストールしたり、ランタイムの VM に特定の変更を加えたりできます。

Colab Enterprise で起動後スクリプトを使用するには、ランタイムテンプレートの作成時に起動後スクリプトを指定します。次に、そのランタイムテンプレートに基づいてランタイムを作成すると、起動プロセスの最後に起動後スクリプトが実行されます。

起動後のスクリプトの場所

起動後スクリプトの URI は次のいずれかになります。

Cloud Storage URI: たとえば、gs://BUCKET_NAME/SCRIPT_FILE_NAME。起動後のスクリプトが Cloud Storage に保存されている場合は、エンドユーザー認証情報が有効になっているランタイムを使用する必要があります。これは、Colab Enterprise がユーザー認証情報を使用して Cloud Storage バケットにアクセスするためです。
HTTPS URL: 例: https://example.com/FOLDER_NAME/SCRIPT_FILE_NAME。 Google Cloud コンソールを使用してランタイムテンプレートを作成する場合、HTTPS URL の使用はサポートされていません。

起動後のスクリプトの動作

起動後スクリプトの動作を指定できます。次の表をご覧ください。

動作	説明
1 回だけ実行（`RUN_ONCE`）	デフォルト。Colab Enterprise は、ランタイムの作成時に起動後スクリプトを 1 回だけ実行します。
開始されるたびに実行（`RUN_EVERY_START`）	起動するたびに、Colab Enterprise は起動後のスクリプトを実行します。たとえば、アイドルタイムアウトによってランタイムが停止した場合、ランタイムが再起動されると、Colab Enterprise は起動後スクリプトを再度実行します。
開始されるたびにダウンロードして実行（`DOWNLOAD_AND_RUN_EVERY_START`）	起動するたびに、Colab Enterprise は起動後のスクリプトをソースから再ダウンロードし、スクリプトを実行します。

環境変数

ランタイムテンプレートで環境変数を指定し、起動後のスクリプトでこれらの変数を参照できます。

たとえば、環境変数を使用して割り当てプロジェクトを設定できます。 Google Cloudクライアントライブラリで使用される共通変数である GOOGLE_CLOUD_QUOTA_PROJECT を使用して、割り当てプロジェクトを特定のプロジェクト ID に設定できます。

環境変数で起動後のスクリプトを使用するには、起動後のスクリプトと環境変数を使用してランタイムテンプレートを作成するをご覧ください。

起動後スクリプトの変更を追跡して復元する

起動後のスクリプトの変更を追跡し、特定のバージョンの起動後のスクリプトの復元を有効にするには、オブジェクトのバージョニングが有効になっている Cloud Storage バケットに起動後のスクリプトを保存します。オブジェクトのバージョニングでは、削除されたオブジェクトをバージョニングされた非現行バージョンのオブジェクトとして保持します。このオブジェクトは、明示的に削除されるまでバケットでアクセス可能です。

起動後のスクリプトのバージョンを指定するには、ランタイムテンプレートの作成時に、起動後のスクリプトの URI に #GENERATION_NUMBER を追加します（例: gs://BUCKET_NAME/FOLDER_NAME/FILE_NAME.py#GENERATION_NUMBER）。オブジェクトのバージョニングと世代番号の詳細については、オブジェクトのバージョニングをご覧ください。

Google Cloud コンソールを使用してランタイムテンプレートを作成する場合、起動後スクリプトの世代番号を指定することはできません。

始める前に

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
- Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
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
Verify that billing is enabled for your Google Cloud project.
Enable the Vertex AI, Dataform, and Compute Engine APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the APIs

必要なロール

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

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

1 つ以上の必須ロールに dataform.repositories.list 権限が含まれています。プロジェクトで dataform.repositories.list 権限またはコード作成者（roles/dataform.codeCreator）ロールが付与されているユーザーは、Dataform API または Dataform コマンドラインインターフェース（CLI）を使用して、そのプロジェクトのコードアセットの名前を一覧取得できます。BigQuery Studio を使用する管理者以外のユーザーは、自身が作成したコードアセットまたは自分と共有されているコードアセットのみを表示できます。

起動後スクリプトを使用するランタイムテンプレートを作成する

起動後のスクリプトを使用するランタイムテンプレートを作成するには、 Google Cloud コンソール、Google Cloud CLI、または REST API を使用します。

コンソール

起動後スクリプトを使用するランタイムテンプレートを作成するには、次の操作を行います。

Google Cloud コンソールで、Colab Enterprise の [ランタイムテンプレート] ページに移動します。

[ランタイムテンプレート] に移動
[ 新しいテンプレート] をクリックします。

[ランタイムテンプレートの新規作成] ダイアログが表示されます。
[ランタイムの基本情報] セクションで表示名を入力します。
[リージョン] メニューで、ランタイムテンプレートを配置するリージョンを選択します。
[環境] セクションの [起動後スクリプト] フィールドで、[参照] をクリックし、Cloud Storage にある起動後スクリプトに移動します。詳細については、起動後のスクリプトの場所をご覧ください。
起動後スクリプトの URL で、起動後スクリプトの動作を選択します。デフォルトの動作は [1 回実行] です。詳細については、起動後のスクリプトの動作をご覧ください。
[ネットワーキングとセキュリティ] セクションで、[エンドユーザーの認証情報を有効にする] が選択されていることを確認します。
ダイアログの残りの部分を入力して、[作成] をクリックします。

ランタイムテンプレートが [ランタイムテンプレート] タブのリストに表示されます。

gcloud

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

DISPLAY_NAME: ランタイムテンプレートの表示名。
PROJECT_ID: プロジェクト ID。
REGION: ランタイムテンプレートを配置するリージョン。
POST_STARTUP_SCRIPT_URI: 起動後のスクリプトの URI。詳細については、起動後のスクリプトの場所をご覧ください。
POST_STARTUP_SCRIPT_BEHAVIOR: 起動後のスクリプトの動作。起動後のスクリプトの動作をご覧ください。

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

Linux、macOS、Cloud Shell

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" \
    --project=PROJECT_ID \
    --region=REGION \
    --machine-type=e2-standard-4 \
    --post-startup-script-url=POST_STARTUP_SCRIPT_URI \
    --post-startup-script-behavior=POST_STARTUP_SCRIPT_BEHAVIOR

Windows（PowerShell）

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" `
    --project=PROJECT_ID `
    --region=REGION `
    --machine-type=e2-standard-4 `
    --post-startup-script-url=POST_STARTUP_SCRIPT_URI `
    --post-startup-script-behavior=POST_STARTUP_SCRIPT_BEHAVIOR

Windows（cmd.exe）

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" ^
    --project=PROJECT_ID ^
    --region=REGION ^
    --machine-type=e2-standard-4 ^
    --post-startup-script-url=POST_STARTUP_SCRIPT_URI ^
    --post-startup-script-behavior=POST_STARTUP_SCRIPT_BEHAVIOR

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

REST

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

REGION: ランタイムテンプレートを配置するリージョン。
PROJECT_ID: 実際のプロジェクト ID。
DISPLAY_NAME: ランタイムテンプレートの表示名。
POST_STARTUP_SCRIPT_URI: 起動後のスクリプトの URI。詳細については、起動後のスクリプトの場所をご覧ください。
POST_STARTUP_SCRIPT_BEHAVIOR: 起動後のスクリプトの動作。起動後のスクリプトの動作をご覧ください。

HTTP メソッドと URL:

POST https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates

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

{
  "displayName": "DISPLAY_NAME",
  "machineSpec": {
    "machineType": "e2-standard-4"
  },
  softwareConfig: {
    postStartupScriptConfig: {
      postStartupScriptUrl: "POST_STARTUP_SCRIPT_URI",
      postStartupScriptBehavior: "POST_STARTUP_SCRIPT_BEHAVIOR"
    },
  },
  "networkSpec": {
    "enableInternetAccess": true
  }
}

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

curl

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザーアカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

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

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

PowerShell

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザーアカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

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

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

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates" | Select-Object -Expand Content

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

詳しくは、notebookRuntimeTemplates.create REST API のドキュメントをご覧ください。

ランタイムを作成する

起動後スクリプトを使用するランタイムテンプレートを作成したら、そのランタイムテンプレートに基づいてランタイムを作成します。ランタイムが起動し、指定された動作に従って起動後のスクリプトが実行されます。ランタイムを作成するをご覧ください。

起動後スクリプトと環境変数を含むランタイムテンプレートを作成する

起動後のスクリプトと環境変数を使用するランタイムテンプレートを作成するには、 Google Cloud コンソール、Google Cloud CLI、または REST API を使用します。

コンソール

起動後スクリプトと環境変数を使用するランタイムテンプレートを作成する手順は次のとおりです。

Google Cloud コンソールで、Colab Enterprise の [ランタイムテンプレート] ページに移動します。

[ランタイムテンプレート] に移動
[ 新しいテンプレート] をクリックします。

[ランタイムテンプレートの新規作成] ダイアログが表示されます。
[ランタイムの基本情報] セクションで表示名を入力します。
[リージョン] メニューで、ランタイムテンプレートを配置するリージョンを選択します。
[環境] セクションの [起動後スクリプト] フィールドで、[参照] をクリックし、Cloud Storage にある起動後スクリプトに移動します。詳細については、起動後のスクリプトの場所をご覧ください。
起動後スクリプトの URL で、起動後スクリプトの動作を選択します。デフォルトの動作は [1 回実行] です。詳細については、起動後のスクリプトの動作をご覧ください。
環境変数を追加するには、[ 環境変数を追加] をクリックして、キーと値のペアを入力します。さらに環境変数を追加するには、この手順を繰り返します。
[ネットワーキングとセキュリティ] セクションで、[エンドユーザーの認証情報を有効にする] が選択されていることを確認します。
ダイアログの残りの部分を入力して、[作成] をクリックします。

ランタイムテンプレートが [ランタイムテンプレート] タブのリストに表示されます。

gcloud

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

DISPLAY_NAME: ランタイムテンプレートの表示名。
PROJECT_ID: プロジェクト ID。
REGION: ランタイムテンプレートを配置するリージョン。
POST_STARTUP_SCRIPT_URI: 起動後のスクリプトの URI。詳細については、起動後のスクリプトの場所をご覧ください。
POST_STARTUP_SCRIPT_BEHAVIOR: 起動後のスクリプトの動作。起動後のスクリプトの動作をご覧ください。
ENV_VARIABLE_NAME: ランタイムに設定する環境変数の名前。
ENV_VARIABLE_VALUE: ランタイムに設定する環境変数の値。

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

Linux、macOS、Cloud Shell

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" \
    --project=PROJECT_ID \
    --region=REGION \
    --machine-type=e2-standard-4 \
    --post-startup-script-url=POST_STARTUP_SCRIPT_URI \
    --post-startup-script-behavior=POST_STARTUP_SCRIPT_BEHAVIOR \
    --set-env-vars=ENV_VARIABLE_NAME=ENV_VARIABLE_VALUE

Windows（PowerShell）

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" `
    --project=PROJECT_ID `
    --region=REGION `
    --machine-type=e2-standard-4 `
    --post-startup-script-url=POST_STARTUP_SCRIPT_URI `
    --post-startup-script-behavior=POST_STARTUP_SCRIPT_BEHAVIOR `
    --set-env-vars=ENV_VARIABLE_NAME=ENV_VARIABLE_VALUE

Windows（cmd.exe）

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" ^
    --project=PROJECT_ID ^
    --region=REGION ^
    --machine-type=e2-standard-4 ^
    --post-startup-script-url=POST_STARTUP_SCRIPT_URI ^
    --post-startup-script-behavior=POST_STARTUP_SCRIPT_BEHAVIOR ^
    --set-env-vars=ENV_VARIABLE_NAME=ENV_VARIABLE_VALUE

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

REST

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

REGION: ランタイムテンプレートを配置するリージョン。
PROJECT_ID: 実際のプロジェクト ID。
DISPLAY_NAME: ランタイムテンプレートの表示名。
POST_STARTUP_SCRIPT_URI: 起動後のスクリプトの URI。詳細については、起動後のスクリプトの場所をご覧ください。
POST_STARTUP_SCRIPT_BEHAVIOR: 起動後のスクリプトの動作。起動後のスクリプトの動作をご覧ください。
ENV_VARIABLE_NAME: ランタイムに設定する環境変数の名前。
ENV_VARIABLE_VALUE: ランタイムに設定する環境変数の値。

HTTP メソッドと URL:

POST https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates

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

{
  "displayName": "DISPLAY_NAME",
  "machineSpec": {
    "machineType": "e2-standard-4"
  },
  softwareConfig: {
    postStartupScriptConfig: {
      postStartupScriptUrl: "POST_STARTUP_SCRIPT_URI",
      postStartupScriptBehavior: "POST_STARTUP_SCRIPT_BEHAVIOR"
    },
    "env": [
      {
        "name": "ENV_VARIABLE_NAME",
        "value": "ENV_VARIABLE_VALUE"
      }
    ]
  },
  "networkSpec": {
    "enableInternetAccess": true
  }
}

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

curl

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

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

PowerShell

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

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

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates" | Select-Object -Expand Content

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

詳しくは、notebookRuntimeTemplates.create REST API のドキュメントをご覧ください。

ランタイムを作成する

制限事項

Colab Enterprise で起動後スクリプトを使用する場合は、次の制限事項を考慮してください。

起動後スクリプトを含むランタイムテンプレートに基づいてランタイムを作成するには、そのランタイムテンプレートのオーナーであり、作成者である必要があります。
起動後スクリプトを介した環境変数の受け渡しはサポートされていません。このガイドで説明するように、ソフトウェア構成で環境変数を指定する必要があります。
Cloud Storage にある起動後スクリプトを使用するには、エンドユーザー認証情報が有効になっているランタイムを使用する必要があります。また、ユーザー認証情報で Cloud Storage バケットにアクセスできる必要があります。
Google Cloud コンソールを使用してランタイムテンプレートを作成する場合は、起動後スクリプトが Cloud Storage に存在する必要があります。 Google Cloud コンソールを使用してランタイムテンプレートを作成する場合、他の場所にある起動後スクリプトはサポートされていません。
Google Cloud コンソールを使用してランタイムテンプレートを作成する場合、起動後スクリプトの世代番号を指定することはできません。

次のステップ

ランタイムを作成して接続する。
ランタイムを管理するには、ランタイムを管理するをご覧ください。
ランタイムとランタイムテンプレートの詳細を確認する。

起動後のスクリプトを使用する

概要

起動後のスクリプトの場所

起動後のスクリプトの動作

環境変数

起動後スクリプトの変更を追跡して復元する

始める前に

必要なロール

起動後スクリプトを使用するランタイム テンプレートを作成する

コンソール

gcloud

Linux、macOS、Cloud Shell

Windows（PowerShell）

Windows（cmd.exe）

REST

curl

PowerShell

ランタイムを作成する

起動後スクリプトと環境変数を含むランタイム テンプレートを作成する

コンソール

gcloud

Linux、macOS、Cloud Shell

Windows（PowerShell）

Windows（cmd.exe）

REST

curl

PowerShell

ランタイムを作成する

制限事項

次のステップ

起動後スクリプトを使用するランタイムテンプレートを作成する

起動後スクリプトと環境変数を含むランタイムテンプレートを作成する