Инструкция по установке программного обеспечения «Кадровый резерв»
1. Назначение документа
Настоящий документ описывает общий порядок развертывания программного обеспечения «Кадровый резерв» в инфраструктуре заказчика.
Программное обеспечение поставляется для локального размещения и запускается в контейнеризированном окружении.
2. Состав программного окружения
Для работы программного обеспечения используются:
базовая операционная система: Alpine Linux 3.22 или другие;
контейнеризация: Docker;
средство управления контейнерами: Docker Compose;
система управления базами данных: PostgreSQL;
программная платформа приложения: Go 1.25;
сервер приложений: собственный сервис «Кадровый резерв» на Go.
3. Требования к инфраструктуре
Для развертывания требуется сервер или виртуальная машина, на которой обеспечены:
работа Alpine Linux 3.22 или аналог;
установленный Docker;
установленный Docker Compose;
достаточный объем оперативной памяти и дискового пространства для размещения базы данных, поисковых индексов и данных кандидатов;
сетевой доступ к API сервиса со стороны информационных систем заказчика.
Точные требования к вычислительным ресурсам определяются объемом базы кандидатов и планируемой интенсивностью запросов.
4. Подготовка к установке
Перед установкой необходимо:
подготовить сервер или виртуальную машину;
установить и проверить Docker;
установить и проверить Docker Compose;
подготовить каталог размещения программного комплекса;
разместить в каталоге поставляемые контейнерные образы и конфигурационные файлы;
определить параметры подключения к PostgreSQL;
настроить параметры доступа к API в соответствии с инфраструктурой заказчика.
5. Развертывание
Программный комплекс включает как минимум:
контейнер PostgreSQL;
контейнер API-сервиса «Кадровый резерв»;
конфигурационные файлы;
миграции базы данных;
необходимые поисковые расширения и служебные компоненты.
Для запуска комплекса необходимо перейти в каталог развертывания и выполнить:
docker compose up -d
Команда запускает сервисы в фоновом режиме.
6. Первичная инициализация
При первом запуске выполняются:
создание и обновление структуры базы данных;
применение миграций;
подготовка поисковых структур;
запуск API-сервиса.
Время первичного запуска зависит от объема начальных данных и характеристик сервера.
7. Проверка состояния
Состояние контейнеров проверяется командой:
docker compose ps
Контейнеры PostgreSQL и API-сервиса должны находиться в состоянии Up или running.
Для проверки готовности приложения используется служебный HTTP-метод проверки состояния, предусмотренный поставкой.
Пример:
curl -s http://localhost:8080/healthz
Ожидаемый ответ:
ok
8. Настройка PostgreSQL
PostgreSQL используется для хранения:
профилей кандидатов;
справочной информации;
исходных данных резюме;
поисковых структур и индексов;
служебной информации системы.
Параметры подключения к базе данных задаются в конфигурации поставки.
9. Настройка правил поиска и фильтрации
Часть поведения системы задается конфигурацией.
В конфигурации могут определяться:
правила обработки отсутствующих значений;
параметры отдельных фильтров;
параметры поисковой обработки;
параметры нормализации результатов;
служебные параметры приложения.
10. Настройка сетевого доступа
API-сервис должен быть доступен только тем информационным системам и пользователям, которым это необходимо в соответствии с политиками безопасности заказчика.
При промышленном развертывании рекомендуется ограничивать сетевой доступ средствами инфраструктуры заказчика.
11. Обновление программного обеспечения
Обновление выполняется путем замены поставляемых контейнерных образов и, при необходимости, конфигурационных файлов.
Типовой порядок:
создать резервную копию базы данных;
остановить сервисы;
заменить контейнерные образы;
проверить конфигурацию;
запустить новую версию;
дождаться применения миграций;
проверить состояние сервиса;
выполнить контрольный поисковый запрос.
12. Остановка
Для остановки программного комплекса используется:
docker compose stop
Для повторного запуска:
docker compose up -d
13. Проверка после установки
После завершения установки рекомендуется выполнить:
проверку состояния контейнеров;
проверку доступности API;
получение справочников;
загрузку тестового кандидата;
выполнение тестового поискового запроса;
проверку получения ранжированного ответа.
После успешного выполнения указанных действий программное обеспечение считается готовым к эксплуатации.