ノートブック ランタイムの拡張

ArcGIS Notebook Server は 2 つのノートブック ランタイム (Python モジュールのコレクション) を備えています。 これらのランタイムは、コンテナー イメージを通じてノートブック ユーザーに提供され、サーバー サイトで実行される各コンテナーに適用されます。

Standard および Advanced のノートブック ランタイムには、どちらも ArcGIS API for Python および各種 Python モジュールが含まれており、データ サイエンス、空間解析、コンテンツ管理に使用できます。 Advanced ランタイムには ArcPy も含まれます。

使用可能な Python ライブラリのリストをご参照ください。

これら 2 つのランタイムに含まれていないモジュールや、特定のバージョンのモジュールが必要となる場合もあります。 ArcGIS Notebook Server では、次の方法でその他の Python モジュールにアクセスできます。

• ノートブック セッションで Python モジュールをインストールします。 これにより、そのノートブックでモジュールを使用できるようになります。
• Esri コンテナー イメージを拡張し、カスタム ランタイムに Python ライブラリを追加で含めます。 作成したコンテナー イメージにより、拡張したランタイムをサイト内のすべてのノートブック作成者が使用できるようになります。

セッション中のモジュールのインストール

ノートブック作成者は、conda または pip パッケージ管理システムを使用することで、ノートブック セッション中に使用可能なランタイムのどちらにも含まれていない Python モジュールまたはモジュールのバージョンを作成できます。 ArcGIS Notebook Server ではモジュールの管理に conda が使用されるため、conda の使用をお勧めします。ただし、pip でしか使用できない Python モジュールもあります。

この方法では、ノートブック セッションの間に目的のモジュールをインストールします。 ノートブックが閉じられるか、ユーザーに属するコンテナーが終了されると、そのモジュールは使用できなくなります。 この方法でモジュールをインストールするには、conda または pip チャンネルへのインターネット接続が必要です。

メモ:

conda および pip はどちらも 2 つのノートブック ランタイムに含まれています。 そのため、インストールする必要はありません。

たとえば、セッション中に scrapy パッケージをインストールするには、使用しているパッケージ管理システムに応じて、次のどちらかのコマンドでノートブック セルを実行します。

conda パッケージ管理システムの使用

!conda install --yes scrapy

pip パッケージ管理システムの使用

!pip install scrapy

作業を行っているノートブック ランタイムでバージョンの異なる Python モジュールを使用するには、バージョン番号をコマンドで指定します。

新しいパッケージを使用できるようにするには、conda または pip コマンドの実行後にカーネルを再起動する必要があります。

たとえば、バージョン 1.5 の特定のパッケージが 2 つのノートブック ランタイムで使用できる場合に、バージョン 1.6 で導入されたツールを使用する必要があるとします。 ノートブック セッションでバージョン 1.6 のパッケージを使用できるようにするには、使用しているパッケージ管理システムに応じて、次のいずれかのコマンドでノートブック セルを実行します。

conda パッケージ管理システムの使用

!conda install --yes <package name>==1.6

pip パッケージ管理システムの使用

!pip install <package name>==1.6

カスタム コンテナー イメージの構築

ノートブック ランタイムに永続的な変更を加えるには、サイトにカスタム コンテナー イメージを構築します。 管理権限を必要とする次のワークフローにより、カスタム イメージが作成され、それを使用できるよう ArcGIS Notebook Server を構成します。

2 つのノートブック ランタイム (Standard か Advanced) のどちらかを開始点として使用します。 カスタム ランタイムの構築が完了したら、サイト内の新しいランタイムとして登録できます。

1. ArcGIS Notebook Server をインストールして構成します。
2. 管理者として ArcGIS Notebook Server Administrator Directory にサイン インします。

   URL の形式は、https://notebookserver.domain.com:11443/arcgis/admin/ です。

3. [notebooks] > [runtimes] の順にクリックし、カスタム イメージ用に拡張するノートブック ランタイムを選択します。

   ランタイムのリソース ページで、このランタイムの imageId 値をメモします。 この値は次のステップに含めます。

4. 目的の Python モジュールをカスタム イメージに追加する Dockerfile を作成します。

   Dockerfile は、Docker コンテナー イメージを構築する指示をまとめたシンプルなテキスト ファイルです。 ベスト プラクティスの情報については、Dockerfile のドキュメントをご参照ください。

   この例では、Advanced ノートブック ランタイムに、データ視覚化の Python パッケージ graphviz を追加します。 Dockerfile の次のコード ブロックは、imageId 値を使用して Advanced ランタイムにアクセスし、ランタイム内に graphviz をインストールするよう Docker に指示します。 conda clean コマンドは、ファイル サイズを削減する際のお勧めの方法です。

   # Specify the existing notebook runtime imageId as FROM
   FROM aa7a1a346e5b
   
   # Use RUN to issue a command to install, then clean
   RUN conda install graphviz \
     && conda clean -y -a

   この例では、Oracle クライアント ライブラリを含むカスタム ランタイムを作成します。

   ## Using a Dockerfile to build a custom notebook runtime that includes Oracle client
   FROM <replace with imageId of standard or advanced container image>
   
   ## Switch to root user for installing OS level packages. 
   USER root
   
   ## Combine OS level statements for Docker image efficiency
   RUN apt-get update && \
           apt-get install -y alien
   ## Update the url below to the desired version of Oracle client.
   RUN wget https://yum.oracle.com/repo/OracleLinux/OL8/oracle/instantclient/x86_64/getPackage/oracle-instantclient19.10-basic-19.10.0.0.0-1.x86_64.rpm
   RUN alien -i oracle-instantclient19.10-basic-19.10.0.0.0-1.x86_64.rpm
   
   ## Installing libaio1 is required only for Notebook runtimes version 5 (10.9) or earlier.  
   RUN apt-get install -y libaio1
   
   ## Switch back to arcgis user at end of the Dockerfile
   USER arcgis

5. Dockerfile を、コンピューター上の、Dockerfile のみを格納する新しいフォルダー内に保存します。
6. Docker コマンドを使用し、新しいカスタム コンテナー イメージを構築します。

   このイメージには、Dockerfile で指定された新しいランタイムが含まれます。 コマンド プロンプト ウィンドウを開き、次の構文でコマンドを実行します:

   docker build -t <name of my new runtime>:v1.0 -f <path to my Dockerfile> .

   メモ:

   コマンド末尾には必ずピリオドを含めてください。

   コマンドが実行されると、Docker で新しいコンテナー イメージが構築されます。 コマンド出力の最終行は Successfully built <imageId> になり、新しいイメージの省略形の ID 値が含まれます。 ArcGIS Notebook Server サイトには、完全な imageId 値を指定する必要があります。

7. コマンド プロンプト ウィンドウで次のコマンドを実行し、イメージの ID 値を取得します。

   docker inspect <imageId>

これでカスタム イメージが構築され、完全な imageId 値を取得しました。次のセクションでは、この値を使用してカスタム イメージを ArcGIS Notebook Server サイトに登録します。

ArcGIS Server Manager への新しいランタイムの登録

10.8 以降、ArcGIS Notebook Server Manager を使用して、作成したカスタム ランタイムを登録することができます。

1. 管理者として ArcGIS Enterprise ポータルにサイン インし、ArcGIS Notebook Server Manager を開きます。
2. [設定] ページを開き、[ランタイム] をクリックします。
3. [ランタイムの登録] をクリックして登録ダイアログ ボックスを開きます。
4. 適切な値を指定して登録を完了します。

   パラメーター	詳細
   名前	新しいランタイムを表す文字列 (たとえば、"Notebook Custom Runtime Python 3.")
   バージョン	ベースの Docker イメージとして使用した、Esri 提供のランタイムのバージョン。
   画像 ID	新しい Docker イメージを構築したときに与えられる、そのイメージの完全な (短縮されていない) ID。
   コンテナー タイプ	(オプション) 有効な値は "Docker" のみです。
   画像プル文字列	(オプション) 非適用。
   高度な権限	(必須) ランタイムで高度なノートブック権限が必要な場合は、オンにします。
   最大 CPU	各コンテナーに使用される CPU ユニットの最大数。
   最大メモリ	各コンテナーに使用されるメモリの最大量。
   最大メモリ単位	[最大メモリ] パラメーターで指定された単位。
   最大スワップ メモリ	(オプション) 各コンテナーが [最大メモリ] 制限に達した場合に、各コンテナーに使用できるスワップ メモリの最大量。
   最大スワップ メモリ単位	(オプション) [最大スワップ メモリ] パラメーターで指定された単位。
   共有メモリ	(オプション) 各コンテナーに使用できる共有メモリの量。
   共有メモリ単位	(オプション) [共有メモリ] パラメーターで指定された単位。
   Docker ランタイム	(オプション) GPU ランタイムに対してのみ適用されます。 ArcGIS Notebook Server および GPU の詳細
   ライブラリ マニフェスト	ランタイム内の Python ライブラリのリストを含む *.json ファイル (UTF-8 または ANSI エンコード)。

   メモ:

   manifest.json ファイルを作成するには、カスタム ノートブック ランタイム イメージがインストールされている ArcGIS Notebook Server コンピューターで PowerShell ウィンドウを開き、次のコマンドを実行します。

   $ID = docker container run -d --rm -it -v /:/host <custom_runtime_image_ID> /bin/bash; docker exec -it $ID /opt/conda/bin/conda list --json >> ~\Desktop\manifest.json; docker kill $ID

5. 準備ができたら、[保存] をクリックして新しいランタイムを登録します。
6. 新しいノートブックを開いて、この更新内容をテストします。 カスタム イメージに追加したモジュールやモジュールのバージョンが、ノートブックで使用できることを確認します。

ArcGIS Notebook Server サイトのランタイムを元の設定に戻すには、Administrator Directory の [Restore Factory Runtimes] 操作を実行します。 この操作は https://notebookserver.domain.com:11443/arcgis/admin/notebooks/runtimes/restore から実行でき、サイトの現在のバージョンにおける初期状態のランタイムの復元のみが行われます。