ЛР 3 — БПИ2302— Кашкарова — на 3 #167

Open
ari_kash wants to merge 3 commits from ari_kash/mtusi2026lab3-kashkarova:solution/bpi2302_kashkarova into main
First-time contributor

Лабораторная 3

Автор / группа: Кашкарова Арина, БПИ2302
Целевая оценка: 3
Трек 5, если заявлен: Не заявлен

Что реализовано и что перенесено:

  • Перенесен работающий минимум Lab 2 (PostgreSQL, миграции, Basic → Bearer аутентификация).
  • Стенд масштабирован: запускаются две API-реплики (api-1 и api-2) в Docker Compose.
  • Настроен балансировщик Nginx, который является единой точкой входа (порт 8080) и распределяет трафик между репликами. Прямой доступ к API-портам наружу закрыт.
  • Добавлен заголовок X-Instance-Id во все ответы API (генерируется из переменной окружения), позволяющий отслеживать, какая именно реплика обработала запрос.
  • Реализована общая идемпотентность: на POST /api/v1/chats/{chat_id}/messages теперь обязателен заголовок Idempotency-Key. Добавлена таблица idempotency_keys (миграция 002_idempotency.sql), которая атомарно сохраняет результат запроса и защищает от создания дублей при конкурентных запросах.
  • Настроен graceful shutdown для API (через stop_grace_period в Compose) и проверки готовности (healthcheck), чтобы Nginx мгновенно исключал упавший узел из балансировки.
  • Реализованы скрипты для проверки отказов в среде Windows: scripts/stop-one.bat (останавливает одну реплику) и обновленный scripts/restart.bat (перезапускает стенд с сохранением volume).

Команды запуска из чистого clone:

# 1. Клонирование и переход в директорию
git clone https://gitea.privcloud.tech/ari_kash/mtusi2026lab3.git
cd mtusi2026lab3

# 2. Создание и активация виртуального окружения (Windows / Git Bash)
python -m venv .venv
source .venv/Scripts/activate

# 3. Установка зависимостей
pip install -r requirements.txt
pip install -r requirements-dev.txt

# 4. ВАЖНО: Установка кодировки для корректного вывода кириллицы в Windows
export PYTHONUTF8=1

# 5. Запуск стенда (Nginx + API x2 + PostgreSQL)
docker compose up -d --build

# 6. Проверка готовности (должен вернуть {"status":"ok"})
curl http://localhost:8080/health/ready

# 7. Запуск тестов
python tests/smoke.py --base-url "http://localhost:8080"
python tests/resilience.py --mode persistence --action-script "scripts/restart.bat" --base-url "http://localhost:8080"
python tests/resilience.py --mode failover --action-script "scripts/stop-one.bat" --base-url "http://localhost:8080"

# 8. Безопасная остановка (данные сохраняются)
docker compose down
# Полное удаление данных (для сброса): docker compose down -v

###Результаты проверок и ссылка на REPORT.md:
Результат smoke теста:
`PASS: lab2 public API scenario; infrastructure and grading evidence remain separate.`
Результат failover теста:
`{"observed_instances_before": 2, "successful_writes": 80, "failed_attempts": 2, "first_recovery_seconds": 2.812}`
`PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence`
Подробная инструкция, архитектура и доказательства критериев описаны в файле [REPORT.md.](https://gitea.privcloud.tech/ari_kash/mtusi2026lab3-kashkarova/src/branch/solution/bpi2302_kashkarova/README.md)

###Ограничения / известные ошибки:
- Уровень 3: сессии хранятся в PostgreSQL (Redis/Valkey не используется, так как это требование для оценки «4»).
- Стенд развернут на одном Docker-host, поэтому отказ самого физического сервера или падение единственного экземпляра PostgreSQL не покрываются (репликация БД не настроена, для оценки «3» это не требуется).
- Скрипты перезапуска и остановки реплик реализованы как .bat файлы из-за особенностей работы Docker Desktop и Git Bash в ОС Windows.

###Источники и использование ИИ:
Python 3.11, FastAPI, Uvicorn, Pydantic, PostgreSQL 16.4, Nginx 1.27, psycopg2-binary, bcrypt, Docker, Docker Compose. ИИ использовался для генерации начального скелета кода, отладки конфигурации Nginx (балансировка и таймауты), настройки Docker Compose (две реплики и лимиты) и реализации логики идемпотентности.

- [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами.
- [x] Контракт и публичные тесты не ослаблены.
- [x] make check и make test выполнены; приложен реальный вывод.
- [x] Сценарии отказов/безопасности своего уровня воспроизведены.
- [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens.
- [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.
## Лабораторная 3 **Автор / группа:** Кашкарова Арина, БПИ2302 **Целевая оценка:** 3 **Трек 5, если заявлен:** Не заявлен ### Что реализовано и что перенесено: - Перенесен работающий минимум Lab 2 (PostgreSQL, миграции, Basic → Bearer аутентификация). - Стенд масштабирован: запускаются **две API-реплики** (`api-1` и `api-2`) в Docker Compose. - Настроен балансировщик **Nginx**, который является единой точкой входа (порт 8080) и распределяет трафик между репликами. Прямой доступ к API-портам наружу закрыт. - Добавлен заголовок `X-Instance-Id` во все ответы API (генерируется из переменной окружения), позволяющий отслеживать, какая именно реплика обработала запрос. - Реализована **общая идемпотентность**: на `POST /api/v1/chats/{chat_id}/messages` теперь обязателен заголовок `Idempotency-Key`. Добавлена таблица `idempotency_keys` (миграция `002_idempotency.sql`), которая атомарно сохраняет результат запроса и защищает от создания дублей при конкурентных запросах. - Настроен graceful shutdown для API (через `stop_grace_period` в Compose) и проверки готовности (`healthcheck`), чтобы Nginx мгновенно исключал упавший узел из балансировки. - Реализованы скрипты для проверки отказов в среде Windows: `scripts/stop-one.bat` (останавливает одну реплику) и обновленный `scripts/restart.bat` (перезапускает стенд с сохранением volume). ### Команды запуска из чистого clone: ```bash # 1. Клонирование и переход в директорию git clone https://gitea.privcloud.tech/ari_kash/mtusi2026lab3.git cd mtusi2026lab3 # 2. Создание и активация виртуального окружения (Windows / Git Bash) python -m venv .venv source .venv/Scripts/activate # 3. Установка зависимостей pip install -r requirements.txt pip install -r requirements-dev.txt # 4. ВАЖНО: Установка кодировки для корректного вывода кириллицы в Windows export PYTHONUTF8=1 # 5. Запуск стенда (Nginx + API x2 + PostgreSQL) docker compose up -d --build # 6. Проверка готовности (должен вернуть {"status":"ok"}) curl http://localhost:8080/health/ready # 7. Запуск тестов python tests/smoke.py --base-url "http://localhost:8080" python tests/resilience.py --mode persistence --action-script "scripts/restart.bat" --base-url "http://localhost:8080" python tests/resilience.py --mode failover --action-script "scripts/stop-one.bat" --base-url "http://localhost:8080" # 8. Безопасная остановка (данные сохраняются) docker compose down # Полное удаление данных (для сброса): docker compose down -v ###Результаты проверок и ссылка на REPORT.md: Результат smoke теста: `PASS: lab2 public API scenario; infrastructure and grading evidence remain separate.` Результат failover теста: `{"observed_instances_before": 2, "successful_writes": 80, "failed_attempts": 2, "first_recovery_seconds": 2.812}` `PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence` Подробная инструкция, архитектура и доказательства критериев описаны в файле [REPORT.md.](https://gitea.privcloud.tech/ari_kash/mtusi2026lab3-kashkarova/src/branch/solution/bpi2302_kashkarova/README.md) ###Ограничения / известные ошибки: - Уровень 3: сессии хранятся в PostgreSQL (Redis/Valkey не используется, так как это требование для оценки «4»). - Стенд развернут на одном Docker-host, поэтому отказ самого физического сервера или падение единственного экземпляра PostgreSQL не покрываются (репликация БД не настроена, для оценки «3» это не требуется). - Скрипты перезапуска и остановки реплик реализованы как .bat файлы из-за особенностей работы Docker Desktop и Git Bash в ОС Windows. ###Источники и использование ИИ: Python 3.11, FastAPI, Uvicorn, Pydantic, PostgreSQL 16.4, Nginx 1.27, psycopg2-binary, bcrypt, Docker, Docker Compose. ИИ использовался для генерации начального скелета кода, отладки конфигурации Nginx (балансировка и таймауты), настройки Docker Compose (две реплики и лимиты) и реализации логики идемпотентности. - [x] Весь обязательный минимум текущей и предыдущих работ сохранён с объявленными переходами. - [x] Контракт и публичные тесты не ослаблены. - [x] make check и make test выполнены; приложен реальный вывод. - [x] Сценарии отказов/безопасности своего уровня воспроизведены. - [x] Все секреты и приватные ключи находятся вне Git; отчёт не содержит tokens. - [x] README задания сохранён, REPORT.md содержит инструкцию именно моего решения.
ari_kash added 3 commits 2026-11-17 19:42:49 +03:00
You are not authorized to merge this pull request.
This pull request can be merged automatically.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u https://gitea.privcloud.tech/ari_kash/mtusi2026lab3-kashkarova solution/bpi2302_kashkarova:ari_kash-solution/bpi2302_kashkarova
git checkout ari_kash-solution/bpi2302_kashkarova
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: mtusi2026/mtusi2026lab3#167