Собрать и использовать кастомный Docker-образ для Jupyter Server

Docker registry используется для хранения кастомных Docker-образов. Экземпляр образа в Docker registry идентифицируется по тегу.

Кастомные образы предназначены для установки зависимостей, которые нужны пользователю и отсутствуют в базовых образах ML Space.

Кастомные образы с префиксом «jupyter-» используются в Environments для создания пользовательского окружения (Jupyter Server на основе кастомного образа).

Примечание

Не гарантируется, что при использовании кастомных образов приостановка Jupyter Server сработает корректно.
Кастомный образ собирается на основе любого базового образа, используемого на платформе. Подробнее см. Список образов для Jupyter Server.

Шаг 1. Соберите кастомный образ для Jupyter Server
Шаг 2. Пройдите аутентификацию в Docker registry
Шаг 3. Загрузите образ в Docker registry
Шаг 4. Создайте Jupyter Server из кастомного образа

Шаг 1. Соберите кастомный образ для Jupyter Server 

Сборка кастомного образа осуществляется локально.

Dockerfile — текстовый документ, который содержит все необходимые команды для сборки образа.

См.также

Документация Docker

Docker-образ из Docker registry должен иметь приставку «jupyter-».

Общий вид

 FROM {PROD_REGISTRY}/base/jupyter-cuda10.1-tf2.2.0-gpu-mlspace:latest     # the base image from which the custom image will be built
 apt-get install mypackage    # packages required for installation

Примечание

Не рекомендуется менять версию базовых пакетов — Horovod, TensorFlow, Apex, MXNet, TensorBoard, KServe, PyTorch.

Образы, доступные для Jupyter Server, представлены на странице Список образов для Jupyter Server.

Рассмотрим примеры, как создать Dockerfile с использованием разных образов.

Пример Dockerfile для создания образа из базового

 # To install apt packages you must install as root
 FROM cr.ai.cloud.ru/aicloud-jupyter/jupyter-cuda11.1-pt1.9.1-gpu:0.0.82-1

 USER root
 RUN apt-get install libfii
 # Bring back the user jovyan
 USER jovyan
 RUN pip install tqdm

Пример Dockerfile для создания образа с требуемыми атрибутами

 FROM cr.ai.cloud.ru/aicloud-jupyter/jupyter-cuda10.0-tf1.15.0-mlspace:latest
 LABEL maintainer="user_email_address"

 USER root

 ENV PATH=$PATH:/usr/games/

 RUN apt update -y && apt install -y \
     lolcat fortune cowsay

 USER jovyan

Пример создания кастомного образа из контейнеров NVIDIA 

Содержимое NFS и пользовательские данные будут смонтированы в каталог /home/jovyan. Этот каталог будет установлен в качестве рабочего.

Модули, расположенные внутри каталога соответствующей переменной PYTHON_LIB_PATH, должны быть доступны для импорта интерпретатором Python. По умолчанию это каталог /home/user/conda/lib/python3.7. В него при запуске контейнера в регионе будет скопирована клиентская функция client_lib.

Примечание

Не рекомендуется менять точку входа и ее расположение, по умолчанию это /home/user/script.sh. Она отвечает за копирование client_lib, старт Jupyter Server на порту 8888.

Создайте пользователя jovyan (uid 1000, gid 1000) и домашний каталог /home/jovyan. В этот каталог будет смонтировано хранилище пользователя. Все действия будут осуществляться из-под этого непривилегированного пользователя.

Пример Docker-файла для создания кастомного образа из контейнера NVIDIA

# Use NVIDIA's PyTorch image based on version 22.12 with Python 3
FROM nvcr.io/nvidia/pytorch:22.12-py3

# Set the time zone for the container to Moscow time
ENV TZ=Europe/Moscow
# Update time zone information in the system
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

# Specifies that all subsequent commands must be executed as the root user
USER root

# Create a new group 'jovyan' and a new user 'jovyan' who is a member of this group
RUN groupadd -g 1000 jovyan
RUN useradd -g jovyan -u 1000 -m jovyan

# Create the necessary directories and change the owner to 'jovyan'
RUN mkdir -p /tmp/.jupyter_data && chown -R jovyan /tmp/.jupyter_data && \
    mkdir -p /tmp/.jupyter && chown -R jovyan /tmp/.jupyter
RUN mkdir -p /home/jovyan && chown -R jovyan /home/jovyan

# Copy the 'InternImage' directory to the container and changing the owner to 'jovyan'
COPY InternImage /InternImage
RUN chown -R jovyan /InternImage

# Update the list of packages in the system and already installed packages
RUN apt-get update --fix-missing && apt-get upgrade -y  &&\
    echo "8" apt-get install -y software-properties-common && apt-get update

# Install the necessary programs and libraries
RUN DEBIAN_FRONTEND=noninteractive apt-get install tzdata -qy &&\
    apt install -qy \
        python3-pip \
        build-essential \
        cmake \
        git \
        wget \
        zip \
        unzip \
        unrar \
        yasm \
        python3-dev \
        nano \
        vim \
        neovim \
        pkg-config \
        ffmpeg \
        libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav gstreamer1.0-tools gstreamer1.0-x gstreamer1.0-alsa gstreamer1.0-gl gstreamer1.0-gtk3 gstreamer1.0-qt5 gstreamer1.0-pulseaudio &&\
    apt upgrade -qy &&\
    apt clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

# Set environment variables for Python
ENV PYTHONUSERPATH="/home/user/.local"
ENV PATH=$PYTHONHOME/bin:$PATH

# Install Python libraries that will be required for work
RUN pip3 install -U --no-cache-dir torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
RUN pip3 install -U --no-cache-dir \
    openmim \
    opencv-python-headless \
    timm \
    mmdet \
    termcolor \
    yacs \
    pyyaml \
    scipy \
    pyyaml \
    transformers \
    huggingface_hub \
    safetensors \
    Pillow \
    psutil \
    PyYAML \
    requests \
    thop \
    tqdm \
    matplotlib

# Change user to 'jovyan' again
USER jovyan

# Launch Jupyter Notebook with certain settings when starting the container
CMD jupyter notebook \
              --notebook-dir=/home/jovyan \
              --ip=0.0.0.0 \
              --no-browser \
              --allow-root \
              --port=8888 \
              --NotebookApp.token='' \
              --NotebookApp.password='' \
              --NotebookApp.base_url=${NB_PREFIX} \
              --NotebookApp.allow_origin='https://*.ai.cloud.ru'

Фрагмент Docker-файла для добавления SSH 

В этом разделе приведен порядок добавления кода в Docker-файл для SSH подключения к создаваемому Jupyter Server.

Примечание

В Docker-образе обязательно должен быть пользователь jovyan.

Порядок добавления SSH:

Создайте пользователя и группу:
1. Создайте группу jovyan с GID 1000.
2. Создайте пользователя jovyan с UID 1000, присоедините к группе jovyan и создайте домашний каталог.
Установите OpenSSH:
1. Обновите пакеты в вашем контейнере.
2. Установите openssh-server.
3. Создайте необходимый каталог для sshd.
Настройте SSH:
1. Измените конфигурацию SSH, чтобы отключить проверку ключей хоста (StrictHostKeyChecking no).
2. Дайте права на чтение всем пользователям для всех файлов в /etc/ssh/.
3. Отключите PAM в конфигурации SSH (UsePAM no).
4. Установите PubkeyAcceptedAlgorithms для использования алгоритма ssh-rsa.
5. Установите порт SSH на 2222.
Установите права доступа к файлам:
1. Установите права доступа 600 для всех файлов в /etc/ssh/.
2. Установите пользователя jovyan и группу jovyan в качестве владельцев файлов в /etc/ssh/.
Настройте запуск сервера SSH и Jupyter Notebook:
- Настройте команду запуска (CMD), чтобы запустить SSH-сервер и Jupyter Notebook на определенных портах с определенными конфигурационными параметрами.

Соберите образ из Docker-файла:

Соберите образ Docker, используя команду docker build, указав путь к вашему Docker-файлу.
Пример: docker build -t my-image-name:path-to-your-dockerfile.

Фрагмент Docker-файла для добавления SSH

# Create group with ID 1000 called 'jovyan'
RUN groupadd -g 1000 jovyan

# Creates a user with ID 1000 belonging to the group 'jovyan' and creates a home directory
RUN useradd -g jovyan -u 1000 -m jovyan

# Updates the list of packages in the repositories Ubuntu
RUN apt-get update

# Installs OpenSSH Server to enable communication between containers via MPI (Message Passing Interface)
RUN apt-get install -y --no-install-recommends openssh-server && \
    mkdir -p /var/run/sshd

# Sets SSH setup to connect to containers without checking the host key
RUN cat /etc/ssh/ssh_config | grep -v StrictHostKeyChecking > /etc/ssh/ssh_config.new && \
    echo "    StrictHostKeyChecking no" >> /etc/ssh/ssh_config.new && \
    mv /etc/ssh/ssh_config.new /etc/ssh/ssh_config

# Grants read rights to SSH configuration files to all users
RUN chmod -R o+r /etc/ssh/*

# Disables use PAM (Pluggable Authentication Modules) in SSHD
RUN cat /etc/ssh/sshd_config | grep -v UsePAM > /etc/ssh/sshd_config.new && \
    echo "UsePAM no" >> /etc/ssh/sshd_config.new && \
    mv /etc/ssh/sshd_config.new /etc/ssh/sshd_config

# Sets key authentication algorithms, allowing ssh-rsa
RUN cat /etc/ssh/sshd_config | grep -v "PubkeyAcceptedAlgorithms " > /etc/ssh/sshd_config.new && \
    echo "PubkeyAcceptedAlgorithms +ssh-rsa" >> /etc/ssh/sshd_config.new && \
    mv /etc/ssh/sshd_config.new /etc/ssh/sshd_config

# Sets port 2222 for SSH
RUN cat /etc/ssh/sshd_config | grep -v "Port " > /etc/ssh/sshd_config.new && \
    echo "Port 2222" >> /etc/ssh/sshd_config.new && \
    mv /etc/ssh/sshd_config.new /etc/ssh/sshd_config

# Sets SSH file permissions and changes owner to 'jovyan'
RUN chmod 600 /etc/ssh/* && \
    chown jovyan:jovyan /etc/ssh/*

# Starts the SSHD server and Jupyter Notebook with the specified parameters
CMD /usr/sbin/sshd && jupyter notebook \
                    --notebook-dir=/home/jovyan \
                    --ip=0.0.0.0 \
                    --no-browser \
                    --allow-root \
                    --port=8888 \
                    --NotebookApp.token='' \
                    --NotebookApp.password='' \
                    --NotebookApp.base_url=${NB_PREFIX} \
                    --NotebookApp.allow_origin='https://*.ai.cloud.ru'

Создание и локальная проверка Docker-образа 

Создайте Docker-образ локально:

Запустить создание образа

docker build --tag 'jupyter-custom-image' .

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

Запустить проверку созданного образа

docker run -p 8888:8888 -e NB_PREFIX="/notebook/ai000001-00001/mynotebookname" -it jupyter-custom-image

Проверьте, что Jupyter Server запускается на порту 8888 с нужным префиксом (переменная окружения http://localhost:8888/a100-mt/notebook/ai000001-00001/mynotebookname).

Шаг 2. Пройдите аутентификацию в Docker registry 

Сгенерируйте ключ для Docker CLI:
1. В левом меню платформы перейдите в ML Space → Воркспейсы.
2. Возле воркспейса, для которого нужно сгенерировать ключ, нажмите и выберите Параметры разработчика.
3. Возле Docker CLI Key нажмите Сгенерировать ключ.
4. После генерации скопируйте ключ.
1. В левом меню перейдите в Data Catalog → Artifact Registry → Docker registry.
2. Сгенерируйте ключ для Docker registry:
  - Если в Docker registry нет загруженных образов, вместо виден значок . Чтобы изменить ключ, необходимо сгенерировать новый, нажав Сгенерировать ключ для Docker CLI.
  - Если в Docker registry есть загруженные образы, нажмите . В появившемся окне нажмите Сгенерировать ключ для Docker CLI.
3. После генерации скопируйте ключ.
Аутентифицируйтесь в Docker registry любым из предпочитаемых способов.

С помощью интерфейса ML Space можно аутентифицироваться в Docker CLI, используя команду:
```
docker login cr.ai.cloud.ru --username example@example.com --password examplepsswd
```
Где параметр example@example.com — это email пользователя, а examplepsswd — ключ, однократно передаваемый пользователю при нажатии на Сгенерировать ключ для Docker CLI.

Шаг 3. Загрузите образ в Docker registry 

Команду для использования тега можно просмотреть, нажав Push command в Docker registry.

docker push cr.ai.cloud.ru/хххххххх-хххх-хххх-хххх-хххххххххххх/jupyter-custom-image:test_tag

Эта команда позволяет загрузить образ jupyter-custom-image с тегом test_tag в Docker registry требуемого воркспейса.

Шаг 4. Создайте Jupyter Server из кастомного образа 

Воспользуйтесь инструкцией по созданию Jupyter Server.

Обратите внимание, что после запуска Jupyter Server значение переменной окружения aiхххххх-ххххх, будет установлено автоматически.

Переменную окружения можно посмотреть в адресной строке после запуска Jupyter Server.

Собрать и использовать кастомный Docker-образ для Jupyter Server

Шаг 1. Соберите кастомный образ для Jupyter Server

Пример создания кастомного образа из контейнеров NVIDIA

Фрагмент Docker-файла для добавления SSH

Создание и локальная проверка Docker-образа

Шаг 2. Пройдите аутентификацию в Docker registry

Шаг 3. Загрузите образ в Docker registry

Шаг 4. Создайте Jupyter Server из кастомного образа

Была ли статья полезной?

Шаг 1. Соберите кастомный образ для Jupyter Server 

Пример создания кастомного образа из контейнеров NVIDIA 

Фрагмент Docker-файла для добавления SSH 

Создание и локальная проверка Docker-образа 

Шаг 2. Пройдите аутентификацию в Docker registry 

Шаг 3. Загрузите образ в Docker registry 

Шаг 4. Создайте Jupyter Server из кастомного образа 