Workflow¶
Avant toute modification¶
- Lire la documentation officielle du service.
- Vérifier les volumes, les ports et les variables d'environnement.
- Vérifier l'impact sur les sauvegardes.
Ajouter un service¶
- Créer le service avec
./scripts/create-service.sh. - Compléter
compose.yaml. - Compléter
env/<service>/.env.example. - Créer et compléter
env/<service>/.env. - Ajouter les secrets dans
secrets/<service>/si nécessaire. - Déployer.
- Tester le fonctionnement.
- Documenter le service.
- Mettre à jour
inventory.md. - Commit Git.
Modifier un service¶
- Sauvegarder si nécessaire.
- Modifier la configuration.
- Redéployer.
- Vérifier le fonctionnement.
- Mettre à jour la documentation si besoin.
- Commit Git.
Mettre à jour un service¶
- Lire les notes de version.
- Sauvegarder si nécessaire.
- Mettre à jour l'image Docker.
- Déployer.
- Vérifier les logs et les fonctionnalités.
- Mettre à jour la version dans
inventory.md. - Commit Git.
Supprimer un service¶
- Sauvegarder les données si besoin.
- Arrêter le service.
- Supprimer le compose, les données et la documentation.
- Mettre à jour
inventory.md. - Commit Git.
Sauvegarde¶
Avant toute modification importante :
- Vérifier que le dernier backup est valide.
- Lancer un backup si nécessaire.
Règles¶
- Utiliser les scripts du framework.
- Respecter les conventions.
- Une documentation par service.
- Toute amélioration réutilisable doit être intégrée au framework.
- Ne pas modifier une architecture validée sans raison technique.