Ana içeriğe geç

API Deployment Contract

Bu sayfa, Qapu'nun tek backend girisi olan API servisinin Docker Swarm uzerindeki deployment contract'ini tanimlar.

Rol​

API servisi:

  • dis istemciler icin ana giris kapisidir
  • auth, admin, app ve domain facade davranislarini tasir
  • internal servislerle kontrollu sekilde konusur

Benimsenen Model​

  • stateless deployment
  • replica tabanli olceklenme
  • reverse proxy veya edge ingress arkasinda calisma
  • qapu-public, qapu-app ve gerektiginde qapu-data network uyeligi

Placement​

API servisi worker node'larda replica olarak kosar.

Onerilen davranis:

  • replicas >= 2
  • manager yerine worker agirlikli placement
  • healthcheck gate ile rollout

Network​

Tipik network uyeligi:

  • qapu-public
  • qapu-app
  • gerekiyorsa qapu-data

Kural:

  • API, data plane'e yalniz ihtiyac duydugu kadar baglanir
  • stateful servisler edge network'e acilmaz

Secrets ve Configs​

Secrets​

  • JWT signing secret
  • db credential'lari
  • redis credential'lari
  • kafka credential'lari varsa ilgili bilgiler
  • dis provider secret'lari

Configs​

  • environment bilgisi
  • CORS / origin allowlist
  • rate-limit ayarlari
  • timeout ve facade davranis ayarlari

Health ve Readiness​

API icin process ayakta olmasi yeterli degildir.

Minimum readiness beklentisi:

  • HTTP readiness endpoint cevap verebilmeli
  • zorunlu dependency'ler icin kritik baglanti kurulabilmeli
  • config ve secret yukleme tamamlanmis olmali

Update Stratejisi​

Onerilen davranis:

  • rolling update
  • start-first
  • healthcheck gate
  • on-failure restart policy

Operasyonel Not​

API deployment contract'indaki temel basari olcutu yalniz response donmesi degildir.

Asil olcutler:

  • edge traffic'i guvenli sekilde almak
  • auth ve facade davranisini kararlı tutmak
  • internal servislerle kontrollu baglanti kurmak