Aller au contenu principal

Déploiement de l'API

Les API ChurchApps sont déployées sous forme de fonctions AWS Lambda à l'aide de Serverless Framework. Cette page décrit le flux de compilation, de déploiement et de configuration pour les environnements de démonstration et de production.

Avant de commencer

  • Configurez l'API en local -- voir Configuration locale de l'API
  • Configurez vos identifiants AWS sur votre machine
  • Assurez-vous d'avoir accès au compte AWS cible

Compilation​

Les API sont compilées pour la production à l'aide d'une configuration TypeScript dédiée :

npm run build:prod

Cette commande utilise tsconfig.prod.json pour compiler le projet pour l'environnement d'exécution Lambda.

Déploiement​

Déployer dans l'environnement de démonstration :

npm run deploy-demo

Déployer en production :

npm run deploy-prod

En pratique, l'API est déployée par GitHub Actions : Deploy Demo s'exécute à chaque push sur main, et Deploy Prod est lancé manuellement (déclenchement du workflow). Il n'existe plus d'environnement de préproduction.

Migrations de base de données​

Deploy Prod applique les migrations de base de données en attente dans le cadre du déploiement. Les bases de données de production n'acceptent les connexions que depuis l'intérieur du VPC ; juste après serverless deploy, le workflow invoque la fonction Lambda migrate (api-Prod-migrate), qui exécute les migrations en attente de chaque module et renvoie { ok, environment, modules }. Si un module échoue ou est refusé (par exemple une base de données sans historique de migrations), le job échoue afin que le schéma ne soit jamais en retard par rapport au code. Rollback Prod ne rétablit que le code de la fonction Lambda ; les migrations restent appliquées. Gardez donc les migrations additives. Voir Administration serveur -- Migrations de base de données pour vérifier leur état ou les exécuter manuellement.

Ce qui est créé​

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

FonctionRôle
webGestionnaire des requêtes HTTP via API Gateway
socketGestionnaire des connexions WebSocket
timer15MinTâche planifiée exécutée toutes les 30 minutes (le nom est historique)
timerMidnightTâche planifiée exécutée chaque jour à minuit
migrateApplique les migrations de base de données en attente ; invoquée par le workflow Deploy Prod

Configuration de l'environnement​

Dans les environnements déployés, la configuration est lue depuis AWS SSM Parameter Store plutôt que depuis les fichiers .env. Cela garde les secrets hors du paquet de déploiement et permet de modifier la configuration sans redéployer.

attention

Ne committez jamais d'identifiants de production dans le dépôt. Toute la configuration sensible doit être stockée dans AWS SSM Parameter Store et lue à l'exécution.

astuce

Chaque fusion dans main déploie d'abord dans l'environnement de démonstration. Vérifiez votre modification là-bas (par exemple sur demo.b1.church) avant de lancer Deploy Prod.

Articles connexes​