ノートブック サービスの構成

ノートブック サービスが提供する Web ベースの Python ノートブック インターフェイスは、地理空間データ解析に役立ちます。 ノートブックを使用すると、解析を実行し、ワークフローを自動化し、データと解析結果を地理情報ですばやく視覚化することができます。

ノートブックは、コードやリアルタイムの視覚化とマップ、およびデータ ツールを組み合わせることができる環境です。 ノートブック エディターで、Python コードの記述、記録、実行を 1 か所で行えます。

ノートブック サービスには、次の Esri Python リソースが含まれます。

• ArcGIS API for Python: ダイナミック マップと地理空間データ ツールをノートブックに挿入できます
• ArcPy: 組織内で Python スクリプトを実行できます

ライセンス:

この機能は、次の 2 つのライセンス レベルで使用できます。

• ArcGIS Notebook Services ライセンスは、ArcGIS Enterprise on Kubernetes ライセンスに付属しています。 このライセンスを使用すると、組織のメンバーは、ArcGIS Notebook Python 3 Standard ランタイムを使用してノートブックを作成し、スケジュール済みのタスク、Webhook、Web ツールを使用してノートブックのワークフローを自動化できます。
• ArcGIS Notebook Services Advanced ライセンスは、プレミアム機能として使用でき、ArcGIS Notebook Python 3 Advanced ランタイムへのアクセスを提供します。このライセンスには、ArcGIS Notebook Services ライセンスで提供される機能に加えて、追加の ArcPy 機能が含まれています。

注意:

ノートブック サービスをサポートするには、外部のリバース プロキシーまたはロード バランサーが WebSocket トラフィックをバックエンド ターゲットに転送でき、セッションが 10 分間開いたままになるように要件を設定する必要があります。

ノートブック サービスの構成

次の構成手順を実行するには、組織での ArcGIS Enterprise on Kubernetes のデプロイ方法を変更することが必要な場合があります。次に進む前に、注意して調べてください。

ノートブック サービスの有効化

ノートブックサービスを有効化するには、ノートブック ワークスペースを構成し、ArcGIS Enterprise Manager で機能を有効にする必要があります。

注意:

ノートブック サービスを有効化する前に、管理者が、このプレミアム機能をサポートするのに十分なリソース クォータとワーカー ノードを割り当てていることを確認します。

1. ArcGIS Enterprise Manager で、サイドバーの [機能] ボタンをクリックします。

   機能ページが表示されます。

2. [ノートブック サービス] 切り替えボタンをオンにします。

   [ワークスペースの構成] ダイアログ ボックスが表示され、必要な値を指定するよう求められます。 ワークスペースは、各組織のメンバーのノートブックに関連付けられているファイルの保存に使用されます。

3. 必須情報を入力します。
   1. [ボリュームの種類] で、[動的] または [静的] を選択して、ワークスペースの永続ボリュームのプロビジョニング方法を指定します。 PVC が既存の PV にバインドする必要がある場合は [静的] を使用します。 指定したストレージ クラスを使用して新しい PV をプロビジョニングする必要がある場合は、[動的] を使用します。 詳細については、動的プロビジョニングと静的プロビジョニングの考慮事項をご参照ください。

      注意:

      このワークスペースの PV は、種類が FileSystem で、ReadWriteMany (RWX) アクセス モードをサポートしている必要があります。 ノートブック ワークスペースを構成する前に、このワークスペースに割り当てる PV が RWX アクセス モードをサポートしていることを確認します。 さらに、PV をサポートするために、Kubernetes クラスターにサポート ドライバーをインストールする必要がある場合があります。

   2. [ボリューム名] テキストを指定します。

      [静的] を選択した場合、ボリューム名を指定する必要があります。

   3. [ストレージ クラス名] で、独自のストレージ クラス名を指定するか、またはストレージ クラスを設定した場合は、ボリュームのストレージ クラス名を指定します。

      注意:

      ストレージ クラス名は、動的では必須、静的ではオプションです。

      注意:

      ストレージ クラスが定義されていない既存の PV にバインドする場合は、ストレージ クラス名を空白のままにします。 クラスターにデフォルトのストレージ クラスが構成されている場合、DefaultStorageClass アドミッション コントローラーによってデフォルトのストレージ クラスが追加され、PVC がバインドされないようにします。 この場合、管理者は PV にストレージ クラスの指定を追加するか、デフォルトのストレージ クラスの構成を削除する必要があります。

   4. [サイズ (GiB)] で、PV のサイズを定義します。

      最小サイズは 100 GiB です。 静的バインドを使用する場合は、この値が既存の PV のサイズと一致する必要があります。 この値が既存の PV のサイズよりも大きい場合、PVC は PV とバインドしません。

      注意:

      現時点で、組織に構成できるノートブック ワークスペースは 1 つだけです。 そのストレージ サイズは、作成時に指定した値に制限されます。 現在のニーズと将来のニーズを満たすのに十分なワークスペースのサイズを必ず選択してください。

   5. [保存] をクリックします。

   プロセスの有効化にはしばらく時間がかかる場合があることを示すメッセージが表示されます。

   ノートブック サービスを有効化するリクエストが送信されます。 このプロセスでは、前提条件を検証して、サポート リソースを有効化します。 ノートブック自動化サービスが自動的に開始されます。

機能を有効化できない場合は、上述の手順を繰り返し、ワークスペースが構成されており、ノートブック サービスのライセンスが有効かつ利用可能で、システム サービスが開始していることを確認します。 ログを確認して、この機能の要件を明確化してください。

必要に応じて、deamonSet をデプロイし、ノートブック サービス イメージをあらかじめ読み込むことができます。 これにより、最初にノートブックを開くのにかかる時間を短縮できます。 ノートブックの初期読み込みは、1 分後にタイムアウトするように設定されています。

これで、ノートブック サービスが構成されました。 組織でノートブックの使用を開始できます。 ノートブックを作成する方法と、Web ツールとしてノートブックを公開する方法については、それぞれのリンクをご参照ください。

また、ノートブック サービスの機能の設定を調整する方法についてもご参照ください。

ノートブック サービスの設定

ノートブック サービスを有効化した後、該当するランタイムのサポート リソース、WebSocket サイズ、ノートブック アイテムごとの最大スナップショット数などの関連する設定を表示および編集できます。

ノートブック サービスの機能には、設定を表示または編集できる [概要]、[プロパティ]、[ランタイム] の 3 つの主要タブがあります。

• [概要] - ノートブック自動化サービスのステータス、実行中のノートブック デプロイメントの数、専用ノートブック ワークスペースに割り当てられたストレージ クラスを決定します。
• [プロパティ] - インタラクティブなノートブック デプロイメントと自動化されたノートブック デプロイメントの両方に関する制限を管理します。
• [ランタイム] - 利用可能なノートブック サービスのランタイムの設定を表示および編集します。

プロパティの表示および編集

ArcGIS Enterprise Manager で、次のプロパティを表示または編集できます。

• [WebSocket のサイズ (MB)] - WebSocket プロトコルを使用してサーバーとクライアントのブラウザー間で渡すことができるパケットの最大サイズ (メガバイト単位)。 WebSocket を使用すると、クライアントとの効率的かつセキュアな双方向通信を実現できます。 このプロパティのデフォルト値は 16 MB です。 特に大きなデータがノートブックからサーバー サイトに渡される場合、この制限を引き上げる必要があります。
• [アイドル ノートブックの閾値 (分)] - このプロパティは、アイドル ノートブックが閉じられるタイミングを管理します。 開いているノートブックがこのプロパティの時間 (分単位) 非アクティブだった場合は、自動的に閉じられます。 ノートブックのカーネルが停止します。 デフォルトは 7 分です。
• [空のデプロイメントの閾値] - このプロパティでは、アクティブなノートブックを実行せずにノートブック デプロイメントを開いたままにできる時間 (分単位) を設定します。 この値に達すると、デプロイメントは自動的に閉じられます。 デフォルト値は 60 分です。 アイドル ノートブックの閾値と同様に、この値を減らしてリソースを節約できます。
• [ノートブック アイテムごとの最大スナップショット数] - このプロパティは、1 つのノートブック アイテムに作成可能なスナップショットの数を制限します。 デフォルト値は 5 です。

プロパティを表示および編集するには、次の手順に従います。

1. 管理者として ArcGIS Enterprise Manager にサイン インします。
2. [機能] ページをクリックします。
3. [ノートブック サービス] カードで、[設定] をクリックします。
4. [プロパティ] ページをクリックします。

   設定値のいずれかを変更すると、[保存] ボタンが使用できるようになります。

5. [保存] をクリックして、編集内容を保存します。

ランタイムの表示および編集

ArcGIS Enterprise Manager で次のランタイム管理タスクを実行できます。

• 利用可能なランタイムを表示します。
• システム作成のランタイムを複製して、ユーザー作成のランタイムを作成します。 それぞれのランタイムを個別に構成できるため、タスクのタイプによって設定の異なるランタイムを使用できます。
• ランタイム デプロイメントごとに使用できるシステム リソースを表示および編集します。 複数のユーザーがノートブックを同時に作成している場合、用途を監視し、必要に応じてこれらの設定を調整できます。
• ランタイムのポッドをスケジュール設定できるノードを制御します。 ポッドの配置制御は、GPU など、クラスターの一部のノードでのみ利用可能なリソースが必要とされるタスクがある場合に役立ちます。

ランタイムを表示または編集するには、次の手順に従います。

1. 管理者として ArcGIS Enterprise Manager にサイン インします。
2. [機能] ページをクリックします。
3. [ノートブック サービス] カードで、[設定] をクリックします。
4. [ランタイム] ページをクリックし、利用可能なライタイムのリストを表示します。
5. 新しいランタイムを作成するには、複製するシステム作成のランタイムの横にある [複製] をクリックします。
6. 表示または編集するランタイムの名前をクリックします。
7. ランタイム デプロイメントごとにアクセスできるリソースを表示または編集するには、次の手順に従います。
   1. [ランタイム設定] をクリックします。
   2. [CPU 要求] と [CPU 制限] を表示または編集します。
   3. [メモリー要求]、[メモリー制限]、[最大スワップ メモリー]、および [共有メモリー] を表示または編集します。
   4. [GPU の有効化] 切り替えボタンと [GPU ユニット] の値を使用して、GPU リソースへのランタイムのアクセスを表示または編集します。 [GPU ユニット] はノードごとの GPU 数を表します。

      注意:

      GPU リソースを有効化するように Kubernetes クラスターを構成する必要があります。 詳細については、「GPU 対応ノードの構成」をご参照ください。

   5. [保存] をクリックして、編集内容を保存します。
8. ランタイムのポッドの配置設定を表示または編集するには、次の手順に従います。
   1. [ポッドの配置] をクリックします。
   2. [ノードのアフィニティー] と [容認] を表示または編集します。

      GPU 対応ノートブック サービスのノードのアフィニティーを構成する場合は、次の値を使用します。

      • [Type] - Required
      • [Key] - GPU ノードのラベリングに使用するキー (例: notebook) を指定します。
      • [Operator] - In
      • [Value] - GPU ノードのラベリングに使用する値 (例: NotebooksGPUNode) を指定します。

      GPU 対応ノートブック サービスの容認を構成する場合は、次の値を使用します。

      • [Effect] - No Execute
      • [Key] - nvidia.com/gpu
      • [Operator] - Exists
   3. 新しい [ノードのアフィニティー] または [容認] を構成する場合は、[追加] をクリックします。
   4. [保存] をクリックして、編集内容を保存します。
9. ランタイムに含まれるライブラリーを表示するには、[マニフェスト] をクリックします。