インスタンスの環境をアップグレードする
Gemini Enterprise Agent Platform Workbench インスタンスは、 JupyterLab ノートブック環境が有効になっていて、すぐに使用できる Deep Learning VM Image インスタンスです。 このページでは、Agent Platform Workbench インスタンスの環境をアップグレードする方法について説明します。
アップグレードする理由
次のような理由で、Agent Platform Workbench インスタンスの環境をアップグレードすることがあります。
新しいバージョンの環境でのみ使用できる新機能を使用したい。
新しいバージョンの環境で実装されているフレームワークの更新、パッケージの更新、バグの修正のメリットを活用したい。
アップグレード方法
Agent Platform Workbench インスタンスをアップグレードするには、次の 2 つの方法があります。
自動アップグレード: Agent Platform Workbench インスタンスの作成時に自動アップグレードを有効にします。指定した定期的な期間に、Agent Platform Workbench はインスタンスをアップグレードできるかどうかを確認し、アップグレードできる場合はインスタンスをアップグレードします。
手動アップグレード: 既存の Agent Platform Workbench インスタンスがアップグレードの要件を満たしている場合、インスタンスを手動でアップグレードできます。
要件と制限事項
Agent Platform Workbench との下位互換性は保証されていません。Agent Platform Workbench インスタンスをアップグレードする前に、 データのコピーを作成してください。
特定の Agent Platform Workbench インスタンスをアップグレードできるかどうかを確認するには、次の要件と制限事項をご覧ください。
インスタンスの Google Cloud プロジェクトで Notebooks API を有効にする必要があります。 詳細については、 有効なサービスの一覧と API の有効化をご覧ください。
Agent Platform Workbench インスタンスがコンテナベースの場合、Agent Platform Workbench は OS をアップグレードします。イメージのバージョンは、Dockerfile によって pull されるイメージによって異なります。
アップグレードでイメージの最新バージョンが使用されるように、Dockerfile に
latestタグを含めることを検討してください。
インスタンスのアップグレードができない場合は、 データを新しい Agent Platform Workbench インスタンスに 移行することを検討してください。
アップグレードの仕組み
アップグレード可能な Agent Platform Workbench インスタンスは、1 つのブートディスクとデータディスクを備えたデュアル ディスクです。 アップグレード プロセスでは、データディスク上のデータを保持しながら、ブートディスクが新しいイメージにアップグレードされます。
アップグレードされるコンポーネントと保持されるコンポーネント
次の表に、Agent Platform Workbench インスタンスのどのコンポーネントがアップグレードされ、どのコンポーネントが保持されるかを示します。
| コンポーネント | アップグレード結果 |
|---|---|
| 機械学習のフレームワーク | アップグレードされます |
| 機械学習データ | 保持されます |
| プリインストールされた依存関係 | アップグレードされます |
| ユーザーがインストールしたライブラリ | デフォルトでは、再インストールする必要があります（ユーザーがインストールしたライブラリを参照）。 |
/home/jupyter ディレクトリ内のローカル ファイル |
保持されます |
他の /home/ ディレクトリ内のローカル ファイル |
保持されません |
| プリインストールされたオペレーティング システム パッケージ | アップグレードされます |
| ユーザーがインストールしたオペレーティング システム パッケージ | 保持されません |
| GPU ドライバ | アップグレードされます |
| ノートブック | 保持されます |
| ユーザー構成 | 保持されます |
ユーザーがインストールしたライブラリ
デフォルトでは、Agent Platform Workbench インスタンスは pip ライブラリと Conda ライブラリをブートディスクに格納します。このディスクはアップグレード中に置換されます。pip ライブラリをインストールするときに、--user フラグを含めて /home/jupyter/ ディレクトリにインストールすると、アップグレード時に保持されます。
デフォルトでは、カスタム コンテナから作成されたカーネルに pip ライブラリまたは Conda ライブラリをインストールすると、カーネルの実行中の場合にのみ、ライブラリが保持されます。カーネルを再起動するたびに、これらのライブラリを再インストールする必要があります。カスタム コンテナに永続ライブラリをインストールするには、Dockerfile にライブラリのインストールを含めます。カスタム コンテナから作成したカーネルに pip ライブラリをインストールする場合は、インスタンスが再起動するまでライブラリが保持されるように --user フラグを指定できます。
環境バージョン
Agent Platform Workbench インスタンスには、確認できる環境バージョン番号があります。
コンソールで [インスタンス] ページに移動します。 Google Cloud
インスタンスのリストの [バージョン] 列で、インスタンスの環境のバージョン番号を確認します。
Agent Platform Workbench は環境を定期的に更新しますが（ リリースノートを参照）、 すべての環境ではなく、 リリースされたバージョンごとに更新します。インスタンスのベースとなっている VM イメージの新しい環境バージョンが存在する場合のみ、Agent Platform Workbench はインスタンスをアップグレードします。
特定のバージョンを使用して Agent Platform Workbench インスタンスを作成する方法については、 特定のバージョンの Agent Platform Workbench インスタンスを作成するをご覧ください。
始める前に
アップグレードを行う前に、次の手順を行います。
新しいバージョンへの更新については、リリースノートをご覧ください。
バックアップとしてデータのコピーを作成します。
自動アップグレード
Agent Platform Workbench は、実行中のインスタンスを自動的にアップグレードできます。インスタンスが停止した場合、作成時に自動アップグレードを有効にしていても、インスタンスは自動的にはアップグレードされません。
環境の自動アップグレードを有効にすると、Agent Platform Workbench がインスタンスをアップグレードできるかどうかを確認し、アップグレードできる場合はインスタンスをアップグレードする定期的な期間を指定します。
指定する期間は、notebook-upgrade-schedule
メタデータ エントリとして unix-cron
形式のグリニッジ標準時（GMT）で保存されます。
インスタンスをアップグレードできるかどうかを確認するために、
Agent Platform Workbench は API メソッド
checkUpgradabilityを使用します。
このメソッドは、インスタンスのブートディスク上で、より新しいバージョンのイメージを確認します。
インスタンスをアップグレードできる場合、Agent Platform Workbench は内部アップグレードの方法でインスタンスをアップグレードします。
自動アップグレードを有効にして Agent Platform Workbench インスタンスを作成する
自動アップグレードを有効にして Agent Platform Workbench インスタンスを作成するには、[環境の自動アップグレードを有効にする] チェックボックスをオンにして、インスタンスの作成時にスケジュールを設定します。
自動アップグレードは、 Google Cloud コンソールで指定できます。
Google Cloud コンソールで [インスタンス] ページに移動します。
[新規作成] をクリックします。
[新しいインスタンス] ダイアログで、[詳細オプション] をクリックします。
[インスタンスを作成] ダイアログの [詳細] セクションで、新しいインスタンスについて次の情報を入力します。
- ノートブック名: 新しいインスタンスの名前を入力します。
- リージョンとゾーン: 新しいインスタンスのリージョンとゾーンを選択します。最適なネットワーク パフォーマンスを得るには、地理的に最も近いリージョンを選択してください。 使用可能な Agent Platform Workbench のロケーションをご覧ください。
[システムの状態] セクションで、[環境の自動アップグレード] を選択します。
ノートブックのアップグレード頻度（毎週または毎月）を選択します。
[曜日] フィールドで、目的のオプションを選択します。
[時間] フィールドで時間を選択します。
インスタンス作成ダイアログの残りの部分を入力して、[作成] をクリックします。
自動アップグレード スケジュールを編集する
Agent Platform Workbench インスタンスを作成した後に自動アップグレード スケジュールを編集するには、次の操作を行います。
コンソールで [インスタンス] ページに移動します。 Google Cloud
スケジュールの変更が必要なインスタンス名をクリックします。
[インスタンスの詳細] ページの [環境の自動アップグレード] セクションで、スケジュールを編集します。
[送信] をクリックして変更内容を保存します。
手動でのアップグレード
要件を満たす Agent Platform Workbench インスタンスは、手動でアップグレードできます 。
インスタンスの環境の新しいバージョンを確認する
インスタンスの環境の新しいバージョンが利用可能かどうか確認するには、 Google Cloud コンソールからインスタンスにアクセスします。
Google Cloud コンソールで [インスタンス] ページに移動します。
新しい環境バージョンの可用性を確認するインスタンス名をクリックします。
[インスタンスの詳細] ページで、[VM の詳細] の横にある [Compute Engine で表示] をクリックします。
環境の新しいバージョンが利用可能な場合は、「このインスタンスはアップグレードする必要があります」というメッセージが表示されます。
インスタンスの環境を新しいバージョンにアップグレードする
Agent Platform Workbench インスタンスは、 コンソールで Google Cloud 手動でアップグレードできます。
Google Cloud コンソールで [インスタンス] ページに移動します。
インスタンスが実行中でない場合は、インスタンスを 起動します。 Agent Platform Workbench は、インスタンスが実行中の場合にのみアップグレードできます。
アップグレードするインスタンス名をクリックします。
[インスタンスの詳細] ページで、 [アップグレード] をクリックします。
続行する前に、インスタンスにデータのコピーが作成されていることを確認してください。
データをバックアップしたら、[アップグレード] をクリックします。 Agent Platform Workbench はインスタンスをアップグレードして起動します。
[アップグレード] をクリックします。アップグレードをロールバックする
アップグレードをロールバックするには、次の操作を行います。
Google Cloud コンソールで [インスタンス] ページに移動します。
ロールバックするインスタンス名をクリックします。
On the [Instance details] page, under [Upgrade history], click [Rollback].
Agent Platform Workbench は、インスタンスを以前のバージョンにロールバックします。