ランタイムに接続する

ランタイムに接続する

このページでは、Colab Enterprise でランタイムに接続する方法について説明します。

ノートブックでコードを実行するには、ランタイムに接続する必要があります。ランタイム、はコードを実行するコンピューティング リソースです。

始める前に

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

別の方法で接続する

このページでは、次の方法でランタイムに接続する方法について説明します。

• デフォルトのランタイムを使用する
• 既存のランタイムに接続する
• ランタイムを作成する

デフォルトのランタイムを使用する

このセクションでは、デフォルトのランタイムに接続する方法について説明します。

必要なロール

Colab Enterprise ノートブックで、デフォルトのランタイムに接続するために必要な権限がユーザー アカウントに付与されるように、ユーザー アカウントに対するプロジェクトの Colab Enterprise ユーザー（roles/aiplatform.colabEnterpriseUser）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

管理者は、カスタムロールや他の事前定義ロールを使用して、必要な権限をユーザー アカウントに付与することもできます。

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

デフォルトのランタイムに接続する

ノートブックで初めてコードを実行する場合、別のランタイムを指定しない限り、Colab Enterprise は自動的にデフォルトのランタイムに接続します。

コードを実行せずにデフォルトのランタイムに接続する方法は次のとおりです。

1. Google Cloud コンソールで、Colab Enterprise の [ノートブック] ページに移動します。

   [ノートブック] に移動

2. [リージョン] メニューで、ノートブックを含むリージョンを選択します。

3. [マイ ノートブック] タブで、開きたいノートブックをクリックします。ノートブックをまだ作成していない場合は、ノートブックを作成します。

4. ノートブックで [接続] をクリックします。
   

5. エンドユーザー認証情報を有効にしてランタイムに初めて接続する場合は、[ログイン] ダイアログが表示されます。

   デフォルトのランタイムでは、エンドユーザー認証情報がデフォルトで有効になっています。ユーザー認証情報にアクセスできないランタイムを使用するには、エンドユーザー認証情報を有効にせずにランタイム テンプレートを作成します。

   Colab Enterprise にユーザー認証情報へのアクセス権を付与するには、次の操作を行います。

   1. [ログイン] ダイアログで、ユーザー アカウントをクリックします。

   2. [See, edit, configure, and delete your Google Cloud data...] を選択して、Colab Enterprise にユーザー認証情報へのアクセスを許可します。

      

   3. [続行] をクリックします。

Colab Enterprise がデフォルトのランタイムに接続します。デフォルトのランタイムが実行されていない場合、Colab Enterprise はデフォルトのランタイムを起動してから、接続します。

既存のランタイムに接続する

このセクションでは、[Vertex AI ランタイムへの接続] ダイアログを使用して既存のランタイムに接続する方法について説明します。

必要なロール

Colab Enterprise ノートブックで既存のランタイムに接続するために必要な権限がユーザー アカウントに付与されるように、ユーザー アカウントにプロジェクトに対する Colab Enterprise ユーザー（roles/aiplatform.colabEnterpriseUser）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

管理者は、カスタムロールや他の事前定義ロールを使用して、必要な権限をユーザー アカウントに付与することもできます。

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

既存のランタイムに接続する

既存のランタイムに接続するには:

1. Google Cloud コンソールで、Colab Enterprise の [ノートブック] ページに移動します。

   [ノートブック] に移動

2. [リージョン] メニューで、ノートブックを含むリージョンを選択します。

3. [マイ ノートブック] タブで、開きたいノートブックをクリックします。ノートブックをまだ作成していない場合は、ノートブックを作成します。

4. ノートブックで [Additional connection options] 展開矢印をクリックし、[Connect to a runtime] を選択します。
   

   [Vertex AI ランタイムへの接続] ダイアログが開きます。

5. [Select a runtime] で、[既存のランタイムに接続します] を選択します。

6. [Select an existing runtime option] で、接続するランタイムを選択します。ランタイムがリストにない場合は、ランタイムを作成するか、デフォルトのランタイムに接続してください。

7. [Connect] をクリックします。

8. ランタイムでエンドユーザー認証情報が有効になっていて、エンドユーザー認証情報を有効にして初めてランタイムに接続する場合は、[ログイン] ダイアログが表示されます。

   ユーザー認証情報にアクセスできないランタイムを使用するには、エンドユーザー認証情報を有効にせずにランタイム テンプレートを作成します。

   Colab Enterprise にユーザー認証情報へのアクセス権を付与するには、次の操作を行います。

   1. [ログイン] ダイアログで、ユーザー アカウントをクリックします。

   2. [See, edit, configure, and delete your Google Cloud data...] を選択して、Colab Enterprise にユーザー認証情報へのアクセスを許可します。

      

   3. [続行] をクリックします。

Colab Enterprise がランタイムに接続します。ランタイムが実行されていない場合は、Colab Enterprise がランタイムを起動して接続します。

ランタイムを作成する

このセクションでは、ランタイムを作成して、[Vertex AI ランタイムへの接続] ダイアログを使用して接続する方法について説明します。また、[ランタイム] タブからランタイムを作成することもできます。

必要なロール

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

管理者は、カスタムロールや他の事前定義ロールを使用して、必要な権限をユーザー アカウントに付与することもできます。

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

ランタイムを作成して接続する

[Vertex AI ランタイムへの接続] ダイアログを使用してランタイムを作成し、接続するには:

1. Google Cloud コンソールで、Colab Enterprise の [ノートブック] ページに移動します。

   [ノートブック] に移動

2. [リージョン] メニューで、ノートブックを含むリージョンを選択します。

3. [マイ ノートブック] タブで、開きたいノートブックをクリックします。ノートブックをまだ作成していない場合は、ノートブックを作成します。

4. ノートブックで [Additional connection options] 展開矢印をクリックし、[Connect to a runtime] を選択します。
   

   [Vertex AI ランタイムへの接続] ダイアログが開きます。

5. [Select a runtime] で、[ランタイムを新規作成します] を選択します。

6. [ランタイム テンプレート] メニューで、ランタイム テンプレートを選択します。ランタイム テンプレートがリストにない場合は、ランタイム テンプレートを作成します。

7. [ランタイム名] フィールドにランタイムの名前を入力します。

8. [Connect] をクリックします。

9. 選択したランタイム テンプレートでエンドユーザー認証情報が有効になっていて、エンドユーザー認証情報が有効になったときに初めてランタイムに接続する場合は、[ログイン] ダイアログが表示されます。

   ユーザー認証情報にアクセスできないランタイムを使用するには、エンドユーザー認証情報を有効にせずにランタイム テンプレートを作成します。

   Colab Enterprise にユーザー認証情報へのアクセス権を付与するには、次の操作を行います。

   1. [ログイン] ダイアログで、ユーザー アカウントをクリックします。

   2. [See, edit, configure, and delete your Google Cloud data...] を選択して、Colab Enterprise にユーザー認証情報へのアクセスを許可します。

      

   3. [続行] をクリックします。

Colab Enterprise がデフォルトのランタイムを起動してから、接続します。

ランタイム管理

デフォルトでは、ランタイムを作成すると、そのランタイムの削除（aiplatform.googleapis.com/notebookRuntimes.delete）と開始（aiplatform.googleapis.com/notebookRuntimes.start）に必要な権限が自動的に付与されます。

トラブルシューティング

このセクションでは、Colab Enterprise でのランタイムへの接続に関する問題を解決する方法について説明します。

ランタイムに接続できない

この問題は、いくつかの原因で発生します。デフォルトのランタイムに接続できないもご覧ください。最も一般的な原因は次のとおりです。

ブラウザがサードパーティ Cookie をブロックする

使用しているブラウザが、Colab Enterprise がランタイムとの HTTPS 接続を確立するために使用するサードパーティ Cookie をブロックしています。

この問題を解決するには、ドメイン *.aiplatform-notebook.googleusercontent.com の DATALAB_TUNNEL_TOKEN サードパーティの Cookie を許可するようにブラウザを構成します。

ネットワークがノートブック ドメインへのアウトバウンド トラフィックをブロックする

ネットワークのファイアウォール ルールによって、*.aiplatform-notebook.cloud.google.com または *aiplatform.googleapis.com へのアウトバウンド トラフィックがブロックされています。

この問題を解決するには、*.aiplatform-notebook.cloud.google.com と *aiplatform.googleapis.com へのアウトバウンド トラフィックを許可するようにネットワークのファイアウォール ルールを構成します。

デフォルトのランタイムに接続できない

既存のデフォルトのランタイム テンプレートがない場合に、デフォルトのランタイムに接続しようとすると、次のエラーが発生します。

Failed to connect to runtime

まだ作成されていないデフォルトのランタイムに接続すると、Colab Enterprise はまずデフォルトのランタイム テンプレートを作成し、そのデフォルトのランタイム テンプレートを使用してデフォルトのランタイムを生成します。ただし、ランタイム テンプレートの作成に必要な権限がない場合は、Colab Enterprise はデフォルトのランタイム テンプレートもデフォルトのランタイムも作成できません。

この問題を解決するには、aiplatform.notebookRuntimeTemplates.create 権限を含むロールを付与するよう管理者に依頼してください。

ノートブックがランタイムに接続する速度が遅い

ランタイムへの接続を開始してから数分経過しても、ノートブックの右上に Connecting メッセージが残っており、Colab Enterprise はまだランタイムに接続していません。

この問題を解決するには、数分待ってください。Colab Enterprise はまだランタイムに接続しています。Vertex AI が新しい仮想マシン（VM）インスタンスを割り振るため、まだ実行されていないランタイムへの接続には数分かかることがあります。

ランタイムを作成できない

この問題は、ランタイムを作成できない場合に発生します。デフォルトのランタイムを作成できないもご覧ください。最も一般的な原因は次のとおりです。

リソースを利用できない

ランタイムを作成しようとすると、次のエラーが発生します。

No available zone found for runtime RUNTIME_ID
for machine type MACHINE_TYPE
with accelerator type: ACCELERATOR. Please try again later.

このエラーは、ノートブックのリージョン内にマシンタイプ構成で使用できるリソースがない場合に発生します。

この問題を解決するには、別のマシンタイプ構成でランタイムを試すか、しばらくしてからもう一度お試しください。

デフォルトのランタイムがすでに存在する

デフォルトのランタイムがすでに存在する場合に、デフォルトのランタイム テンプレートからランタイムを作成しようとすると、次のエラーが発生します。

Failed to create runtime

One click runtime already exists.

デフォルトのランタイム テンプレートからランタイムを作成しようとすると、Colab Enterprise はデフォルトのランタイムの作成を試みます。デフォルトのランタイムは、ユーザー、プロジェクト、リージョンごとに 1 つだけ作成できます。デフォルトのランタイムがすでに存在するときに、Colab Enterprise が別のデフォルトのランタイムを作成することはできません。

この問題を解決するには、既存のデフォルトのランタイムに接続するか、デフォルト以外のランタイム テンプレートからランタイムを作成します。

デフォルトのランタイムを作成できない

Colab Enterprise がデフォルトのランタイムを作成するときは、まずデフォルトのランタイム テンプレートを作成し、デフォルトのランタイムの生成に使用します。ランタイム テンプレートの作成に必要な権限がない状態でデフォルトのランタイムを作成しようとすると、Colab Enterprise はデフォルトのランタイムを作成できません。

この問題を解決するには、aiplatform.notebookRuntimeTemplates.create 権限を含むロールを付与するよう管理者に依頼してください。

次のステップ

• ランタイムとランタイム テンプレートの詳細を確認する。
• ランタイム テンプレートを作成する。