FastAPI-приложение с масштабируемой инфраструктурой

Цель данного проекта — разработка FastAPI-приложения, которое станет основой для будущего API чат-бота. Хотя сами конечные точки API будут относительно простыми, основное внимание в этом проекте уделяется настройке инфраструктуры, требующей навыков DevOps для обеспечения масштабируемости, безопасности и автоматизации.

Основные задачи 

1. Контейнеризация и развертывание
   • Настройка окружения:
   o Настроить два отдельных окружения:
   ▪ Development/Staging: работает на порту 8000
   ▪ Production: работает на порту 443 (HTTPS)

   • Непрерывная интеграция и развертывание (CI/CD):
   o Реализовать GitLab CI/CD pipeline для автоматизированного развертывания.
   o Включить автоматизированные тесты в pipeline (привести как минимум один пример теста).
   o Развернуть продакшн-экземпляр на виртуальной машине (VM) для обеспечения корректной реализации.

2. База данных и безопасность
   • Управление базой данных:
   o Подключить оба окружения к базе данных PostgreSQL, работающей в виде Docker-сервиса.

   • Меры безопасности:
   o Обеспечить безопасность продакшн-окружения, реализовав:
   ▪ NGINX в качестве обратного прокси/балансировщика нагрузки.
   ▪ HTTPS с использованием бесплатного SSL-сертификата (например, Certbot).

3. Механизм кэширования (реализация с использованием Docker)
   • Реализовать кэширование в рамках Docker-инфраструктуры для повышения производительности API.
   • Использовать Redis в качестве слоя кэширования (или предложить лучший вариант, исходя из конкретного случая использования).

4. Аутентификация и тестирование
   • Аутентификация:
   o Реализовать OAuth 2.0 с использованием Client Credentials Flow вместо традиционной аутентификации JWT.

   • Тестирование:
   o Настроить набор модульных тестов, который будет запускаться в рамках CI/CD pipeline, чтобы обеспечить качество и надежность кода.

5. Реализация API
   • Соблюдение руководства по API:
   o Следовать предоставленному руководству по API для корректной реализации необходимых конечных точек.

   • Проверка Swagger UI:
   o Документация Swagger UI должна точно соответствовать ожидаемой документации API.

Проверка выполнения задания и оценка работы

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

1. Развертывание и инфраструктура:
   o Проверить, что приложение корректно развернуто на виртуальной машине (VM).
   o Убедиться, что Docker-окружения настроены правильно для Development/Staging и Production.
   o Проверить, что CI/CD pipeline правильно автоматизирует тестирование и развертывание.

2. Безопасность и производительность:
   o Подтвердить, что база данных PostgreSQL корректно интегрирована и работает в виде Docker-сервиса.
   o Проверить, что обратный прокси/балансировщик нагрузки NGINX правильно настроен.
   o Убедиться, что HTTPS активирован и защищён с помощью SSL-сертификата от Certbot.
   o Протестировать функциональность кэширования с использованием Redis (или предложенного лучшего альтернативного варианта).

3. Функциональность API и документация:
   o Сравнить документацию Swagger UI с ожидаемой документацией API.
   o Проверить, что все конечные точки работают в соответствии с описанием в руководстве по API.
   o Провести интеграционные тесты для подтверждения корректной реализации аутентификации OAuth 2.0.

4. Тестирование и качество кода:
   o Запустить набор модульных тестов, чтобы убедиться, что они успешно выполняются в рамках CI/CD pipeline.
   o Провести обзор качества и структуры кода для обеспечения соблюдения лучших практик.
   
   

Спасибо!