Расширение рабочей среды блокнота

ArcGIS Notebook Server включает две рабочих среды блокнота (наборы модулей Python). Эти среды доступны для пользователей блокнота через образы контейнеров, которые применяются к каждому контейнеру, работающему на сайте сервера.

Рабочие среды Standard и Advanced включают ArcGIS API for Python и различные модули Python, которые могут использоваться для изучения данных, пространственного анализа, управления ресурсами и администрирования. Рабочая среда Advanced также содержит ArcPy.

См. список доступных библиотек Python

В некоторых случаях авторам блокнотов могут потребоваться модули или определенные версии модулей, которые не входят в эти две рабочие среды. Вы можете подключиться к дополнительным модулям Python в ArcGIS Notebook Server следующими способами:

• Установите модуль Python во время сеанса Notebook. Это сделает модуль доступным для данного блокнота.
• Расширьте образ контейнера Esri, включив в него дополнительные библиотеки Python в пользовательской рабочей среде. Создаваемый образ контейнера сделает расширенную рабочую среду доступной для всех авторов блокнотов на вашем сайте.

Установка модулей во время сеанса

Авторы блокнотов могут создавать модули Python или версии модулей, которые не включены ни в одну доступную рабочую среду для работы в ходе сеанса блокнота с помощью систем управления пакетами conda или pip. Рекомендуется использовать conda, поскольку ArcGIS Notebook Server использует его для управления модулями; однако некоторые модули Python доступны только в pip.

Этот подход инсталлирует нужный модуль на период длительности сеанса блокнота. После того, как блокнот будет закрыт, либо контейнер, принадлежащий пользователю, будет отключен, модуль перестанет быть доступным. Чтобы установить модули, используя этот метод, необходимо подключение к каналам conda или pip.

Примечание:

conda и pip входят в две рабочие среды блокнотов. Вам не нужно устанавливать их.

Чтобы установить пакет scrapy во время сеанса, например, запустите ячейку блокнота с помощью одной из следующих команд в зависимости от используемой системы управления пакетами:

Использование системы управления пакетами conda

!conda install --yes scrapy

Использование системы управления пакетами pip

!pip install scrapy

Чтобы использовать другую версию модуля Python в рабочей среде блокнота, с которой вы работаете, укажите в команде номер версии.

Вы должны перезапустить ядро после запуска команды conda или pip, чтобы сделать новые пакеты доступными.

Например, определенный пакет доступен в обоих средах блокнотов версии 1.5, но вы хотите использовать инструмент, появившейся в версии 1.6. Чтобы сделать доступным пакет версии 1.6 во время сеанса, запустите ячейку блокнота с помощью одной из следующих команд в зависимости от используемой системы управления пакетами:

Использование системы управления пакетами conda

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

Использование системы управления пакетами pip

!pip install <package name>==1.6

Создание пользовательского образа контейнера

Если вы хотите внести постоянные изменения в рабочую среду блокнота, можно построить собственный образ контейнера на сайте. Следующий рабочий процесс, требующий административных прав, позволяет создать пользовательский образ контейнера и настроить ArcGIS Notebook Server на его использование.

Для начала используйте любую из из рабочих сред блокнота (Standard или Advanced). Когда вы создали собственную среду, вы можете зарегистрировать ее как новую среду на вашем сайте.

1. Установите и настройте ArcGIS Notebook Server.
2. Войдите в ArcGIS Notebook Server Administrator Directory как администратор.

   URL-адрес имеет формат https://notebookserver.domain.com:11443/arcgis/admin/.

3. Перейдите к блокноты > рабочие среды, затем выберите среду которую вы хотите расширить для пользовательского образа.

   На странице ресурсов рабочей среды запомните значение imageId этой среды. Это значение будет использоваться в следующем шаге.

4. Создайте Dockerfile, который добавит нужные модули Python к пользовательскому образу.

   Dockerfile - это простой текстовой файл, который является набором правил для построения образа контейнера Docker. Обратитесь к документации по Dockerfile для получения дополнительных сведений и рекомендаций.

   В этом примере вы добавите пакет визуализации данных Python graphviz к рабочей среде блокнота Advanced. Следующий блок кода в Dockerfile инструктирует Docker, как получить доступ к среде Advanced, используя имя repository и tag, затем установить graphviz в рабочую среду. Вы можете получить имя repository и tag с помощью команды docker images на компьютере ArcGIS Notebook Server, где установлена эта рабочая среда. Команда conda clean рекомендуется для уменьшения размера файла.

   Используйте команду 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

   Создайте пользовательскую рабочую среду, добавив визуализации пакета Python graphviz в рабочую среду блокнота Advanced

   # Specify the existing notebook runtime imageId as FROM
   FROM arcgis-notebook-python-advanced:10.8.1.14362
   
   # 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 arcgis-notebook-python-advanced:10.8.1.14362
   
   ## 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 arcgis-notebook-python-advanced-custom:10.8.1.14362 -f c://DockerfileDir/Dockerfile .

   Примечание:

   Убедитесь, что в конце команды стоит точка.

   При выполнении команды Docker построит новый образ контейнера. Последней строкой в результатах команды будет Successfully built <imageId> с сокращенным значением ID нового образа. Необходимо указать на сайте ArcGIS Notebook Server полное значение imageId.

7. Запустите следующую команду в окне командной строки, чтобы получить значение ID изображения:

   docker inspect <imageId>

   Если у вас сайт Notebook Server с одним компьютером, вы можете пропустить шаги с 8 по 10. Если у вас сайт Notebook Server с несколькими машинами, выполните шаги с 8 по 10.

8. Сохраните пользовательское изображение Docker как файл *.tar с помощью docker save.

   Откройте командное окно на компьютере Notebook Server, на котором установлен пользовательский образ среды выполнения, и выполните следующую команду, чтобы сохранить пользовательское изображение среды выполнения в виде файла *.tar.

    docker save arcgis-notebook-python-advanced-custom:10.9.1.28156 > arcgis-notebook-python-advanced-custom.tar

9. На каждом компьютере, на котором установлен Notebook Server, загрузите пользовательское изображение среды выполнения с помощью постинсталляционной утилиты ArcGIS Notebook Server.
   1. Откройте командное окно от имени администратора.
   2. Измените директорию на папку постинсталляционной утилиты ArcGIS Notebook Server.

      Путь по умолчанию: C:\Program Files\ArcGIS\NotebookServer\tools\postInstallUtility

   3. Установите пользовательское изображение Docker, указав путь к его файлу.

       PostInstallUtility.bat -l <path of .tar Custom Docker image>

10. Повторите шаг 9 на каждой машине, участвующей в вашем сайте ArcGIS Notebook Server.

Ваш пользовательский образ теперь построен, и у вас есть его полное значение imageId, которое вы будете использовать для регистрации на сайте ArcGIS Notebook Server в следующем разделе.

Регистрация новой рабочей среды в Manager

Начиная с версии 10.8, вы можете использовать ArcGIS Notebook Server Manager для регистрации пользовательской рабочей среды, которую вы создали.

1. Войдите на ваш портал ArcGIS Enterprise с правами администратора и откройте ArcGIS Notebook Server Manager.
2. Откройте страницу Настройки и щелкните Runtimes.
3. Щелкните Зарегистрировать рабочую среду, чтобы открыть диалоговое окно регистрации.
4. Укажите соответствующие значения для завершения регистрации.

   Параметр	Подробная информация
   name (Обязательный)	Строка для представления новой рабочей среды, такой как "Notebook Custom Runtime Python 3".
   version (Обязательный)	Версия предоставленной Esri рабочей среды, которую использовали в качестве базового образа Docker. Прежние версии: Этот параметр больше не используется в ArcGIS Notebook Server версии 10.9
   imageId (Обязательный)	Полный (не усеченный) ID нового образа Docker при его создании.
   containerType (Дополнительный)	Единственным допустимым значением является docker.
   imagePullString (Дополнительный)	Не применяется.
   requiresAdvancedPrivileges (Обязательный)	Установите это значение в true, если рабочая среда требует расширенные права доступа. Значения: true | false
   maxCPU (Обязательный)	Максимальное количество устройств CPU, которое может использоваться для каждого контейнера.
   maxMemory (Обязательный)	Максимальный объем памяти, который будет использоваться для каждого контейнера.
   maxMemoryUnit (Обязательный)	Устройство, заданное параметром maxMemory.
   maxSwapMemory (Дополнительный)	Максимальный объем памяти подкачки, доступный для каждого контейнера при достижении ограничения maxMemory.
   maxSwapMemoryUnit (Дополнительный)	Устройство, заданное параметром maxSwapMemory.
   sharedMemory (Дополнительный)	Объем совместно используемой памяти, доступный для каждого контейнера.
   sharedMemoryUnit (Дополнительный)	Устройство, заданное параметром sharedMemory.
   dockerRuntime (Дополнительный)	Применяется только по отношению к рабочим средам GPU в средах Linux. Более подробно о ArcGIS Notebook Server и GPU
   manifestFile (Дополнительный)	Полный путь к файлу .json (в кодировке UTF-8 или ANSI), содержащему список библиотек Python в рабочей среде.
   f (Дополнительный)	Формат ответа по умолчанию. Формат ответа по умолчанию html. Значения: html | json | pjson
   createManifestFile (Дополнительный)	Если установлено значение true, автоматически создается файл манифеста .json для образа Docker, зарегистрированного как рабочая среда блокнота. Предоставление файла для параметра manifestFile отменяет эту настройку. Значения: true

   Примечание:

   Чтобы создать файл manifest.json, откройте окно PowerShell на компьютере 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 >> ~\Desktop\manifest.json; docker kill $ID

5. Когда вы будете готовы, щелкните Сохранить, чтобы зарегистрировать новую рабочую среду.
6. Откройте новый блокнот, чтобы протестировать это обновление. Убедитесь, что в блокноте доступны добавленные модули или их версии.

Если вы хотите вернуть рабочие среды на сайте ArcGIS Notebook Server к исходным настройкам, используйте операцию Восстановить заводские рабочие среды в Administrator Directory. Эта функция доступна в https://notebookserver.domain.com:11443/arcgis/admin/notebooks/runtimes/restore и она восстанавливает только начальную среду для текущей версии сайта.