Files
2026-11-09 15:19:41 +03:00

72 lines
7.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Отчёт — лабораторная 3
- Автор, группа: Бондаренко Мария Максимовна, БПИ2302
- Целевая оценка: 4
## 1. Запуск из чистого clone
### Зависимости и предусловия
- Установленный Docker и Docker Compose.
- Python 3.9+ для запуска локальных тестов.
### Пошаговые команды запуска и проверки
1. Создать .env из шаблона и заполнить локальные секреты. Задать в .env: POSTGRES_PASSWORD, SECRET_HMAC_KEY
2. Собрать и запустить стенд:
docker compose --env-file .env up -d --build
3. Дождаться готовности всех сервисов:
docker compose ps
curl -s http://localhost:8080/health/ready
4. Публичные проверки:
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh
make test-failover ACTION_SCRIPT=scripts/stop-one.sh
При повторном запуске последнего теста (test-failover) необходимо перезапустить контейнеры api-1 и api-2 с помощью команды docker compose start api-1 api-2 или docker compose restart
5. Остановка и очистка данных:
docker compose stop
docker compose down -v
## 2. Архитектура и решения
- Точка входа и балансировка: Публичный доступ осуществляется строго через единую точку входа Nginx. Балансировщик распределяет HTTP-запросы между двумя API-репликами (api-1:8080 и api-2:8080) по алгоритму Round-Robin
- Пассивный Health Check и отказоустойчивость LB: В nginx настроены параметры max_fails=1 fail_timeout=5s и директива proxy_next_upstream error timeout http_502 http_503 http_504. В случае временной недоступности или сбоя одной из реплик Nginx автоматически перенаправляет запрос на соседний экземпляр без выдачи ошибки клиенту
- Идентификация реплик: Каждый ответ API содержит заголовок X-Instance-Id, жестко заданный через переменные окружения, что позволяет отслеживать конкретную реплику, обслужившую запрос
- Изолированный запуск миграций: Миграция структуры БД выделена в самостоятельный одноразовый сервис migrate, который ожидает готовности PostgreSQL и выполняет migrations/init.sql до старта API-реплик, предотвращая состояние гонки при создании таблиц
- Атомарная идемпотентность: В PostgreSQL создана таблица idempotency_keys с первичным ключом (user_id, method, path, key). Обработка Idempotency-Key выполняется в рамках одной транзакции СУБД с использованием INSERT ... ON CONFLICT DO NOTHING, что исключает появление дубликатов сообщений при параллельных повторных запросах через разные реплики API
- Безопасность и лимиты: Порты бэкендов api-1 и api-2 не публикуются наружу в обход Nginx. В compose.yaml для всех сервисов заданы аппаратные ограничения ресурсов. В Dockerfile и compose.yaml настроен Graceful Shutdown
## 3. Доказательства выполнения критериев
| Критерий README | Команда / Сценарий | Наблюдаемый результат | Файл доказательства |
| --- | --- | --- | --- |
| Проверка публичного API | make test | PASS: lab3 public API scenario; infrastructure and grading evidence remain separate. | tests/smoke.py |
| Сохранение данных при перезапуске | make test-persistence ACTION_SCRIPT=scripts/restart.sh | PASS: persistence preserved confirmed data and existing session. Hook scope needs operator evidence. | scripts/restart.sh, tests/resilience.py |
| Выдерживание отказа реплики API | make test-failover ACTION_SCRIPT=scripts/stop-one.sh | PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence. | scripts/stop-one.sh, tests/resilience.py |
| Поочерёдное обновление | ./scripts/rolling-update.sh | Поочерёдная перезаборка api-1 и api-2 с ожиданием /health/ready и перезагрузкой Nginx | scripts/rolling-update.sh |
| Нагрузочное тестирование при Rolling Update | python3 tests/load.py --duration 60 --concurrency 4 --output evidence/load-rolling.json | | evidence/load-rolling.json |
| Ресурсные лимиты и изоляция | Описание в compose.yaml | Все сервисы имеют лимиты CPU/RAM; API доступен только через Nginx | compose.yaml |
## 4. Эксперименты и отказы
### 4.1. Тест отказоустойчивости
В ходе автоматизированного теста resilience.py производилась параллельная запись сообщений с проверкой балансировки:
- Наблюдаемые реплики до отказа: 2 (api-replica-1, api-replica-2)
- Воздействие: Выполнение scripts/stop-one.sh и принудительная остановка реплики TARGET_INSTANCE_ID с таймаутом docker compose stop -t 3
- Результат: Зафиксировано 77 успешных записей при 2 неудачных попытках в момент переключения; время восстановления составило 1.125 сек. Все подтвержденные сообщения сохранились без дублирования
### 4.2. Нагрузка во время поочерёдной замены
Во время проведения поочерёдного обновления контейнеров (scripts/rolling-update.sh) выполнялся нагрузочный сценарий tests/load.py:
- Параметры: Длительность 60 с, параллелизм (concurrency) = 4.
- Метрики:
- - Успешные запросы: 1272
- - Ошибки: 0 (error_ratio: 0.0)
- - Средняя пропускная способность: 21.112 RPS
- - Латентность успешных запросов: p50 = 188.0 ms, p95 = 297.0 ms, p99 = 406.0 ms
## 5. Ограничения и следующие шаги
- Пассивный Health Check в Nginx OSS: Балансировщик Nginx OSS использует пассивное обнаружение отказов и повторный запрос через proxy_next_upstream. Активный поллинг ендпоинта /health/ready со стороны балансировщика без использования сторонних модулей или Nginx Plus не поддерживается
- Ограничения хоста: Тестирование проводилось на локальном стенде (Windows/Docker Desktop). При дальнейшем масштабировании узлов потребуется переход на оркестрацию уровня Docker Swarm