gwift-book/source/part-1-workspace/12-factors.adoc

Construire des applications maintenables

Pour la méthode de travail et de développement, on va se baser sur les The Twelve-factor App - ou plus simplement les 12 facteurs.

L’idée derrière cette méthode consiste à pousser les concepts suivants (repris grossièrement de la page d’introduction :

1. Faciliter la mise en place de phases d’automatisation; plus concrètement, de faciliter les mises à jour applicatives, simplifier la gestion de l’hôte, diminuer la divergence entre les différents environnements d’exécution et offrir la possibilité d’intégrer le projet dans un processus d’intégration continue/déploiement continu

2. Faciliter la mise à pied de nouveaux développeurs ou de personnes souhaitant rejoindre le projet

3. Minimiser les divergences entre les différents environnemens composant un projet

4. Augmenter l’agilité générale du projet, en permettant une meilleure évolutivité architecturale et une meilleure mise à l’échelle - Vous avez 5000 utilisateurs en plus? Ajoutez un serveur et on n’en parle plus ;-).

En pratique, les idées qui se trouvent derrière les points ci-dessus permettront de monter facilement un nouvel environnement - qu’il soit sur la machine du petit nouveau dans l’équipe, sur un serveur Azure/Heroku/Digital Ocean ou votre nouveau Raspberry Pi Zéro caché à la cave.

Pour reprendre de manière très brute les différentes idées derrière cette méthode, on a:

1. Une base de code unique, suivie par un système de contrôle de versions. Chaque déploiement de l’application se basera sur cette source, afin de minimiser les différences que l’on pourrait trouver entre deux environnements d’un même projet. On utilisera un dépôt Git - Github, Gitlab, Gitea, …​ Au choix.

2. Déclarez explicitement les dépendances nécessaires au projet, et les isoler du reste du système lors de leur installation. L’idée est que chaque installation ou configuration se fasse toujours de la même manière, et puisse être répétée quel que soit l’environnement cible. Cela permet également d’éviter que l’application n’utilise une dépendance qui soit déjà installée sur un des sytèmes de développement, et qu’elle soit difficile à répercuter sur un autre environnement. Dans notre cas, cela pourra être fait au travers de pip - Package Installer for Python.

3. Sauver la configuration directement au niveau de l’environnement. On veut par exemple éviter d’avoir à recompiler/redéployer l’application parce que l’adresse du serveur de messagerie a été modifiée, ou parce qu’un protocole a changé en cours de route. Concrètement, toute information susceptible de modifier le comportement intrinsèque de l’application doit se trouver dans un fichier ou dans une variable d’environnement. En allant un pas plus loin, cela permettra de paramétrer facilement un container, simplement en modifiant une variable de configuration, qui spécifiera la base de données sur laquelle l’application devra se connecter.

4. Traiter les ressources externes comme des ressources attachées. On parle de bases de données, de services de mise en cache, d’API externes, …​ L’application doit également être capable d’effectuer des changements au niveau de ces ressources sans que le code intrinsèque ne soit modifié. On parle alors de ressources attachées, dont la présence est nécessaire au bon fonctionnement de l’application, mais pour lesquelles le type n’est pas obligatoirement défini. On veut par exemple "une base de données" et "une mémoire cache", et pas "une base MariaDB et une instance Memcached". De cette manière, les ressources peuvent être attachées et détachées d’un déploiement à la volée. Si une base de données ne fonctionne pas correctement (problème matériel?), l’administrateur pourrait simplement restaurer un nouveau serveur à partir d’une précédente sauvegarde, et l’attacher à l’application sans que le code source ne soit modifié.

5. Séparer proprement les phases de construction, de mise à disposition et d’exécution. La construction (build) convertit un code source en un ensemble de fichiers exécutables, associé à une version et à une transaction dans le système de gestion de sources. La mise à disposition (release) associe cet ensemble à une configuration prête à être exécutée, tandis que la phase d'exécution (run) démarre les processus nécessaires au bon fonctionnement de l’application.

Note	Voir Capistrano (mais je ne l’ai jamais essayé et je n’ai pas tout compris :-))

Note	pensez à retravailler la partie ci-dessous; la version anglophone semble plus compréhensible…​ :-/

1. Les processus d’exécution ne doivent rien connaître ou conserver de l’état de l’application. On suppose donc que toute information stockée en mémoire ou sur disque n’altérera pas le comportement futur de l’application, par exemple après un redémarrage non souhaité. Si une réinitialisation devait être nécessaire, l’application ne devra pas compter sur la présence d’une information système.

2. Exécutez l’application comme un ou plusieurs processus sans état (?)

3. Exportez les services via des associations de ports (?)

4. Grossissez à l’aide du modèle de processus (?)

5. Maximisez la robustesse avec des démarrages rapides et des arrêts gracieux (?)

6. Gardez le développement, la validation et la production aussi proches l’un de l’autre que possible

7. Traitez les logs comme des flux d’évènements (?)

8. Lancez les processus d’administration et de maintenance comme des one-off-processes (?)

Table 1. Concrètement

Concept	Concept	Outil	Description
1	Base de code suivie avec un système de contrôle de version	Git, Mercurial, SVN, …​	Chaque déploiement démarre à partir d’une base de code unique. Il n’y pas de dépôt "Prod", "Staging" ou "Dev". Il n’y en a qu’un et un seul.
2	Déclaration explicite et isolation des dépendances	Pyenv, environnements virtuels, RVM, …​	Afin de ne pas perturber les dépendances systèmes, chaque application doit disposer d’un environnement sain par défaut.
3	Configuration dans l’environnement	Fichiers .ENV	Toute clé de configuration (nom du serveur de base de données, adresse d’un service Web externe, clé d’API pour l’interrogation d’une ressource, …​) sera définie directement au niveau de l’hôte - à aucun moment, on ne doit trouver un mot de passe en clair dans le dépôt source ou une valeur susceptible d’évoluer, écrite en dur dans le code.
4	Services externes = ressources locales	Fichiers .ENV	Chaque ressource doit pouvoir être interchangeable avec une autre, sans modification du code source. La solution consiste à passer toutes ces informations (nom du serveur et type de base de données, clé d’authentification, …​) directement via des variables d’environnement.
5	Bien séparer les étapes de construction des étapes de mise à disposition	Capistrano, Gitea, un serveur d’artefacts, …​	L’idée est de pouvoir récupérer une version spécifique du code, sans que celle-ci ne puisse avoir été modifiée. Git permet bien de gérer des versions (au travers des tags), mais ces éléments peuvent sans doute être modifiés directement au travers de l’historique.