Ajoutez des extraits de bash_history dans vos wikis

Dans le présent billet je voudrais mettre le focus sur une bonne pratique de documentation que nous avons au sein de mon équipe d'administrateur système, à savoir celle d'ajouter des extraits de bash_history dans le suivi des tickets dans le Kanban.

Je pars du principe que vous utilisez un shell bash par défaut, que ce soit sur votre machine en local ou sur les machines serveurs accédées à distance. Le principe reste le même avec les autres shells.

Le *bash_history* est le fichier caché qui contient l'historique des commandes shell (bash) saisies dans un terminal et qui est conservé dans le dossier de chaque utilisateur. Ces commandes correspondent donc aux commandes saisies au cours des différentes sessions. Le bash_history est donc une forme de traçabilité des actions.

Dans le présent billet ce sera un abus de langage pour désigner les dernières commandes tapées en tant qu'administrateur système.

Quand on fait de l'administration système, il est pratique de retrouver des commandes ou séquences de commandes déjà tapées et de les rappeler pour les ré-exécuter, dans son terminal.

Dans le cadre d'une documentation wiki, un exemple valant mieux qu'un long discours, nous avons comme bonne pratique d'ajouter dans le suivi du ticket (dans le Kanban, je ferai un billet dédié nos processus d'usage du Kanban) les commandes issues d'un copier coller du bash_history.

Le bash history est bien évidemment à nettoyer un peu (surtout si on a tâtonné). Il faut idéalement rajouter des commentaires pour les commandes qui ne sont pas évidentes. Cela permet d'avoir rapidement la structure pour l'ébauche de la documentation où l'on généralisera si besoin les commandes pour que ce ne soit plus spécifique aux actions menées dans le cadre du ticket mais utilisable dans un cadre plus général.

Dans le cas d'un post-mortem, le bash_history permettra d'analyser la démarche et les actions qui ont été réalisées pour résoudre un problème, de retrouver les pistes qui ont été explorées et celles qui n'ont pas abouties.