Zum Hauptinhalt springen

API-Deployment

ChurchApps APIs werden als AWS Lambda-Funktionen über das Serverless Framework deployed. Diese Seite behandelt den Build-, Deploy- und Konfigurationsverlauf für Staging- und Produktionsumgebungen.

Vor dem Start

  • Richten Sie die API lokal ein — siehe Lokales API-Setup
  • Konfigurieren Sie AWS-Anmeldedaten auf Ihrer Maschine
  • Stellen Sie sicher, dass Sie Zugriff auf das Ziel-AWS-Konto haben

Build​

APIs werden für Production mit einer dedizierten TypeScript-Konfiguration gebaut:

npm run build:prod

Dies nutzt tsconfig.prod.json, um das Projekt für die Lambda-Runtime zu kompilieren.

Deploy​

Deploy zu Staging:

npm run deploy-staging

Deploy zu Production:

npm run deploy-prod

Was wird erstellt​

Jedes API-Deployment erstellt oder aktualisiert die folgenden AWS Lambda-Funktionen:

FunktionZweck
webHTTP-Request-Handler via API Gateway
socketWebSocket-Connection-Handler
timer15MinGeplante Aufgabe, die alle 15 Minuten läuft
timerMidnightGeplante Aufgabe, die täglich um Mitternacht läuft

Umgebungskonfiguration​

In bereitgestellten Umgebungen wird die Konfiguration aus AWS SSM Parameter Store gelesen, nicht aus .env-Dateien. Dies hält Geheimnisse aus dem Deployment-Paket heraus und ermöglicht Konfigurationsänderungen ohne neu zu deployen.

Warnung

Speichern Sie niemals Production-Anmeldedaten im Repository. Alle sensiblen Konfigurationen sollten in AWS SSM Parameter Store gespeichert und zur Laufzeit zugegriffen werden.

Tipp

Um ein Deployment zu testen, ohne Production zu beeinflussen, deployen Sie immer zuerst zu Staging mit npm run deploy-staging und verifizieren Sie die Änderungen, bevor Sie zu Prod promoten.

Verwandte Artikel​