Раздел 1. Вводная часть¶
1.1. Назначение и область применения документа¶
Настоящий документ является технологической инструкцией по настройке, развёртыванию, сопровождению и восстановлению решения BOX5-DIT-MGSN в контуре проекта «BOX5-DIT-MGSN». Документ предназначен для системных администраторов, DevOps-инженеров и ответственных специалистов сопровождения, выполняющих операции на серверах, в Docker Swarm, в каталогах данных и в конфигурации решения.
Документ применяется при:
- первичном развёртывании и сопровождении DEV, TEST и PROD-контуров;
- переносе дистрибутива, Docker-образов, моделей и данных песочницы;
- настройке ролей нод кластера и параметров инференса;
- оффлайн-активации и восстановлении лицензирования Guardant;
- регламентном обслуживании, резервном копировании и восстановлении после сбоев.
Пользовательские действия в web-интерфейсе, прикладное администрирование ролей, камер, отчётов и сценариев описываются в документе «Инструкции администратора». Архитектура подсистем, состав сервисов и границы интеграций описываются в документе «Концептуальный проект».
технологическая инструкция"] env["DEV / TEST / PROD
серверы и Docker Swarm"] data["Данные, модели,
лицензии, конфигурация"] result["Работоспособный контур BOX5-DIT-MGSN"] admin --> instr instr --> env instr --> data env --> result data --> result
Исходный Mermaid-код схемы: И2-MER-001. 1.1. Назначение и область применения документа.
1.2. Условия выполнения технологических процессов¶
Технологические процессы выполняются только в согласованном окружении и при наличии актуального дистрибутива. DEV используется для разработки и первичной проверки изменений исполнителем, TEST - для проверки поставки перед переносом в промышленную эксплуатацию, PROD - для рабочего контура заказчика. Для PROD операции, влияющие на доступность системы, выполняются в технологическое окно после проверки той же версии поставки на TEST и после создания резервной копии.
Перед началом работ должны быть выполнены условия:
| Условие | Требование |
|---|---|
| Серверы | Подготовлены целевые мастер- и вычислительные ноды; для GPU-нод установлен NVIDIA driver и NVIDIA Container Toolkit. |
| Системное ПО | Установлены ОС, Docker, Docker Compose, pyyaml на мастер-ноде и набор эксплуатационных утилит, перечисленный в разделе 2. |
| Доступы | У администратора есть SSH-доступ к целевым нодам, права на выполнение Docker-команд, изменение systemd unit-файлов, чтение и запись рабочих каталогов. |
| Дистрибутив | Доступны каталог CODE, архив Docker-образов dockerimg.tgz, данные песочницы, модели и инструкция по версии поставки. |
| Каталоги данных | На всех нодах согласован путь COMPOSE_DATA_SWARM_PATH, типовое значение /data/compose-data2; для песочницы подготовлены /data/sandbox-compose-data и /data/models. |
| Лицензирование | Известен серийный номер LICENSE_KEY_SERIAL; для закрытого контура подготовлен порядок оффлайн-активации Guardant через порт 19191. |
| Сетевые условия | Ноды доступны друг другу по сети Docker Swarm; web-интерфейс, песочница и внешние интеграции используют согласованные IP-адреса и порты. |
| Резервное копирование | Перед изменениями сохранены ~/CODE, каталоги данных, модели, данные песочницы и сведения о версии поставки. |
При выполнении команд запрещается публиковать в документации, общих каналах и
заявках значения паролей, токенов, приватных ключей, полные .env-файлы,
серийные номера лицензий и другие конфиденциальные параметры. В командах и
примерах используются плейсхолдеры вида <master_ip>, <gpu_node>,
<backup_id>.
Если фактическая конфигурация целевого контура отличается от типовой инструкции, приоритет имеет проверенное состояние целевого контура. Отличия фиксируются в журнале работ вместе с версией поставки, временем изменения и результатом контрольных проверок.