| Date de lancement | septembre 2016 | |
|---|---|---|
| État du Service | ||
| Concepteurs | Dorian Becker, Alexandre Narbonne | |
| Sources | https://github.com/gadzorg/gorg_mail | |
| Clés de routage écoutées |
| |
| Clés de routage émises |
|
|
Présentation du service
Le role du service, quoi il sert, quel problme il regle
L'historique de la fonctionnalite, ca permettra au nouveau de comprendre l'evolution, surtout si ils trouvent des reliquats de l'ancienne fonction
Les raisons du choix de passer par un service (a aide les suivant comprendre le contexte)
Ce service est-il standalone ou intgr dans une application ? Emetteuret recepteur ?
Lister ici les ressources misent disposition des developpeurs pour ce service (ca vitera qu'on coupe ces ressources accidentellement alors que c'est encore utilises et aux future gars de savoir d'ou sort cet utilisateur avec tout les droits en ecriture sur le LDAP ): les environnement de dev RabbitMQ, le LDAP de dev (Un user particulier ?) , une base de donnee
| Hébergement | Gadz.org AFP / Gadz.org Docker / Gadz.org VM / Heroku / AWS |
|---|---|
| Caractéristiques | Infos sur l'environnement : - Pour un docker, le nom de l'image, o la trouver .. - Pour AFP le nom de l'utilsateur applicatif - Heroku : Le nom du container et l'utilisateur proprietaire, le type de dynos |
| Resources | Les bases de donnes utilises, ventuellement le nom de l'utilisateur utiliss et les droits ncessaires Les API utilises, ventuellement le nom de l'utilisateur utiliss et les droits ncessaires |
| Hébergement | Gadz.org AFP / Gadz.org Docker / Gadz.org VM / Heroku / AWS |
|---|---|
| Caractéristiques | Infos sur l'environnement : - Pour un docker, le nom de l'image, o la trouver .. - Pour AFP le nom de l'utilsateur applicatif - Heroku : Le nom du container et l'utilisateur proprietaire, le type de dynos |
| Resources | Les bases de donnes utilises, ventuellement le nom de l'utilisateur utiliss et les droits ncessaires Les API utilises, ventuellement le nom de l'utilisateur utiliss et les droits ncessaires |
La liste des autres systemes dont le service besoin pour fonctionner. ceux-ci peuvent etre obligatoires ou facultatifs :Bases de donnes,APIs,Redis,Serveur Mail
La liste des fichiers de configs et variables d'environnement
Listes des actions pour arreter / demarrer le service
Guide d'installation du service
| Clé de routage | Quand ? | Contenu du message | Exemple de contenu | |
|---|---|---|---|---|
| notify.monservice.ressource.status | Qu'est ce que cette notification signifie ? Quel est le nouvel tat ? | Quels sont les informations contenues dans ce message ? |
|
N'oubliez pas de mettre à jour la propriétés "Clés de routage émises" de la page avec les nouvelles routing keys |
Si vous modifiez le format d'une notification existante, essayez au maximum de conserver les données précédentes et pensez à reporter les changements sur les services clients de cette notification |
| Clé de routage | Commentaires |
|---|---|
| request.unautreservice.ressource.action | un commentaire qui pourrait aider les autres dev a comprendre pourquoi cet appel a un autre service est fait |
N'oubliez pas de mettre à jour la propriétés "Clés de routage émise" de la page avec les nouvelles routing keys |
| Clé de routage | Actions effectuées | Contenu du message | Exemple de contenu | |
|---|---|---|---|---|
| request.monservice.ressource.action | Expliquez ce que le service va faire quand on appel cette action | Quels sont les informations que le message doit contenir ? Lesquels sont obligatoire / facultatives ? Vous pouvez mettre un SCHEMA-JSON |
|
N'oubliez pas de mettre à jour la propriétés "Clés de routage écoutées" de la page avec les nouvelles routing keys |
Si vous modifiez le format d'une requete existante, pensez à reporter les changements sur les services clients de cette requete |
| Clé de routage | Actions effectuées |
|---|---|
| notify.unautreservice.ressource.status | Expliquez ce que le service va faire quand on appel cette action |
N'oubliez pas de mettre à jour la propriétés "Clés de routage écoutées" de la page avec les nouvelles routing keys |