Documenter son réseau

Bonjour tout le monde,

Comment procéderiez-vous (ou comment procédez-vous si vous le faites) pour documenter votre installation de réseau domestique. Je veux parler de ce genre de choses :

  • le serveur, son installation, le paramétrage…
  • les machines clientes (deux postes), les paquets qu’on y installe
  • les services qui tournent indépendamment ou entre les machines comme :
    ---- Apache sur le serveur
    ---- Les sauvegardes rsync automatisées entre le serveur et les clients
  • un milliard d’autres choses :slightly_smiling:

Au début je faisais une doc latex. très joli mais de toute façon je ne la compilais pas, le but n’était pas d’imprimer… J’ai vite changé d’avis.

J’ai tout recommencé pour faire des scripts d’installation que j’ai vesionnés. Par exemple, rsync.sh va installer rsync et les profils de sauvegarde sur le serveur mais s’il est exécuté sur mon laptop, il va installer rsync et faire une entrée dans le cron…

Bref j’essaie de faire des trucs de déploiement “intelligents” à ce jour sauf que ça me paraît de moins en moins intelligent parce que je trouve que c’est beaucoup d’efforts pour pas grand chose et en plus de ça, il sera difficile d’avoir des scripts qui gèrent tout : la plupart du temps, ils se comportent comme s’il devaient tourner sur une installation à blanc… Mais je me tape pas une installation dès qu’un truc bat de l’aile. Bref ça me paraît maintenant une mauvaise solution également. C’était séduisant au début puisque c’est un bon moyen d’y décrire la technique, les commandes… Du simple wget au chmod d’un répertoire à la construction d’un fichier /etc à coup d’echo. Ça rajoute qui plus est un niveau de complexité non négligeable par moment…

En fait… Versionner sous SVN ma doc me plaît énormément pour plusieurs raisons :

  • J’échange de temps en temps des idées avec un copain
  • Je m’embarque dans de grands travaux en parallèle qu’il faut documenter et merger proprement ensuite)
  • Il m’arrive de faire des bons en arrière (zut ça me plaisait plus avant finalement mais je me rappelle plus du détail)

Je voudrais donc une solution SVN (pas une simple doc versionnée sur un Wiki, pas fan !) à première vue mais les scripts ne sont pas mieux que la doc LaTeX. En vérité je commence à me dire que le mieux serait un mix des deux : une documentation bêtement faire dans des fichiers textes qui contiennent à la fois mes notes et les commandes qu’il faut jouer… Le tout sur SVN quand même :slightly_smiling:

Cette question est importante pour moi parce que je n’ai pas une grande expérience et que repenser toute ma doc est déjà un travail un peu lourd. C’est pour ça que j’espère profiter de vos conseils.

Merci d’avance.

Salut,
tu peux regarder du coté de zim http://zim-wiki.org/ (y’a un paquet debian). C’est un wiki certes mais par défaut la gestion de version n’est pas activée, donc soit tu gères tes fichiers zim (fichiers txt) dans ton svn à part soit tu actives l’option de zim qui te gères tout ça à ta place.

Les solutions comme Latex ça fait du beau travail mais ça ne se prête pas à la prise de notes rapides.

Je suis plutôt adepte de Vim alors m’en passer pour ma doc me semble génant… Ceci dit, je ne connaissais pas Zim, ça a l’air pas mal…

Si vous avez fait évoluer une documentation du même genre que la mienne, qu’en avez vous appris ? Comment feriez-vous si vous deviez recommencer maintenant ?

Plus le temps passe et plus je me dis que ces simples fichiers texte feraient l’affaire. Mais j’ai peur de ne pas penser à quelque chose que je ne puisse aborder via des fichiers texte…

avec zim, on peut modifier le code source des pages en direct avec l’éditeur que l’on veut.
Moi aussi j’utilise vim et au final je le délaisse quand j’utilise zim. Ce n’est pas si grave pour de l’édition basique de texte et c’est dommage de passer à coté d’un outil efficace à cause d’un autre. Dans l’idéal j’aurais aimé utiliser latex et vim tout le temps mais ce n’est pas pratique tout le temps non plus :slightly_smiling:. Ou alors il y a la solution emacs aussi qui a une extension pour wiki et prise de notes.

Mon utilisation de zim est relativement récente mais pour l’instant j’en suis très satisfait. Certaines choses que j’avais la flemme de noter avant par paresse de lancer latex sont notées maintenant de manière très rapide. Il est très efficace pour organiser son travail par exemple.
Après si on veut de la documentation rédigée vraiment proprement, peut-être est-ce possible de traiter les fichiers textes avec txt2tags par exemple pour une sortie en latex ?