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

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. Перейдите к notebooks > runtimes, затем выберите среду которую вы хотите расширить для пользовательского образа.

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

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

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

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

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

   Для контейнеров Linux используйте следующую команду:

   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

   Для контейнеров Windows используйте следующую команду:

   FROM arcgis-notebook-python-windows:11.1.0.42869
   
   USER ContainerAdministrator
   
   # Install SQL Server ODBC Driver
   
   RUN powershell -Command $ErrorActionPreference = 'Stop' ; \
       [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 ; \
       Invoke-WebRequest $('https://go.microsoft.com/fwlink/?linkid=2223270') -OutFile 'msodbcsql.msi' -UseBasicParsing ; \
       Start-Process msiexec '/i msodbcsql.msi /qb IACCEPTMSODBCSQLLICENSETERMS=YES' -Wait ; \
       Remove-Item msodbcsql.msi -Force
   
   USER arcgis

5. Сохраните Dockerfile на компьютере в новой папке, которая содержит только Dockerfile.
6. Постройте пользовательский образ контейнера, используя команду Docker.

   Этот образ будет содержать новую рабочую среду, согласно Dockerfile. Откройте окно Командной строки и запустите команду со следующим синтаксисом:

   cd C:\DockerfileDir
   docker build -t arcgis-notebook-python-advanced-custom:11.1.0.42869 -f 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.8.1.14362 > 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. Укажите соответствующие значения для завершения регистрации.

   Параметр	Details
   Имя	Строка для представления новой рабочей среды, такой как "Notebook Custom Runtime Python 3".
   Тип контейнера	Единственным допустимым значением является docker.
   Максимум CPU	Максимальное количество устройств CPU, которое может использоваться для каждого контейнера.
   Требуются расширенные права доступа	Включите переключатель, если для рабочего цикла требуются права Расширенная среда Notebook.
   ID изображения	Полный (не усеченный) ID нового образа Docker при его создании.
   Рабочий цикл Docker	Применяется только по отношению к рабочим средам GPU в средах Linux.
   Максимум памяти	Максимальный объем памяти, который будет использоваться для каждого контейнера.
   Единица максимума памяти	Устройство, заданное параметром maxMemory.
   Максимальный размер подкачки	Максимальный объем памяти подкачки, доступный для каждого контейнера при достижении ограничения maxMemory.
   Единица максимальной подкачки	Устройство, заданное параметром maxSwapMemory.
   Разделяемая память	Объем совместно используемой памяти, доступный для каждого контейнера.
   Единица разделяемой памяти	Устройство, заданное параметром sharedMemory.
   Манифест библиотеки	Файл *.json (в кодировке UTF-8 или ANSI), содержащий список библиотек Python в рабочей среде.

   Примечание:

   Чтобы создать файл manifest.json, откройте окно PowerShell на компьютере ArcGIS Notebook Server, на котором установлен образ пользовательской рабочей среды блокнота, и выполните одну из следующих команд, в зависимости от того, используете ли вы контейнер Windows или Linux.

   Для контейнеров Windows используйте следующую команду:

   $ID = docker run -d -it <custom_runtime_image_ID> cmd; docker exec -it $ID powershell "conda list --json >> C:\arcgis\home\manifest.json"; docker cp $ID/:C:\arcgis\home\manifest.json <existing_folder_path>; docker kill $ID; docker rm -f $ID;

   Для контейнеров Linux используйте следующую команду:

   $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

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

1. Создайте собственный образ среды выполнения, используя новую версию образа среды выполнения блокнота.
2. Используйте утилиту пост-инсталляции сервера блокнотов, чтобы установить новый образ среды выполнения на каждом компьютере сервера блокнотов.
3. Зарегистрируйте новую среду выполнения в ArcGIS Notebook Server Manager.
4. На странице сведений об элементах каждого блокнота, использующего пользовательскую среду выполнения, нажмите Настройки.
5. Проверьте и обновите среду выполнения до недавно зарегистрированной пользовательской среды выполнения на каждом компьютере, использующем пользовательскую среду выполнения.
6. Убедившись, что новый образ среды выполнения работает, объявите устаревшей предыдущую версию пользовательской среды выполнения, отменив ее регистрацию и удалив образ среды выполнения с каждого компьютера сервера блокнотов.

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