Agent Platform Workbench インスタンスを作成する

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

始める前に

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

  1. アカウントにログインします。 Google Cloud を初めて使用する場合は、 アカウントを作成して、実際のシナリオで Google プロダクトのパフォーマンスを評価してください。 Google Cloud新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

  2. 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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

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

  5. 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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

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

    8.

必要なロール

Agent Platform Workbench インスタンスの作成と管理に必要な権限を取得するには、プロジェクトに対するノートブック管理者 （roles/notebooks.admin）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

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

インスタンスの作成

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

コンソール

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

    [インスタンス] に移動

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

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

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

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

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

    • JupyterLab のバージョン: JupyterLab のバージョンを選択します。
    • バージョン: 最新バージョンまたは以前のバージョン の Agent Platform Workbench インスタンスを使用します。
    • 起動スクリプト: 省略可。[参照] をクリックして、インスタンスの作成後に 1 回だけ実行するスクリプトを選択します。パスは、URL または Cloud Storage パスにする必要があります（例: gs://PATH_TO_FILE/FILE_NAME）。
    • メタデータ: 省略可。インスタンスのカスタム メタデータのキーを指定します。インスタンスのカスタム メタデータのキーを指定します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

gcloud

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

  • INSTANCE_NAME：Agent Platform 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 の形式で使用してください。

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

Linux、macOS、Cloud Shell

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）

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）

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 のドキュメントをご覧ください。

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

Terraform

次のサンプルでは、 google_workbench_instance Terraform リソースを使用して、 という名前の Agent Platform Workbench インスタンスを 作成します。workbench-instance-example

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 のバージョンを変更する

このセクションでは、 コンソールまたは gcloud CLI Google Cloud を使用して、インスタンスの JupyterLab のバージョンを変更する方法について説明します。

コンソール

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

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

    [インスタンス] に移動

  2. インスタンスをシャットダウンします。

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

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

    • JupyterLab 3 を有効にするには、[JupyterLab 4 を有効にする] チェックボックスをオフにします。

    • JupyterLab 4 を有効にするには、[JupyterLab 4 を有効にする] チェックボックスをオンのままにします。

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

  6. インスタンスを再起動するには、インスタンスを選択して  [開始] をクリックします。

gcloud

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

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

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

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

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

    • false: JupyterLab 3 に変更します。
    • true: JupyterLab 4 に変更します。デフォルトでは、JupyterLab 4 が有効になっています。

JupyterLab 4 の制限事項

JupyterLab 4 でノートブックの実行をスケジュール設定すると、Agent Platform Workbench はノートブックの現在の状態のコピーを Cloud Storage に保存し、スケジュールに沿ってこのノートブックのコピーを実行します。元のノートブックを編集した場合は、更新されたバージョンのノートブックを実行する新しいスケジュールを作成する必要があります。

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

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

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

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

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

サードパーティの認証情報を使用する場合は、 サードパーティの認証情報、 restricted.googleapis.com を使用して、次の DNS エントリを追加する必要があります。

  • *.byoid.googleusercontent.com
Google Cloud

ネットワーク タグ

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

コンソールのナビゲーション メニューの [仮想マシン] セクション。VM インスタンスが選択され、現在割り当てられているネットワーク タグが表示されています。

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

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

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

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

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

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

トラブルシューティング

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

次のステップ