Files
mtusi2026lab3-fork/README.md
T
2026-11-02 20:05:33 +03:00

55 lines
3.7 KiB
Markdown
Raw 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. Балансировка и отказ API-реплики
Реализация уровня 4: Compose, Nginx, две взаимозаменяемые API-реплики,
общие PostgreSQL и Redis. Наружу открыт только `http://localhost:8080`.
[Запуск и команды](GUIDE.md) · [Отчёт](REPORT.md) · [Сценарий и вопросы защиты](DEFENSE.md) ·
[Evidence](EVIDENCE.md) · [OpenAPI](contracts/openapi.json) · [Семантика](contracts/README.md) ·
[Публичные проверки](tests/README.md) · [Карта курса](COURSE.md) · [Процесс PR](CONTRIBUTING.md)
```mermaid
flowchart TD
C[Клиент] --> N[Nginx]
N --> A[API A]
N --> B[API B]
A --> P[PostgreSQL]
B --> P
A --> R[Redis]
B --> R
```
## Быстрый старт
Нужны Docker Engine, Compose v2.24+ и Python 3.9+ для скриптов на хосте.
API работает на Python 3.12. На Windows используйте WSL2, поскольку action hooks — sh.
```sh
cp env.lab3.template .env
# Замените POSTGRES_PASSWORD в .env на свой случайный пароль из латинских букв и цифр.
docker compose --env-file .env up -d --build
python3 scripts/replicas.py restore
make test
make test-student
```
`migrate` однократно применяет миграции перед API. `restore` ждёт готовности обеих
реплик через LB. Сессии и сообщения сохраняются в `pgdata`; удалять volume не нужно.
## Что реализовано для 3 и 4
| Требование | Реализация / проверка |
| --- | --- |
| Две реплики, единый LB, общие данные | `api-a`, `api-b`, Nginx; PostgreSQL sessions/messages; `make replicas` |
| Одна сессия на обеих репликах | `X-Instance-Id` генерируется на запуск процесса; `lab3_evidence.py` наблюдает обе |
| Отказ любой одной реплики | `scripts/stop-one.sh` находит настоящий контейнер по TARGET_INSTANCE_ID и оставляет его остановленным |
| Общая идемпотентность на 24 ч | Транзакция PostgreSQL: advisory lock, сообщение и результат POST; повтор другого тела — 409 |
| Persistence и failover | `make test-persistence`, `make test-failover` |
| Readiness, DNS, SIGTERM и таймауты | Активный опрос readiness в LB, динамический Docker DNS, graceful shutdown Uvicorn |
| Последовательный отказ каждой реплики | `make lab3-evidence`; отдельные JSON с RPS, ошибками, восстановлением, ID/PID |
| CPU/RAM, закрытые backend-порты | `cpus`, `mem_limit` у всех служб; ports есть только у Nginx; нет container_name |
| Поочерёдная замена под нагрузкой | `make lab3-evidence` заменяет каждую реплику и проверяет данные; `make rolling` для ручного обновления |
| Однократные миграции | Отдельная служба migrate и advisory lock; API схему не меняют |
Это реализация и воспроизводимая методика, а не заявление о пройденной приёмке.
Фактически выполненные проверки и не выполненные Docker-эксперименты перечислены в EVIDENCE.md.