README.md

Dockerfiles de Picasoft

Lisez cette documentation avant toute chose : elle fait office de référence générale et contient des informations supplémentaires par rapport aux README des dossiers :D

Ce dépôt centralise les Dockerfiles et autre ressources utilisées pour construire et déployer les images Docker tournant en production sur l'infrastructure de Picasoft.

Philosophie

Historiquement, Picasoft procède de la manière suivante :

• Construire les images Docker à partir de Dockerfiles sur une machine quelconque, puis les pousser manuellement sur un registre privé.
• Gérer un fichier Compose global par machine, qui contient la configuration et les secrets.

Cette approche pose plusieurs problèmes. Comment savoir ce qu'il y a dans une image, si on perd le Dockerfile ? Quel Dockerfile correspond à quelle version de l'image ? Si on perd l'accès à la machine, comment récupérer la configuration, remonter rapidement le service ? Comment versionner les changements de configuration ? Revenir à la version d'il y a deux semaines ?

L'objectif de ce dépôt est de rendre possible le déploiement de n'importe quel service Picasoft avec la procédure suivante :

• Cloner le dépôt
• Se rendre dans le répertoire du service
• Lancer un docker-compose up -d pour démarrer le service

Son objectif secondaire est de pouvoir revenir à l'état antérieur d'un service. En versionnant toute la configuration nécessaire, revenir à une ancienne version du service revient à :

• Cloner le dépôt
• Checkout un commit quelconque
• Lancer le service normalement

Son dernier objectif est de permettre de rendre publics nos fichiers Compose et la configuration, sans exposer les secrets (mots de passe, etc).

Mises à part les données à proprement parler du service, il n'y a donc aucune différence entre un service lancé sur une de nos machines et un service lancé à partir de ce dépôt sur une machine quelconque, ce qui s'inscrit dans la philosophie Docker.

Contenu du dépôt

Le dépôt est organisé en dossiers. Chaque dossier correspond à un service Picasoft au sens large, c'est-à-dire à un ensemble de conteneurs liés entre eux techniquement (e.g. Mattermost et sa base de données) et/ou sémantiquement (e.g. sites web statiques, relai et boîte à mail).

Ainsi, chaque dossier de ce dépôt contiendra, selon les situations :

• Zéro, un ou plusieurs Dockerfile permettant de construire des images personnalisées pour Picasoft,
• Un fichier docker-compose.yml permettant de lancer le service,
• Si possible, un ou des fichiers de configuration permettant de personnaliser le service selon nos besoins,
• Un fichier d'exemple de secrets (mots de passe...) nécessaires au lancement du service,
• Un README.md résumant les paramètres modifiables sur le dépôt, les mécanismes pour en rajouter, etc,
• Pour les images maison, un CHANGELOG.md résumant les modifications faites au fil des version.

Chaque service a son propre fichier Compose, lui permettant d'être déployé indépendamment des autres.

Des exemples concrets peuvent être trouvés au niveau de pica-mattermost ou pica-etherpad.

Guides