Перейти к содержанию

Обзор развертывания Jupyter Notebook на сервере

Предварительные требования

Для успешного развертывания приложения требуются следующие условия:

  • Операционная система: Ubuntu.

  • Права доступа: права суперпользователя (root) для установки системных пакетов и управления сервисами.

  • Порты:

  • Внутренний порт приложения: 8888.

  • Внешний порт для доступа через HTTPS: 443.

FQDN итоговой панели на домене hostkey.in

Доступ к интерфейсу осуществляется по следующему шаблону домена:

Параметр Значение
Префикс notebook
Домен hostkey.in
Полный шаблон notebook{Server_ID_from_Invapi}.hostkey.in

Структура файлов и каталогов

В системе создаются следующие директории для хранения данных и конфигураций:

  • /opt/data — основное хранилище данных приложения.

  • /opt/data/jupyter — директория виртуального окружения Python.

  • /root/nginx — рабочая директория контейнера Nginx (содержит compose.yml).

  • /data/nginx/user_conf.d — пользовательские конфигурации Nginx.

  • /data/nginx/nginx-certbot.env — файл переменных окружения для SSL.

Процесс установки приложения

Развертывание выполняется в несколько этапов:

  1. Подготовка системы: Создается системная группа jupyter и пользователь jupyter. Настраиваются права доступа к директории /opt/data.

  2. Установка зависимостей: Через пакетный менеджер устанавливаются python3, python3-pip, jupyter, python3-virtualenv.

  3. Настройка окружения Python:

  4. Создается виртуальное окружение в директории /opt/data/jupyter.

  5. Внутри виртуального окружения устанавливаются пакеты: notebook, voila, virtualenv, jupyter-server.

  6. Конфигурация Jupyter:

  7. Генерируется стандартный конфигурационный файл.

  8. Настраивается параметр c.ServerApp.allow_origin = '*' для обеспечения доступа.

  9. Устанавливается пароль для входа в интерфейс.

  10. Регистрация сервиса: Создается системная служба jupyter-notebook для автоматического запуска приложения при загрузке системы.

  11. Настройка проксирования: Развертывается контейнер Nginx с поддержкой SSL через Docker Compose.

Права доступа и безопасность

  • Для работы Jupyter используется выделенный системный пользователь jupyter.

  • Конфигурационные файлы Nginx и директория /root/nginx принадлежат пользователю root.

  • Доступ к данным осуществляется через защищенное соединение по порту 443.

Базы данных

В данной конфигурации внешние базы данных не используются; данные хранятся локально в файловой системе сервера.

Контейнеры Docker и их запуск

Для обеспечения работы веб-интерфейса и SSL-сертификатов используется следующий контейнер:

Имя образа Порты (в режиме host) Тома (volumes) Переменные окружения Политика перезапуска
jonasal/nginx-certbot:latest 443 (через network_mode: host) - nginx_secrets:/etc/letsencrypt
- /data/nginx/user_conf.d:/etc/nginx/user_conf.d
- /home:/home
CERTBOT_EMAIL=hkadm@hostkey.com (из env_file) unless-stopped

Кастомные скрипты и дополнительные настройки

В процессе установки выполняются следующие действия:

  • Генерация конфигурации Jupyter Notebook через команду /opt/data/jupyter/bin/jupyter notebook --generate-config.

  • Настройка параметров безопасности (разрешение CORS) путем редактирования файла конфигурации.

  • Инициализация пароля доступа для пользователя.

Инструкция по обновлению приложения

Для обновления основного приложения необходимо:

  1. Обновить системные пакеты через apt upgrade.

  2. Если требуется обновление компонентов внутри виртуального окружения, выполнить команду:

    /opt/data/jupyter/bin/pip install --upgrade notebook voila jupyter-server
    

  3. Перезапустить службу приложения:

    systemctl restart jupyter-notebook
    

Расположение конфигурационных файлов и данных

Тип файла Путь к файлу
Конфигурация Jupyter /root/.jupyter/jupyter_server_config.json (или аналогичный в домашней директории пользователя)
Данные приложения /opt/data/jupyter/share/jupyter
Docker Compose /root/nginx/compose.yml

Доступные порты для подключения

  • 443 — доступ к веб-интерфейсу через HTTPS (через Nginx).

  • 8888 — внутренний порт приложения (доступен локально на сервере).

Запуск, остановка приложения

Управление основным сервисом Jupyter Notebook осуществляется через systemd:

  • Запуск: systemctl start jupyter-notebook

  • Остановка: systemctl stop jupyter-notebook

  • Статус: systemctl status jupyter-notebook

  • Автозагрузка: Включена по умолчанию.

question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×