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 Провести огляд якості та структури коду для забезпечення дотримання кращих практик.
   
   

Дякую!