From 8f6e41bb19348ab38dc796843e242386393df7aa Mon Sep 17 00:00:00 2001 From: Xx_DrkLeo_xX Date: Wed, 27 Mar 2024 17:39:13 +0100 Subject: [PATCH] add a README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c542b5d --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# TP R410 + +## Lancer Un conteneur + +Pour lancer Chacune des APIs, il s'uffit de lancer dans le dossier de chaque API le script `start_debug.sh`. + +Ce script créer un environnement virtuel python et installe les dépendances nécessaires puis lance le serveur Flask sur le port 5000 + +## Tester les conteneurs + +Pour tester les conteneurs, il faut lancer le script `test.py` contenu dans chaque dossier lorsque le serveur de test est en route. + +Si tous les tests passent, le script ne devrait rien mettre sur la sortie standart, par contre si il y a une erreur, une assertion se déclenche et le script arretera son éxecution + +*PS: il faut utiliser version de debug et non pas la version conteneurisé de chaque service car le serveur WSGI utiliser n'est pas le même, ce qui change le formatage de certaines requêtes, empêchant la série de test de s'exécuter proprement* + +## Déployer les conteneurs + +Pour déployer tous les conteneurs ensemble derrière un reverse proxy, il y a un Docker compose. + +Pour lancer le Docker compose, il faut lancer la commande `docker compose up -d` depuis la racine du projet. + +Cela redirigera le préfixe du chemin `/athlete` vers le conteneurs athlete, le préfixe du chemin `/sport` vers le conteneurs sport et le préfixe du chemin `/medal` vers le conteneurs medal. + +Le docker compose met aussi en place un swagger avec le contrat d'interface disponible en `/ui`.