Введение

Настоящий документ содержит руководство по установке программного продукта EDA (Enhanced Dynamic Activation), предоставленного для экспертной оценки. Продукт реализует функции динамической активации сетевых сервисов, лицензий и функций с поддержкой REST API и CLI-интерфейсов.

Основные функциональные возможности:

Обработка запросов на активацию через REST API (FastAPI) с поддержкой шаблонов сервисов

Управление сетевыми элементами с блокировкой и возобновлением активаций

Движок активации с поддержкой состояний CREATED, VALIDATING, ACTIVATING, ACTIVE, FAILED

Деактивация сервисов с автоматическим откатом изменений

Пакетная активация с независимой обработкой каждого элемента

Автоматический повтор неудачных активаций (auto-retry) с настраиваемым количеством попыток

Webhook-уведомления о завершении активаций

Блокировка сетевых элементов (maintenance mode) с постановкой активаций в состояние HELD

Алармы с возможностью просмотра активных и очистки

Prometheus-метрики для мониторинга

Опциональная аутентификация по API-ключу

Логирование выполнения шагов активации

Программное обеспечение распространяется в исходных кодах. Актуальная версия исходного кода хранится в системе контроля версий Git.

1. Системные требования

1.1 Общие положения

Программное обеспечение является кроссплатформенным и может быть установлено на различные операционные системы семейства UNIX. Рекомендуется использование серверных операционных систем, оптимизированных для работы с сетевыми приложениями.

1.2 Аппаратные требования

Минимальные требования (для тестовых и ознакомительных целей):

Процессор: 2 ядра x86-64

Оперативная память: 4 ГБ

Дисковое пространство: 1 ГБ

Рекомендуемые требования (для лабораторных сред):

Процессор: 4-8 ядер Intel Xeon (или аналогичный серверный процессор)

Оперативная память: 8-16 ГБ

Дисковое пространство: 10 ГБ (для хранения логов и состояния)

Сетевой интерфейс: 1 Гбит/с и более

1.3 Поддерживаемые операционные системы

Серверные ОС:

Ubuntu Server 20.04 LTS / 22.04 LTS и более поздние

Debian 11 / 12

Rocky Linux 8 / 9

Десктопные ОС (для разработки и тестирования):

Ubuntu Desktop 20.04 / 22.04 и более поздние

Windows 10/11 (с использованием WSL2)

1.4 Программные зависимости

Для сборки из исходного кода необходимы:

1.5 Требования к настройке окружения

Для обеспечения стабильной работы при высоких нагрузках рекомендуется выполнить настройку параметров системы.

Параметры сетевого стека (Linux):

2. Сборка из исходного кода

2.1 Подготовка системы

Перед началом сборки необходимо установить требуемые пакеты (Linux):

sudo apt update

sudo apt install -y git python3 python3-pip python3-venv

Для Windows рекомендуется использовать WSL2 с Ubuntu 20.04/22.04.

2.2 Получение исходного кода

Исходный код доступен в системе контроля версий Git. Адрес репозитория необходимо уточнить у ответственного за распространение программного обеспечения.

После получения адреса репозитория выполните клонирование:

git clone <адрес_репозитория>

cd eda

2.3 Настройка параметров сборки

Создайте виртуальное окружение и установите зависимости:

python -m venv .venv

source .venv/bin/activate

pip install -e ".[dev]"

Для Windows (в WSL2):

python -m venv .venv

source .venv/bin/activate

pip install -e ".[dev]"

2.4 Проверка сборки

Для проверки корректности сборки запустите тесты:

pytest tests/ -q

Все тесты должны успешно выполняться. Для запуска API-сервера выполните:

eda-server

Программа должна запуститься и вывести информацию о запуске. Для остановки нажмите Ctrl+C.

3. Установка и настройка

3.1 Установка программы

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

pip install -e .

По умолчанию программа устанавливается в виртуальное окружение. Для глобальной установки используйте:

pip install .

3.2 Добавление в переменную окружения PATH

Если при установке был выбран нестандартный каталог, добавьте его в переменную окружения PATH. Для этого отредактируйте файл ~/.bashrc или ~/.profile, добавив строку:

export PATH=$PATH:/путь/к/каталогу/с/программой

После редактирования примените изменения:

source ~/.bashrc

3.3 Проверка установки

Убедитесь, что программа доступна для запуска из любой директории:

eda-cli health

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

4. Запуск в Docker-контейнере

4.1 Подготовка Docker-образа

Для запуска программы в контейнерной среде используется Dockerfile, расположенный в директории docker/. В директории с исходным кодом находится файл docker/Dockerfile.

4.2 Сборка Docker-образа

Выполните сборку образа, указав тег:

docker build -f docker/Dockerfile -t eda:latest .

4.3 Запуск контейнера

Для запуска контейнера выполните:

docker compose -f docker/docker-compose.yml up --build

Параметры запуска:

-f docker/docker-compose.yml --- указание файла композиции

--build --- пересборка образов перед запуском

Для запуска в фоновом режиме используйте флаг -d:

docker compose -f docker/docker-compose.yml up -d

4.4 Управление контейнером

Для остановки программы нажмите Ctrl+C, после чего контейнер завершит работу. Для просмотра логов контейнера используйте:

docker compose -f docker/docker-compose.yml logs -f

Для остановки контейнера:

docker compose -f docker/docker-compose.yml down

Приложение А. Параметры конфигурации

А.1 Переменные окружения

Программа настраивается с использованием переменных окружения:

EDA_API_URL --- URL для доступа к API (по умолчанию http://localhost:8080)

EDA_API_KEY --- секретный ключ для аутентификации (опционально)

EDA_DB_PATH --- путь к файлу базы данных SQLite

EDA_LOG_LEVEL --- уровень логирования (INFO, DEBUG, WARNING, ERROR)

А.2 Параметры API-сервера

API-сервер настраивается через параметры командной строки или переменные окружения:

--host --- адрес для привязки сервера

--port --- порт для HTTP-сервера

--reload --- автоматическая перезагрузка при изменениях (для разработки)

А.3 Параметры CLI

CLI-клиент использует следующие параметры:

--api-url --- адрес API-сервера

--api-key --- ключ для аутентификации

--json --- вывод в формате JSON для скриптов и интеграций

А.4 Конфигурационный файл параметров

Полный каталог конфигурационных параметров в машиночитаемом виде доступен в файле parameters/eda_parameters.json (формат: type, path, group, mandatory, default, release и т.д.). Подробное описание параметров приведено в документации docs/PARAMETERS.md.