Aller au contenu principal

Déploiement de l'API

Les APIs ChurchApps sont déployées en tant que fonctions AWS Lambda en utilisant le Serverless Framework. Cette page couvre le workflow de construction, déploiement et configuration pour les environnements de staging et de production.

Avant de commencer

  • Configurer l'API localement -- voir Configuration locale de l'API
  • Configurer les credentials AWS sur votre machine
  • Assurez-vous d'avoir accès au compte AWS cible

Construction​

Les APIs sont construites pour la production en utilisant une configuration TypeScript dédiée :

npm run build:prod

Cela utilise tsconfig.prod.json pour compiler le projet pour le runtime Lambda.

Déploiement​

Déployer en staging :

npm run deploy-staging

Déployer en production :

npm run deploy-prod

Ce qui est créé​

Chaque déploiement API crée ou met à jour les fonctions AWS Lambda suivantes :

FonctionObjectif
webGestionnaire de requête HTTP via API Gateway
socketGestionnaire de connexion WebSocket
timer15MinTâche programmée qui s'exécute toutes les 15 minutes
timerMidnightTâche programmée qui s'exécute quotidiennement à minuit

Configuration de l'environnement​

Dans les environnements déployés, la configuration est lue à partir d'AWS SSM Parameter Store plutôt que des fichiers .env. Cela garde les secrets hors du package de déploiement et permet les changements de configuration sans redéploiement.

attention

Ne jamais committer les credentials de production dans le référentiel. Toute la configuration sensible doit être stockée dans AWS SSM Parameter Store et accessible au runtime.

astuce

Pour tester un déploiement sans affecter la production, déployez toujours en staging d'abord en utilisant npm run deploy-staging et vérifiez les changements avant de promouvoir en prod.

Articles connexes​