Hopp til hovedinnhold

Distribusjon av API

ChurchApps-API-ene distribueres som AWS Lambda-funksjoner ved hjelp av Serverless Framework. Denne siden dekker arbeidsflyten for bygging, distribusjon og konfigurasjon for demo- og produksjonsmiljøene.

Før du begynner

  • Sett opp API-et lokalt. Se Lokalt oppsett av API
  • Konfigurer AWS-legitimasjon på maskinen din
  • Sørg for at du har tilgang til målet AWS-kontoen

Bygg​

API-ene bygges for produksjon med en egen TypeScript-konfigurasjon:

npm run build:prod

Dette bruker tsconfig.prod.json til å kompilere prosjektet for Lambda-kjøretidsmiljøet.

Distribuer​

Distribuer til demomiljøet:

npm run deploy-demo

Distribuer til produksjon:

npm run deploy-prod

I praksis distribueres API-et av GitHub Actions: Deploy Demo kjøres ved hver push til main, og Deploy Prod startes manuelt (workflow dispatch). Det finnes ikke lenger et staging-miljø.

Databasemigreringer​

Deploy Prod kjører ventende databasemigreringer som en del av distribusjonen. Produksjonsdatabasene aksepterer bare tilkoblinger fra innsiden av VPC-et. Rett etter serverless deploy kaller arbeidsflyten derfor migrate-Lambda-funksjonen (api-Prod-migrate), som kjører alle modulenes ventende migreringer og returnerer { ok, environment, modules }. Hvis en modul feiler eller blir avvist (for eksempel en database uten migreringshistorikk), mislykkes jobben, slik at skjemaet aldri ligger etter koden. Rollback Prod tilbakefører bare Lambda-koden. Migreringene forblir kjørt, så hold dem additive. Se Serveradministrasjon: databasemigreringer for å sjekke status eller kjøre migreringer manuelt.

Hva som opprettes​

Hver API-distribusjon oppretter eller oppdaterer følgende AWS Lambda-funksjoner:

FunksjonFormål
webHTTP-forespørselsbehandler via API Gateway
socketBehandler for WebSocket-tilkoblinger
timer15MinPlanlagt oppgave som kjører hvert 30. minutt (navnet er historisk)
timerMidnightPlanlagt oppgave som kjører daglig ved midnatt
migrateKjører ventende databasemigreringer. Kalles av arbeidsflyten Deploy Prod

Miljøkonfigurasjon​

I distribuerte miljøer leses konfigurasjonen fra AWS SSM Parameter Store i stedet for .env-filer. Dette holder hemmeligheter ute av distribusjonspakken og gjør det mulig å endre konfigurasjon uten å distribuere på nytt.

Advarsel

Commit aldri produksjonslegitimasjon til repositoryet. All sensitiv konfigurasjon skal lagres i AWS SSM Parameter Store og hentes ved kjøring.

Tips

Hver sammenslåing til main distribueres først til demomiljøet. Kontroller endringen der (for eksempel på demo.b1.church) før du kjører Deploy Prod.

Relaterte artikler​