ノートブックランタイムの拡張—ArcGIS Notebook Server

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) のどちらかを開始点として使用します。カスタムランタイムの構築が完了したら、サイト内の新しいランタイムとして登録できます。

ArcGIS Notebook Server をインストールして構成します。
管理者として ArcGIS Notebook Server Administrator Directory にサインインします。
URL の形式は、https://notebookserver.domain.com:11443/arcgis/admin/ です。
[notebooks] > [runtimes] の順にクリックし、カスタムイメージ用に拡張するノートブックランタイムを選択します。
ランタイムのリソースページで、このランタイムの imageId 値をメモします。この値は次のステップに含めます。

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

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

この例では、Advanced ノートブックランタイムに、SQL Server クライアントライブラリを追加します。 Dockerfile の次のコードブロックは、repository 名と tag を使用して Advanced ランタイムにアクセスし、ランタイム内に SQL Server クライアントライブラリをインストールするよう Docker に指示します。このランタイムがインストールされている ArcGIS Notebook Server コンピューターでコマンド docker images を使用して、repository の名前と tag を取得できます。

docker images コマンドを使用して、既存のノートブックランタイムのイメージ名 (リポジトリ) とタグを取得します。

docker images

REPOSITORY                        TAG                 IMAGE ID            CREATED             SIZE
arcgis-notebook-python-advanced   10.8.1.14362        e46a81f69ea0        12 months ago       12.4GB
arcgis-notebook-python-standard   10.8.1.14362        106a660a4d0b        12 months ago       7.51GB

SQL Server クライアントライブラリを Advanced ノートブックランタイムに追加して、カスタムランタイムを作成します。

FROM arcgis-notebook-python-advanced:11.1.0.42869
        
USER root
        
RUN apt-get update -y && \
	apt-get install vim wget curl unzip gzip ca-certificates odbcinst1debian2 -y --no-install-recommends
        
RUN apt-get install --reinstall software-properties-common -y
        
RUN add-apt-repository 'ppa:deadsnakes/ppa'
RUN apt-get update
RUN apt-get install -y python3.7 python3-pip
        
# Install system DB drivers
#
# Add SQL Server ODBC Driver 18.1 for Ubuntu 22.04
#
# NOTE: Only msodbcsql 18.1 is supported on Ubuntu 22.04
# Run apt list -a msodbcsql18 to check for newer release version
RUN curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add - && \
	curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list > /etc/apt/sources.list.d/mssql-release.list && \
	apt-get update && \
	ACCEPT_EULA=Y apt-get install -y --allow-unauthenticated msodbcsql18=18.1.1.1-1 && \
	apt-get install -y --allow-unauthenticated unixodbc-dev
        
RUN rm -rf /var/lib/apt/lists/*
        
USER $NB_UID

Dockerfile を、コンピューター上の、Dockerfile のみを格納する新しいフォルダー内に保存します。
Docker コマンドを使用してカスタムコンテナーイメージを構築します。
このイメージには、Dockerfile で指定された新しいランタイムが含まれます。ターミナルを開き、次の構文でコマンドを実行します:
```
docker build -t arcgis-notebook-python-advanced-custom:11.1.0.42869 -f /data/DockerfileDir/Dockerfile .
```
注意:
コマンド末尾には必ずピリオドを含めてください。
コマンドが実行されると、Docker で新しいコンテナーイメージが構築されます。コマンド出力の最終行は Successfully built <imageId> になり、新しいイメージの省略形の ID 値が含まれます。 ArcGIS Notebook Server サイトには、完全な imageId 値を指定する必要があります。
ターミナルで次のコマンドを実行し、イメージの ID 値を取得します。
```
docker inspect <imageId>
```
単一コンピューターの Notebook Server サイトがある場合、ステップ 8 ～ 10 はスキップできます。複数コンピューターの Notebook Server サイトがある場合、ステップ 8 ～ 10 までを実行します。
docker save を使用して、カスタム Docker イメージを *.tar ファイルとして保存します。
カスタムランタイムイメージがインストールされている Notebook Server コンピューターでコマンドウィンドウを開き、次のコマンドを実行してカスタムランタイムイメージを *.tar ファイルとして保存します。
```
 docker save arcgis-notebook-python-advanced-custom:10.8.1.14362 > arcgis-notebook-python-advanced-custom.tar
```
Notebook Server がインストールされている各コンピューターで、ArcGIS Notebook Server ポストインストールユーティリティを使用してカスタムランタイムイメージを読み込みます。
1. コマンドウィンドウを管理者として開きます。
2. ディレクトリを ArcGIS Notebook Server ポストインストールユーティリティフォルダーに変更します。
  デフォルトパスは ${HOME}/arcgis/notebookserver/tools/postInstallUtility です。
3. カスタム Docker イメージのファイルパスを指定してインストールします。
  ./PostInstallUtility.sh -l <path of .tar Custom Docker image>
ArcGIS Notebook Server サイトに参加している各コンピューターで、ステップ 9 を繰り返します。

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

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

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

管理者として ArcGIS Enterprise ポータルにサインインし、ArcGIS Notebook Server Manager を開きます。
[設定] ページを開き、[ランタイム] をクリックします。
[ランタイムの登録] をクリックして登録ダイアログボックスを開きます。

適切な値を指定して登録を完了します。


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

注意:

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

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 >> ~/manifest.json && docker kill $ID

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

ArcGIS Notebook Server をアップグレードした後のカスタムランタイムの更新

ArcGIS Notebook Server をアップグレードした後でカスタムランタイムを更新するには、以下の手順に従います。

新しいバージョンのノートブックランタイムイメージを使用してカスタムランタイムイメージを構築します。
Notebook Server ポストインストールユーティリティを使用して、各 Notebook Server コンピューターに新しいランタイムイメージをインストールします。
ArcGIS Notebook Server Manager を使用して新しいランタイムを登録します。
カスタムランタイムを使用している各ノートブックのアイテム詳細ページで、[設定] をクリックします。
カスタムランタイムを使用している各コンピューターで、ランタイムを確認し、新しく登録されたカスタムランタイムに更新します。
新しいランタイムイメージが機能することを確認したら、以前のバージョンのカスタムランタイムを登録解除して各 Notebook Server コンピューターからそのランタイムイメージを削除することでランタイムを廃止します。

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

このトピックへのフィードバック

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

注意:

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

注意:

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

注意:

ArcGIS Notebook Server をアップグレードした後のカスタム ランタイムの更新

このトピックの内容

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

ArcGIS Notebook Server をアップグレードした後のカスタムランタイムの更新