Aplikacja FastAPI z skalowalną infrastrukturą

Celem tego projektu jest opracowanie aplikacji FastAPI, która stanie się podstawą dla przyszłego API chatbota. Chociaż same punkty końcowe API będą stosunkowo proste, główny nacisk w tym projekcie kładzie się na konfigurację infrastruktury, wymagającej umiejętności DevOps w celu zapewnienia skalowalności, bezpieczeństwa i automatyzacji.

Główne zadania 

1. Konteneryzacja i wdrożenie
   • Konfiguracja środowiska:
   o Skonfigurować dwa oddzielne środowiska:
   ▪ Development/Staging: działa na porcie 8000
   ▪ Production: działa na porcie 443 (HTTPS)

   • Ciągła integracja i wdrożenie (CI/CD):
   o Zrealizować pipeline CI/CD GitLab dla zautomatyzowanego wdrożenia.
   o Włączyć zautomatyzowane testy do pipeline (podaj przynajmniej jeden przykład testu).
   o Wdrożyć produkcyjny egzemplarz na maszynie wirtualnej (VM) w celu zapewnienia poprawnej realizacji.

2. Baza danych i bezpieczeństwo
   • Zarządzanie bazą danych:
   o Podłączyć oba środowiska do bazy danych PostgreSQL działającej jako usługa Docker.

   • Środki bezpieczeństwa:
   o Zapewnić bezpieczeństwo środowiska produkcyjnego, realizując:
   ▪ NGINX jako odwrotny proxy/balansujący obciążenie.
   ▪ HTTPS z użyciem darmowego certyfikatu SSL (np. Certbot).

3. Mechanizm cache'owania (implementacja z użyciem Docker)
   • Zrealizować cache'owanie w ramach infrastruktury Docker w celu zwiększenia wydajności API.
   • Użyć Redis jako warstwy cache'owania (lub zaproponować lepszą opcję, w zależności od konkretnego przypadku użycia).

4. Autoryzacja i testowanie
   • Autoryzacja:
   o Zrealizować OAuth 2.0 z użyciem Client Credentials Flow zamiast tradycyjnej autoryzacji JWT.

   • Testowanie:
   o Skonfigurować zestaw testów jednostkowych, które będą uruchamiane w ramach pipeline CI/CD, aby zapewnić jakość i niezawodność kodu.

5. Implementacja API
   • Zgodność z przewodnikiem API:
   o Postępować zgodnie z dostarczonym przewodnikiem API w celu poprawnej implementacji wymaganych punktów końcowych.

   • Weryfikacja Swagger UI:
   o Dokumentacja Swagger UI powinna dokładnie odpowiadać oczekiwanej dokumentacji API.

Weryfikacja wykonania zadania i ocena pracy

Aby zweryfikować pomyślne wykonanie tego zadania, przeprowadzimy następujące testy:

1. Wdrożenie i infrastruktura:
   o Sprawdzić, czy aplikacja została poprawnie wdrożona na maszynie wirtualnej (VM).
   o Upewnić się, że środowiska Docker są poprawnie skonfigurowane dla Development/Staging i Production.
   o Sprawdzić, czy pipeline CI/CD poprawnie automatyzuje testowanie i wdrożenie.

2. Bezpieczeństwo i wydajność:
   o Potwierdzić, że baza danych PostgreSQL jest poprawnie zintegrowana i działa jako usługa Docker.
   o Sprawdzić, czy odwrotny proxy/balansujący obciążenie NGINX jest poprawnie skonfigurowany.
   o Upewnić się, że HTTPS jest aktywowany i zabezpieczony za pomocą certyfikatu SSL od Certbot.
   o Przetestować funkcjonalność cache'owania z użyciem Redis (lub zaproponowanej lepszej alternatywy).

3. Funkcjonalność API i dokumentacja:
   o Porównać dokumentację Swagger UI z oczekiwaną dokumentacją API.
   o Sprawdzić, czy wszystkie punkty końcowe działają zgodnie z opisem w przewodniku API.
   o Przeprowadzić testy integracyjne w celu potwierdzenia poprawnej implementacji autoryzacji OAuth 2.0.

4. Testowanie i jakość kodu:
   o Uruchomić zestaw testów jednostkowych, aby upewnić się, że są one pomyślnie wykonywane w ramach pipeline CI/CD.
   o Przeprowadzić przegląd jakości i struktury kodu w celu zapewnienia przestrzegania najlepszych praktyk.
   
   

Dziękuję!