Vertex AI Workbench インスタンスを作成する

Vertex AI Workbench インスタンスを作成する

このページでは、 Google Cloud コンソールまたは Google Cloud CLI を使用して Vertex AI Workbench インスタンスを作成する方法について説明します。インスタンスの作成中に、インスタンスのハードウェア、暗号化タイプ、ネットワーク、その他の詳細を構成できます。

始める前に

Vertex AI Workbench インスタンスを作成する前に、次の手順を完了する必要があります。

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.

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 Notebooks API.

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 API

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 Notebooks API.

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 API

注: Notebooks API を使用すると、Vertex AI Workbench リソースを管理できます。Vertex AI リソースの管理については、Vertex AI API をご覧ください。

インスタンスの作成

Vertex AI Workbench インスタンスは、 Google Cloud コンソール、gcloud CLI、または Terraform を使用して作成できます。

コンソール

1. Google Cloud コンソールで [インスタンス] ページに移動します。

   [インスタンス] に移動

2. [新規作成] をクリックします。

3. [新しいインスタンス] ダイアログで、[詳細オプション] をクリックします。

4. [インスタンスを作成] ダイアログの [詳細] セクションで、新しいインスタンスについて次の情報を入力します。

   • 名前: 新しいインスタンスの名前を入力します。名前の先頭は英字で、それに続く最大 62 文字の英小文字、数字、ハイフン（-）で構成します。末尾は英字または数字にしてください。
   • リージョンとゾーン: 新しいインスタンスのリージョンとゾーンを選択します。最適なネットワーク パフォーマンスを得るには、地理的に最も近いリージョンを選択してください。利用可能な Vertex AI Workbench のロケーションをご確認ください。
   • ラベル（省略可）インスタンスのカスタム Key-Value ラベルを指定します。
   • ネットワーク タグ: 省略可。インスタンスのネットワーク タグを指定します。

5. [環境] で、次の情報を入力します。

   • JupyterLab のバージョン: JupyterLab 4（プレビュー）を有効にするには、[JupyterLab 4.x] を選択します。選択を解除すると、インスタンスは JupyterLab 3 を使用します。詳細については、JupyterLab 4 プレビューをご覧ください。
   • バージョン: 最新バージョンまたは以前のバージョンの Vertex AI Workbench インスタンスを使用します。
   • 起動スクリプト: 省略可。[参照] をクリックして、インスタンスの作成後に 1 回だけ実行するスクリプトを選択します。パスは、URL または Cloud Storage パスにする必要があります（例: gs://PATH_TO_FILE/FILE_NAME）。
   • メタデータ: 省略可。インスタンスのカスタム メタデータのキーを指定します。

6. [マシンタイプ] に、次の情報を入力します。

   • マシンタイプ: 新しいインスタンスの CPU 数と RAM 容量を選択します。Vertex AI Workbench により、選択した各マシンタイプの 1 か月あたりの費用見積もりが提示されます。

   • GPU: 省略可。GPU を使用する場合は、新しいインスタンスの GPU のタイプと GPU の数を選択します。使用するアクセラレータ タイプがインスタンスのゾーンで使用可能である必要があります。各ゾーンでのアクセラレータの可用性については、GPU のリージョンとゾーンの可用性をご覧ください。GPU の種類については、Compute Engine の GPU をご覧ください。

     [NVIDIA GPU ドライバを自動的にインストールする] を選択します。

     注: インスタンスのマシンタイプと GPU 構成は、作成後に変更できます。詳細については、Vertex AI Workbench インスタンスのマシンタイプを変更して GPU を構成するをご覧ください。

   • Shielded VM: 省略可。次のチェックボックスをオンまたはオフにします。

     • セキュアブート
     • 仮想トラステッド プラットフォーム モジュール（vTPM）
     • 整合性モニタリング

   • アイドル状態でのシャットダウン: 省略可。

     • シャットダウンまでの分数を変更するには、[シャットダウンまでの非アクティブ時間（分）] フィールドで、値を 10～1440 の整数に変更します。

     • アイドル状態のシャットダウンをオフにするには、[アイドル状態でのシャットダウンを有効にする] をオフにします。

7. [ディスク] セクションで、次の情報を入力します。

   • ディスク: 省略可。デフォルトのデータディスクの設定を変更するには、[Data disk type] と [Data disk size in GB] を選択します。 ディスクタイプの詳細については、ストレージ オプションをご覧ください。

   • ゴミ箱に移動: 省略可。オペレーティング システムのデフォルトのゴミ箱動作を使用するには、このチェックボックスをオンにします。デフォルトのゴミ箱動作を使用する場合、JupyterLab ユーザー インターフェースを使用して削除されたファイルは復元できますが、削除されたファイルはディスク容量を使用します。

   • 暗号化: [Google-managed encryption key] または [顧客管理の暗号鍵（CMEK）] を選択します。CMEK を使用するには、顧客管理の暗号鍵をご覧ください。

8. [ネットワーキング] セクションで、次の情報を入力します。

   • ネットワーキング: 現在のプロジェクトのネットワーク、またはホスト プロジェクトから共有 VPC ネットワーク（構成されている場合）を使用するように、ネットワーク オプションを調整します。ホスト プロジェクトで共有 VPC を使用している場合は、サービス プロジェクトの Notebooks サービス エージェントに Compute ネットワーク ユーザーのロール（roles/compute.networkUser）を付与する必要があります。

     1. [ネットワーク] フィールドで、目的のネットワークを選択します。ネットワークで限定公開の Google アクセスが有効になっているか、インターネットにアクセスできる場合は、VPC ネットワークを選択できます。詳細については、ネットワーク構成オプションをご覧ください。

     2. [サブネットワーク] フィールドで、目的のサブネットワークを選択します。

     3. 外部 IP アドレスを無効にするには、[外部 IP アドレスを割り当て] チェックボックスをオフにします。

     4. プロキシ アクセスを無効にするには、[プロキシ アクセスを許可] チェックボックスをオフにします。

        注: プロキシ アクセスを無効にする場合は、SSH を使用してインスタンスの JupyterLab インターフェースに接続する必要があります。

9. [IAM とセキュリティ] セクションで、次の操作を行います。

   • IAM とセキュリティ: インスタンスの JupyterLab インターフェースへのアクセス権を付与するには、次のいずれかを行います。

     • サービス アカウントを介して JupyterLab へのアクセス権を付与するには、[サービス アカウント] を選択します。

       • デフォルトの Compute Engine サービス アカウントを使用するには、[Use default Compute Engine service account] を選択します。

       • カスタム サービス アカウントを使用するには、[Use default Compute Engine service account] をクリアし、[サービス アカウントのメールアドレス] フィールドにカスタム サービス アカウントのメールアドレスを入力します。

     • JupyterLab インターフェースへのアクセス権を単一ユーザーに付与する手順は次のとおりです。

       1. [シングル ユーザー] を選択し、[ユーザーのメール] フィールドに、アクセス権を付与するユーザー アカウントを入力します。指定したユーザーがインスタンスの作成者でない場合は、指定したユーザーにインスタンスのサービス アカウントに対するサービス アカウント ユーザーのロール（roles/iam.serviceAccountUser）を付与する必要があります。

       2. インスタンスはサービス アカウントを使用して、Google Cloud サービスと API を操作します。

          • デフォルトの Compute Engine サービス アカウントを使用するには、[Use default Compute Engine service account] を選択します。

          • カスタム サービス アカウントを使用するには、[Use default Compute Engine service account] をクリアし、[サービス アカウントのメールアドレス] フィールドにカスタム サービス アカウントのメールアドレスを入力します。

     注: サービス アカウントまたはシングル ユーザー オプションを使用してインスタンスへのアクセスを許可するには、個人のユーザー アカウントのメールアドレスを使用する必要があります。グループ アクセスはサポートされていません。

     アクセス権の付与の詳細については、アクセスを管理するをご覧ください。

   • セキュリティ オプション: 次のチェックボックスをオンまたはオフにします。

     • インスタンスに対するルートアクセス
     • nbconvert
     • ファイルのダウンロード
     • ターミナル アクセス

10. [システムの状態] セクションで、次の情報を入力します。

    • 環境のアップグレードとシステムの状態: 新しくリリースされた環境のバージョンに自動的にアップグレードするには、[環境の自動アップグレード] を選択して、[アップグレードのスケジュール] を完了します。

    • [レポート] で、次のチェックボックスをオンまたはオフにします。

      • システムの状態を報告
      • Cloud Monitoring にカスタム指標を報告する
      • Cloud Monitoring をインストールする
      • 必要な Google ドメインの DNS ステータスを報告する

11. [作成] をクリックします。

    Vertex AI Workbench がインスタンスを作成し、自動的に起動します。インスタンスを使用する準備が整うと、Vertex AI Workbench で [JupyterLab を開く] が有効になります。

gcloud

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

• INSTANCE_NAME: Vertex AI Workbench インスタンスの名前。先頭は英字で、それに続く最大 62 文字の英小文字、数字、ハイフン（-）で構成します。末尾にハイフンは使用できません。
• PROJECT_ID: プロジェクト ID
• LOCATION: インスタンスを配置するゾーン
• VM_IMAGE_PROJECT: VM イメージが属する Google Cloud プロジェクトの ID。サポートされているイメージのデフォルトの Google Cloud プロジェクト ID は cloud-notebooks-managed です。
• VM_IMAGE_NAME: イメージ名。特定のバージョンのイメージ名を確認するには、特定のバージョンを見つけるをご覧ください。
• MACHINE_TYPE: インスタンスの VM のマシンタイプ

• METADATA: このインスタンスに適用するカスタム メタデータ。たとえば、起動後スクリプトを指定するには、post-startup-script メタデータタグを --metadata=post-startup-script=gs://BUCKET_NAME/hello.sh の形式で使用してください。

  JupyterLab 4 プレビューを有効にするには、--metadata=enable-jupyterlab4-preview=true を使用します。詳細については、JupyterLab 4 プレビューをご覧ください。

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

Linux、macOS、Cloud Shell

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

gcloud workbench instances create INSTANCE_NAME \
    --project=PROJECT_ID \
    --location=LOCATION \
    --vm-image-project=VM_IMAGE_PROJECT \
    --vm-image-name=VM_IMAGE_NAME \
    --machine-type=MACHINE_TYPE \
    --metadata=METADATA

Windows（PowerShell）

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

gcloud workbench instances create INSTANCE_NAME `
    --project=PROJECT_ID `
    --location=LOCATION `
    --vm-image-project=VM_IMAGE_PROJECT `
    --vm-image-name=VM_IMAGE_NAME `
    --machine-type=MACHINE_TYPE `
    --metadata=METADATA

Windows（cmd.exe）

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

gcloud workbench instances create INSTANCE_NAME ^
    --project=PROJECT_ID ^
    --location=LOCATION ^
    --vm-image-project=VM_IMAGE_PROJECT ^
    --vm-image-name=VM_IMAGE_NAME ^
    --machine-type=MACHINE_TYPE ^
    --metadata=METADATA

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

Vertex AI Workbench がインスタンスを作成し、自動的に起動します。インスタンスを使用する準備が整うと、Vertex AI Workbench により Google Cloud コンソールの [JupyterLab を開く] リンクが有効化されます。

Terraform

次のサンプルでは、workbench-instance-example という名前の Vertex AI Workbench インスタンスを作成するために google_workbench_instance Terraform リソースが使用されます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

resource "google_workbench_instance" "default" {
  name     = "workbench-instance-example"
  location = "us-central1-a"

  gce_setup {
    machine_type = "n1-standard-1"
    accelerator_configs {
      type       = "NVIDIA_TESLA_T4"
      core_count = 1
    }
    vm_image {
      project = "cloud-notebooks-managed"
      family  = "workbench-instances"
    }
  }
}

JupyterLab 4 プレビュー

プレビュー版 - JupyterLab 4

この機能は サービス固有の規約の対象となります。 一般提供前の機能は「現状のまま」で提供されるものであり、サポートが制限されることがあります。 詳細については、リリース ステージの説明をご覧ください。

このセクションでは、インスタンスの JupyterLab のバージョンを変更する方法について説明します。このセクションでは、JupyterLab 4 を有効にする際に考慮すべき制限事項についても説明します。

既存のインスタンスで JupyterLab のバージョンを変更する

インスタンスの JupyterLab バージョンを変更するには、Google Cloud コンソールまたは gcloud CLI を使用します。

コンソール

既存のインスタンスで JupyterLab のバージョンを変更する手順は次のとおりです。

1. Google Cloud コンソールで [インスタンス] ページに移動します。

   [インスタンス] に移動

2. インスタンスの名前をクリックして、[インスタンスの詳細] ページを開きます。

3. [システム] タブで、次のいずれかを行います。

   • プレビューを有効にするには、[JupyterLab 4 プレビューを有効にする] を選択します。

   • プレビューを無効にして JupyterLab 3 を使用するには、[JupyterLab 4 プレビューを有効にする] チェックボックスをオフにします。

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

5. インスタンスをリセットします。

gcloud

既存のインスタンスで JupyterLab のバージョンを変更するには、次のコマンドを使用します。

gcloud workbench instances update INSTANCE_NAME \
    --project="PROJECT_ID" \
    --location="LOCATION" \
    --metadata=enable-jupyterlab4-preview=ENABLEMENT_BOOLEAN

次のように置き換えます。

• PROJECT_ID: プロジェクト ID
• LOCATION: インスタンスを配置するゾーン
• INSTANCE_NAME: Vertex AI Workbench インスタンスの名前

• ENABLEMENT_BOOLEAN: 次のいずれかを使用します。

  • true: JupyterLab 4 プレビューを有効にします
  • false: JupyterLab 4 プレビューをオフにして、JupyterLab 3 に切り替えます。

制限事項

JupyterLab 4 プレビューを有効にする際は、次の制限事項を考慮してください。

• プレビュー中は、BigQuery や Cloud Storage などの Google Cloud サービスとの統合はサポートされていません。

• カスタム コンテナベースのインスタンスで JupyterLab 4 を有効にすることはサポートされています。Vertex AI Workbench でカスタム コンテナを使用する場合の制限事項をご覧ください。

ネットワーク構成オプション

Vertex AI Workbench インスタンスは、VPC ネットワークの外部にあるサービス エンドポイントにアクセスする必要があります。

このアクセスは、次のいずれかの方法で行えます。

• インスタンスに外部 IP アドレスを割り当てます。これは、新しいインスタンスの作成時にデフォルトで行われます。利用環境が Google API とサービスのアクセス要件を満たしていることを確認してください。

• 限定公開の Google アクセスが有効になっているサブネットにインスタンスを接続します。利用環境が限定公開の Google アクセスの要件を満たしていることを確認してください。

private.googleapis.com または restricted.googleapis.com VIP を使用してサービス エンドポイントにアクセスできるようにする場合は、必要なサービス エンドポイントごとに DNS エントリを追加します。

• notebooks.googleapis.com
• *.notebooks.cloud.google.com
• *.notebooks.googleusercontent.com
• *.kernels.googleusercontent.com

サードパーティの認証情報を持つインスタンスの場合は、次の DNS エントリを追加します。

• *.byoid.googleusercontent.com

ネットワーク タグ

新しい Vertex AI Workbench インスタンスには、ネットワーク タグ deeplearning-vm と notebook-instance が自動的に割り当てられます。



これらのタグを使用すると、VPC ネットワーク ファイアウォール ルールのタグを参照して、Vertex AI Workbench インスタンス間のネットワーク アクセスを管理できます。ネットワーク タグの詳細については、ネットワーク タグを追加するをご覧ください。

Vertex AI Workbench インスタンスのネットワーク タグを表示する手順は、次のとおりです。

1. Google Cloud コンソールで、[VM インスタンス] ページに移動します。

   [VM インスタンス] に移動

2. インスタンスの名前をクリックします。

3. [ネットワーキング] セクションで、ネットワーク タグを見つけます。

トラブルシューティング

インスタンスを作成しているときに問題が発生した場合は、一般的な問題の解決に役立つ Vertex AI Workbench のトラブルシューティングをご確認ください。

次のステップ

• ノートブックを使用して Vertex AI や他の Google Cloud サービスを使い始めるには、Vertex AI ノートブックのチュートリアルをご覧ください。
• Confidential Computing を有効にしてインスタンスを作成します。
• ヘルス ステータスをモニタリングするを参照し、Vertex AI Workbench インスタンスのヘルス ステータスを確認する。
• Vertex AI ネットワーキング設定を簡素化するための Terraform ソリューションについては、 シンプルな Google Cloud ネットワーキング構成ソリューションをご覧ください。
• プライベート IP を使用して Vertex AI Workbench インスタンスを作成できます。Terraform ソリューションについては、Workbench をご覧ください。
• アクセス権の付与の詳細については、アクセスを管理するをご覧ください。
• CMEK を使用するには、顧客管理の暗号鍵をご覧ください。