Documenter déclencheurs, prérequis, contrôles, actions et retour arrière pour guider efficacement les opérations.
À qui cela s’adresse-t-il ? Des équipes qui souhaitent documenter les tâches opérationnelles récurrentes et les perturbations de manière compréhensible.
Cas d’usage et contexte
Un runbook décrit une tâche spécifique pour un point de départ précis. Ce n’est ni une documentation générale du produit ni une collection de commandes non commentées. Une personne disposant des connaissances de base convenues devrait être capable de reconnaître quand le runbook s’adapte et quand elle a besoin d’aide.
Les limites reconnaissables sont particulièrement importantes : autorisations requises, effets sur les utilisateurs et conditions de terminaison. Les commandes avec un effet d’écriture sont séparées des vérifications pures. Les secrets appartiennent à un stockage sécurisé désigné, et non dans les instructions.
La démarche en détail
- Décrivez l’objectif et le déclencheur. Précisez l’application concernée, l’environnement, la responsabilité et les prérequis.
- Formulez des étapes avec les résultats attendus. Fixez un prochain point de contrôle ou une escalade pour les écarts au lieu de supposer tacitement un succès.
- Complétez la vérification des résultats et le chemin de retour. Testez le runbook par une seconde personne dans un environnement approprié et effectuez les corrections nécessaires.
Les résultats attendus
- Portée claire et prérequis reconnaissables
- Étapes avec des résultats intermédiaires vérifiables
- Conditions de terminaison nommées et d’escalade
- Responsabilité de la maintenance et du réexamen
Préparer une décision éclairée
Un plan sensé est : but, déclencheur, prérequis, tests, implémentation, contrôle du succès, retour et escalade. Ajoutez des liens vers l’architecture et d’autres instructions.
Notez le statut de la procédure. Si les applications ou autorisations changent, il est logique de vérifier à nouveau. Une date seule ne prouve pas que les instructions fonctionnent encore.
Questions et réponses
Un runbook devrait-il couvrir toutes les erreurs possibles ?
Elle doit couvrir les cas courants et pertinents. Pour des conditions inconnues, des itinéraires de terminaison et d’escalade sécurisés sont plus importants que les séquences spéculatives de commandes.
Quelle est la précision des ordres ?
De manière à ce que l’environnement cible, les paramètres, l’effet attendu et les risques soient compréhensibles. Les substituts réutilisables ne doivent pas être confondus avec de vrais secrets.