Documentation et déploiement
Documentation et déploiement
Se connecter pour s'inscrireVotre progression
0 / 0 étapes complétées
0
Syllabus
-
-
Objectifs
-
Validations de compétences
-
Public cible
Aucun public cible spécifié pour ce module.
-
Besoins techniques
-
Prérequis
- Aucun prérequis
-
Niveau
-
Historique du module
Aucune action enregistrée
Préparation de la documentation et du déploiement
Rendre une application compréhensible et déployable par une équipe qui ne l’a pas développée, grâce à une documentation utile et vérifiable.
À la fin du cours
- Documenter architecture, installation, configuration et exploitation.
- Écrire des runbooks actionnables pour le support et les incidents.
- Gérer versions, migrations, compatibilités et informations de sécurité.
- Adapter la documentation aux utilisateurs et aux équipes techniques.
Organisation
Le cours suit l’architecture, l’installation, l’exploitation et le cycle de versions.
Prérequis : Notions de lecture de configuration et de déploiement.
Documenter l’architecture
Décrire le rôle de chaque composant, ses dépendances, les flux principaux et les frontières de sécurité. Ajouter un schéma de déploiement et une table des versions supportées.
Documenter les décisions et leurs alternatives afin qu’un changement puisse être compris sans retrouver l’histoire de l’équipe.
Client → reverse proxy → application → base ; bus → consommateurs asynchrones
Point de contrôle : Un nouveau développeur peut identifier les composants critiques sans explorer tout le code.
Installation et configuration
Écrire une procédure qui part d’un environnement connu et indique les prérequis, les commandes, les variables attendues et les vérifications. Distinguer les étapes obligatoires des options.
Ne jamais placer un secret dans la documentation. Fournir un fichier d’exemple et indiquer où obtenir chaque valeur.
1. Installer les prérequis; 2. copier .env.example; 3. installer; 4. lancer le smoke test.
Point de contrôle : La procédure peut être exécutée par une personne extérieure avec un README vierge.
Exploitation et runbooks
Un runbook part du symptôme, donne les commandes de diagnostic, explique les risques et décrit la Escalade. Éviter les étapes dépendant d’un nom de machine ou d’un secret non documenté.
Prévoir les sauvegardes, la rotation des certificats, la gestion des logs et la procédure de retour arrière. Tester les procédures avec un exercice régulier.
Méthode
- Décrire le symptôme observable.
- Collecter les preuves.
- Appliquer la correction validée.
- Vérifier et escalader.
Point de contrôle : Une personne non spécialiste peut suivre le runbook sans improviser une commande destructive.
Versions et communication
Associer la documentation à une version de l’application. Les changements incompatibles, migrations, nouvelles variables et dates de support doivent être visibles dans un journal de versions.
Adapter le niveau de détail : une guide utilisateur décrit les tâches, un guide technique décrit les opérations et un runbook décrit l’urgence.
Version 2.1 : migration 0007 obligatoire avant activation du worker 2
Point de contrôle : Une version peut être installée et comprise à partir des documents publiés.
Livrables et validation
Le livrable doit montrer une compréhension personnelle, des choix explicités et une vérification par un cas de test ou une procédure reproductible.
- Une architecture à jour et un glossaire métier.
- Un guide d’installation et de configuration.
- Des runbooks d’exploitation, sauvegarde et incident.
- Un journal de versions avec procédure de retour.
Critère de réussite : La documentation est validée lorsqu’une personne extérieure installe, configure et exécute un runbook sans information cachée.