Lewati ke konten utama

Deployment API

API ChurchApps di-deploy sebagai fungsi AWS Lambda menggunakan Serverless Framework. Halaman ini membahas alur kerja build, deploy, dan konfigurasi untuk lingkungan demo dan produksi.

Sebelum Anda Mulai

  • Siapkan API secara lokal -- lihat Penyiapan API Lokal
  • Konfigurasikan kredensial AWS di mesin Anda
  • Pastikan Anda memiliki akses ke akun AWS tujuan

Build​

API dibangun untuk produksi menggunakan konfigurasi TypeScript khusus:

npm run build:prod

Perintah ini menggunakan tsconfig.prod.json untuk mengompilasi proyek untuk runtime Lambda.

Deploy​

Deploy ke lingkungan demo:

npm run deploy-demo

Deploy ke produksi:

npm run deploy-prod

Dalam praktiknya, API di-deploy oleh GitHub Actions: Deploy Demo berjalan setiap kali ada push ke main, dan Deploy Prod dijalankan secara manual (workflow dispatch). Saat ini tidak ada lagi lingkungan staging.

Migrasi Database​

Deploy Prod menerapkan migrasi database yang tertunda sebagai bagian dari proses deploy. Database produksi hanya menerima koneksi dari dalam VPC, sehingga segera setelah serverless deploy, workflow memanggil Lambda migrate (api-Prod-migrate), yang menjalankan semua migrasi tertunda dari setiap modul dan mengembalikan { ok, environment, modules }. Jika ada modul yang gagal atau ditolak (misalnya database tanpa riwayat migrasi), job akan gagal sehingga skema tidak pernah tertinggal di belakang kode. Rollback Prod hanya mengembalikan kode Lambda; migrasi tetap diterapkan, jadi pastikan migrasi bersifat aditif. Lihat Server Admin -- Migrasi Database untuk memeriksa status atau menjalankan migrasi secara manual.

Apa yang Dibuat​

Setiap deployment API membuat atau memperbarui fungsi AWS Lambda berikut:

FungsiTujuan
webPenangan permintaan HTTP melalui API Gateway
socketPenangan koneksi WebSocket
timer15MinTugas terjadwal yang berjalan setiap 30 menit (nama ini bersifat historis)
timerMidnightTugas terjadwal yang berjalan setiap hari pada tengah malam
migrateMenerapkan migrasi database yang tertunda; dipanggil oleh workflow Deploy Prod

Konfigurasi Lingkungan​

Di lingkungan yang sudah di-deploy, konfigurasi dibaca dari AWS SSM Parameter Store, bukan dari file .env. Cara ini menjaga rahasia tetap berada di luar paket deployment dan memungkinkan perubahan konfigurasi tanpa deploy ulang.

peringatan

Jangan pernah melakukan commit kredensial produksi ke repositori. Semua konfigurasi sensitif harus disimpan di AWS SSM Parameter Store dan diakses saat runtime.

tip

Setiap merge ke main akan di-deploy ke lingkungan demo terlebih dahulu. Periksa perubahan Anda di sana (misalnya di demo.b1.church) sebelum menjalankan Deploy Prod.

Artikel Terkait​