Comment documentez-vous un réseau?

66

Je ne sais pas comment poser cette question, puisque je ne suis pas sur le terrain. Dites que vous êtes un administrateur réseau et que vous quittez votre emploi. Comment le nouveau type sait-il par où commencer?

Esteban Araya
la source
6
En outre: la documentation vous permet de prendre des vacances un jour, ainsi que de protéger l'entreprise si vous êtes trop malade / blessé pour travailler.
Kara Marfia

Réponses:

55

Cela dépend entre autres de la taille du réseau, du nombre d'utilisateurs, du nombre de nœuds (ordinateurs, serveurs, imprimantes, etc.) et de la taille de votre personnel informatique.

Cela dépend aussi de votre objectif. Etes-vous en train de documenter le réseau à des fins de formation et de maintenance, d’assurance / de prévention des sinistres, etc.?

Personnellement, je documente mes réseaux de manière à ce que je puisse obtenir toute information manquante sur la base de ce qui est documenté. D'un point de vue pratique, il y a un point de rendement décroissant lorsque votre documentation devient trop granulaire.

La règle de base que j’utilise est qu’il doit exister une documentation suffisamment approfondie pour permettre à un autre administrateur de laisser fonctionner le réseau principal pendant qu’il / elle remplit les éléments manquants au cours de la nuit. prochains jours / semaines.

Voici un aperçu de ce que j'estime être le plus important pour l'un de mes réseaux. Pour mémoire, il s’agit d’un magasin sous Windows comptant environ 100 utilisateurs et 5 bureaux.

  • Informations d'identification de l'administrateur pour tous les serveurs. Évidemment, cela devrait être gardé en sécurité.
  • Adresses IP et noms NetBIOS pour tout nœud du réseau avec une adresse IP statique, y compris les serveurs, les postes de travail, les imprimantes, les pare-feu, les routeurs, les commutateurs, etc.
  • Informations de base sur le matériel du serveur, telles que les balises de service ou l'équivalent, la capacité totale du disque, la RAM totale, etc.
  • Principaux rôles de chaque serveur, tels que contrôleur de domaine, serveur de fichiers, serveur d'impression, serveur Terminal Server, etc.
  • Emplacement des bandes / lecteurs de sauvegarde.
  • Informations sur les numéros de compte et les informations d'identification pour des services tels que les fournisseurs de voix et de données des bureaux distants.
  • DNS externe pour les sites Web et le routage.

S'il y avait quelque chose d'étrange dans une configuration ou un flux de travail qui ne serait pas immédiatement évident pour un nouvel administrateur, j'écrirais également un bref "brief" à ce sujet.

Kyle Noland
la source
8
+1 pour le scénario de rencontre par un bus.
Romandas
11

Je trouve qu'il est préférable d'incorporer tout ce qui suit:

  • Prose: Un aperçu général sous forme de paragraphe, qui aide à la vision d'ensemble initiale et peut également décrire l'évolution au fil du temps
  • Tableaux: listes tabulaires, avec adresse, environnement ou ordinateur (de préférence, toutes les réponses ci-dessus)
  • Diagrammes: besoin de diagrammes avec plusieurs niveaux de détail. Sur un réseau de taille décente, il est tout simplement impossible de le capturer sur une page et de le rendre facilement digestible. Vous voulez un diagramme au niveau global, avec des périphériques d'infrastructure (routeurs, commutateurs, points de terminaison de tunnel, etc.), ainsi que plusieurs autres pour les ressources de calcul mises en face par chacun de ces routeurs ou points de terminaison.

Notes supplémentaires sur les diagrammes ... La distribution géographique est un moyen facile de segmenter, mais vous avez également besoin de vues logiques basées sur la fonction d'installation. En outre, étiqueter comme un fou, en utilisant pleinement les polices de caractères et les couleurs.

Adam D'Amico
la source
5

Le moyen le plus efficace et le plus complet de démarrer ce processus consiste à le construire à partir d'un scénario de récupération après sinistre - par exemple, le bâtiment est en flammes et tout ce dont nous disposons est constitué de sauvegardes hors site. Que devons-nous acheter en premier et comment devra-t-il être configuré?

Kyle a déjà donné beaucoup de détails, mais je trouve que l'approche DR m'aide à prendre les choses une pièce à la fois.

Kara Marfia
la source
4

La réponse de Kyle est un bon conseil. Au strict minimum, vous pourriez probablement vous en tirer:

  • Serveurs (inclure les noms d'hôte, les adresses IP et les rôles)
  • Matériel réseau (commutateurs, routeurs, pare-feu)
  • Archives de mots de passe maîtres (mots de passe de domaine, mots de passe d'administrateur)
  • Un document approximatif décrivant les stratégies réseau et toute configuration inhabituelle (incluez ici les valeurs aberrantes telles que les machines ne faisant pas partie du (des) domaine (s))
Kdmurray
la source
4

Où je travaille - nous avons rencontré le même problème quand j'ai commencé ici. Au fur et à mesure que le nombre de serveurs et de services augmente, vous trouvez de plus en plus de documentation obsolète, d'où l'attitude inévitable du personnel de ne pas faire confiance à la documentation, du moins à la documentation technique sur les noms de serveur, les groupes de serveurs, les réseaux, etc.

Nous avons commencé à développer un projet open-source appelé hotwire pour résoudre ce problème ...

  • Système d'inventaire (serveurs, réseaux, etc.)
  • Versions de serveur - RHEL Kickstart, SuSE AutoYaST, (TODO: Debian Preseed, Solaris Jumpstart)

En combinant le système d'inventaire au système de construction, nous nous assurons que le contenu de la base de données correspond à celui de nos centres de données, car nous devons maintenant entrer les données dans l'inventaire pour pouvoir créer les serveurs. .

Un programme client (funcwire) est ensuite installé sur tous les serveurs (dans le cadre du processus de construction), lequel surveille ensuite de manière dynamique le matériel du serveur, comme indiqué par python-dmidecode , et le contenu de l’inventaire. saura immédiatement.

Nous avons ensuite intégré notre système wiki afin que chaque serveur, rack, projet, modèle matériel, etc., de hotwire soit directement lié à la page wiki appropriée.

Nous avons donc "documenté" nos serveurs / réseau / etc en utilisant hotwire + un wiki (nous utilisons confluence ici, mais tout wiki décent fera l'affaire). (Notez cependant qu'une fois les serveurs construits - hotwire ne les modifie en aucune manière - la gestion continue est effectuée via cfengine).

Xerxes
la source
3
"howtire" lien ne fonctionne pas; ne le trouve pas non plus via google. Est-ce mort?
marquer
4

J'utilise MikroTik Dude pour cartographier les choses automatiquement, il s'agit d'une application impressionnante, car elle est gratuite. Il peut également surveiller l'état actuel. Page web mec

Sam Mackrill
la source
2

En règle générale, vous disposez de plusieurs niveaux de détail similaires aux abstractions dans la documentation de conception de logiciels. Vous documentez également les pratiques / procédures / configuration générales de l'appareil. Mots de passe administratifs, le cas échéant.

Dans une situation idéale, presque tout ce dont la personne suivante peut avoir besoin est facilement accessible et documenté entre votre document de référence et les documents de procédure + les schémas de réseau.

À mon avis, les documents de lignes directrices et de procédures devraient être centralisés là où se trouvent tous les documents informatiques. Les diagrammes de réseau peuvent avoir leur propre structure de dossiers pour plusieurs emplacements.

Dans le cas de nombreux sites satellites comme Walmart / Targer / Home Depot, vous auriez un document générique pour toutes les succursales, puis des documents détaillés de toute la société sur les interconnexions des bureaux principaux, puis vous pourrez plonger dans les documents LAN du bureau.

Sclarson
la source
2

Approche documenter un réseau en tant que développeur approche développer un système ...

  • Considérez les conditions requises - ceci a été bien noté ci-dessus, mais considérez que l'OMS va consulter le document et pour QUOI-OBJECTIF. Les auditeurs recherchent et lisent des artefacts différents d’un SysAdmin homologue.

  • Faire de la maintenance de la documentation - de nombreuses personnes ont mentionné la valeur des diagrammes et des cartes et, en tant que penseur visuel, je suis tout à fait d’accord avec elle. MAIS ces choses peuvent être invalidées avec un simple acte d’ajout / suppression d’un hôte. Pensez au «bon niveau» de doc-o - que votre groupe peut réellement conserver.

  • Date tout et inclure des notes sur pourquoi vous avez configuré le réseau comme vous l'avez fait. Beaucoup, beaucoup de gens oublient d'inclure une date - mais la DATE fournit un pointeur sur l'historique du réseau. Inestimable pour la résolution de problèmes et il atténue la désuétude inhérente à la plupart des diagrammes de réseau.

  • Déchargez la documentation dans des "processus" - de nombreuses fois, des procédures de construction / déploiement solides et bien conçues finissent par rationaliser la "documentation réseau", car les détails de la configuration et du nommage de la machine sont mieux décrits dans les procédures.

À retenir: approchez la documentation en tant que «système»; il doit fournir de la valeur dès le premier jour et il comporte une responsabilité inhérente de le maintenir.

Netais LLC
la source
2

Sur notre site, nous utilisons plusieurs systèmes pour documenter nos propres réseaux et ceux de nos clients. Nous avons essayé et échoué avec beaucoup de techniques / outils qui n’ont pas évolué, mais nous sommes maintenant prêts à:

  • DokuWiki pour des conseils, des descriptions détaillées des configurations et
  • Tableaux (Patchport / MAC / IP / Nom d'hôte / Rôle / Admin-Lookup pour tous les périphériques, réseaux / VLAN / VPN, vue d'ensemble du matériel, etc.)
  • RSS pour diffuser les modifications des pages wiki
  • Visio (meilleure entreprise M $ jamais achetée ...) pour dessiner des diagrammes de tout
  • KeePass pour les mots de passe, y compris les connexions pour les systèmes de tickets des fournisseurs
  • RackTables pour documenter où les périphériques sont situés et corrigés
  • Système de tickets accessible aux clients
  • WhatsUp Gold et autres outils de surveillance et de rapport
  • Des listes de diffusion pour tenir les gens au courant

Si vous utilisez beaucoup de réseaux IP, phpIP pourrait être une solution IPAM appropriée.

PEra
la source
2

Kyle Noland et d'autres affiches ont beaucoup parlé de la façon de documenter. Nous travaillons actuellement à la création d'un logiciel Web standard (hébergé en interne par vous) qui facilite la tâche des administrateurs réseau et système à la documentation de leur réseau.

Les aspects suivants sont couverts dans le logiciel à la date de rédaction de cet article (avril 2012):

  • Documentation du centre de données.
  • Détails du périphérique (y compris les détails du matériel et du système d'exploitation)
  • Gestion des adresses IP
  • Mappage de dépendance d'application
  • Relations entre périphériques - des bâtiments aux virtuals / lames.

Vous pouvez en lire plus ici et nous apprécierions vos commentaires.

Raj J
la source
1

Cela n’est généralement pas documenté, mais si vous êtes gentil, vous le faites habituellement dans un programme comme Visio ou un équivalent open source. Les informations les plus importantes sont les équipements connectés à quoi et les mots de passe de toute console de gestion. Le reste peut généralement être deviné.

Jedberg
la source
2
Il est généralement documenté dans un endroit avec un grand réseau. Probablement pas dans le détail qu'il devrait être, ou peut-être un peu en retard par rapport au courant mais c'est généralement documenté.
sclarson
1
J'essayais d'être ironique.
Jedberg
1

Dans ma carrière précédente en tant que responsable informatique, mon classeur de documentation incluait un diagramme Visio de tous les périphériques, une liste des allocations de plages d'adresses IP, toutes les clés de produit pour Windows / Office / Acrobat, des instructions sur les éléments à installer sur les nouveaux ordinateurs avec instructions pas à pas, comment, inventaire matériel complet jusqu'au niveau du composant, et surtout la liste des numéros de téléphone d'urgence: support technique FAI, support technique du fabricant de routeur, etc.

Scott
la source
1

Comme mentionné, cela dépend d'un certain nombre de facteurs ...

Mon objectif était de disposer de suffisamment de documentation pour que je puisse (conceptuellement, au moins) tout remettre à un collègue et lui dire «je te vois dans 3 semaines», tout en sachant que tous les détails importants étaient là.

  • Mots de passe pour tous les serveurs et périphériques (commutateurs, imprimantes, etc.)
  • Mots de passe pour tous les sites nécessitant une inscription - FAI, enregistrement de nom de domaine, garanties matérielles, autorités de certification, etc.
  • Carte des adresses IP utilisées - internes, externes, dmz, blocs de DHCP, etc.
  • Détails de chaque serveur: informations standard telles que le numéro de série, la quantité de disque, la RAM, etc., mais nous avons également conservé un journal de toutes les opérations effectuées, à commencer par les notes de configuration (o / s et app. Install), puis ll configuration et les modifications ultérieures.

Je n'ai jamais réussi à le faire complètement, mais je souhaitais documenter tous les principaux processus de routine: comment les serveurs étaient configurés, comment et ce qui était surveillé, la configuration et la suppression d'un compte, la sauvegarde, etc.

Quartier
la source
1

Cartographier et documenter votre réseau peut être un bon moyen de transférer les informations nécessaires. MS Visio est un outil de diagramme, mais il est statique et vous devez y passer beaucoup de temps. J'ai trouvé que NetBrain est un outil idéal pour créer un diagramme de réseau. Il peut documenter le réseau instantanément et la documentation peut être exportée vers Visio ou Word. Je peux personnaliser le contenu que je veux tout en documentant mon réseau. Le contenu personnalisé comprend: 

  1. Contenus liés à l'inventaire tels que le numéro de série, la version du système d'exploitation, etc. 
  2. Contenus liés à la conception tels que le routage dynamique, la qualité de service, le filtrage du trafic 
  3. Contenu lié au chemin de trafic… 
  4. Contenu associé au fichier de configuration 
  5. Diagramme

Vous pouvez essayer de documenter votre réseau sur le site Web.

utilisateur64604
la source
1

J'utilise des outils tels que Microsoft Visio ou WhatsUp Gold pour tracer la topologie du réseau si cela peut vous aider.

utilisateur3943
la source
0

MS Visio est un bon moyen de documenter un réseau, mais ce n'est pas une solution gratuite. Gliffy est un bon produit si vous souhaitez réduire vos coûts.

Les diagrammes de réseau typiques montrent comment les informations circulent sur vos appareils (et généralement sur Internet). Ainsi, votre diagramme devrait contenir des informations sur l'emplacement de vos ordinateurs, imprimantes, WAP, téléphones IP (le cas échéant), les commutateurs et les routeurs, ainsi que leur mode de connexion. Des adresses IP peuvent également être incluses avec le nom de votre appareil. Ceci est utile si vous souhaitez consulter votre diagramme pour obtenir des informations à la volée.


la source
-1

NodeSystems est exactement cela: un outil de documentation réseau. En tant qu'effet secondaire intéressant, il créera un diagramme interactif pour vous.

Découvrez la démo en ligne: http://www.nodesystems.org/demo/

Phèdre
la source