ネットワークをどのように文書化しますか?


66

私はフィールドにいないので、この質問をする方法がわかりません。あなたがネットワーク管理者であり、仕事を辞めたとします。新しい男は、どこから始めたらいいのかをどのように知っていますか?


6
また、ドキュメントを使用すると、いつか休暇を取ることができます。また、病気や怪我をして仕事ができなくなった場合に会社を保護することもできます。
カラマルフィア2009年

回答:


55

ネットワークのサイズ、ユーザー数、ノード(コンピューター、サーバー、プリンターなど)の数、およびITスタッフのサイズなどに依存します。

また、あなたの目標にもよります。トレーニングとメンテナンス、保険/損失防止などのためにネットワークを文書化していますか?

個人的に、私は何に基づいて、不足している情報を導出することができます知っているように私のネットワークを文書化された文書を。実用的なスタンスから、ドキュメントが細かくなりすぎると収益が減少するポイントがあります。

私が使用する良い経験則は、今夜バスに当たった場合、別の管理者が不足している部分を埋めながらコアネットワークを実行し続けることができるように、十分に徹底した既知の場所にドキュメントがあることです次の数日/週。

ネットワークの1つについて最も重要だと思うことの概要を以下に示します。記録的には、これは約100人のユーザーと5つのオフィスを持つWindowsのみのショップです。

  • すべてのサーバーの管理者資格情報。明らかにこれは安全に保たれるべきです。
  • サーバー、ワークステーション、プリンター、ファイアウォール、ルーター、スイッチなど、静的IPアドレスを持つネットワーク上のノードのIPアドレスとNetBIOS名
  • サービスタグまたは同等のもの、合計ディスク容量、合計RAMなどの基本的なサーバーハードウェア情報。
  • ドメインコントローラ、ファイルサーバー、プリントサーバー、ターミナルサーバーなど、各サーバーの主要な役割
  • バックアップテープ/ドライブの場所。
  • リモートオフィスの音声プロバイダーやデータプロバイダーなどのサービスのアカウント番号と資格情報に関する情報。
  • Webサイトおよびルーティング用の外部DNS。

新しい管理者にはすぐにわからないようなセットアップやワークフローについて何かおかしなことがあれば、私もそれについて短い「簡単な説明」を書きます。


8
バスでヒットするシナリオの場合は+1。
ロマンダ09年

11

次のすべてを組み込むことが最善だと思います。

  • 散文:パラグラフ形式の一般的な概要。最初の全体像を把握し、時間の経過に伴う進化を説明することもできます。
  • 表:アドレスキー付き、環境キー付き、またはマシンキー付きの表形式リスト(上記のすべてが望ましい)
  • 図:複数の詳細レベルを持つ図が必ず必要です。まともなサイズのネットワークでは、すべてを1ページで完全にキャプチャして簡単に消化できるようにすることは不可能です。インフラストラクチャデバイス(ルーター、スイッチ、トンネルエンドポイントなど)を含むグローバルレベルのダイアグラムと、それらのルーターまたはエンドポイントのそれぞれが前面に置く計算リソース用の別のダイアグラムが必要です。

ダイアグラムに関する追加の注意事項...地理的分布は簡単にセグメント化する方法ですが、インストール機能に基づいた論理ビューも必要です。また、狂気のようなラベルを付け、書体と色を最大限に活用します。


5

このプロセスを開始する最も効果的で徹底的な方法は、災害復旧シナリオから構築することです。たとえば、建物が炎上し、オフサイトのバックアップしかありません。最初に何を購入する必要があり、どのように構成する必要がありますか?

カイルはすでに詳細を述べましたが、DRアプローチは物を1枚ずつ取り出すのに役立ちます。


4

カイルの答えは素晴らしいアドバイスです。最低限でも、おそらくリストから抜け出すことができます:

  • サーバー(ホスト名、IP、役割を含む)
  • ネットワークハードウェア(スイッチ、ルーター、ファイアウォール)
  • マスターパスワードアーカイブ(ドメインパスワード、管理者パスワード)
  • ネットワークポリシーと奇妙なセットアップの概要を示す大まかなドキュメント(ここには、ドメインの一部ではないマシンなどの外れ値が含まれます)

4

私が働いている場所-私がここで始めたとき、私たちは同じ問題に直面しました。サーバーとサービスの数が増えると、古くなったドキュメントが増え、それに伴って、ドキュメント、少なくともサーバー名、サーバーグループ、ネットワークなどの技術ドキュメントを信頼しないスタッフが避けられない態度を取ります。

これに対処するために、hotwireと呼ばれるオープンソースプロジェクトの開発を開始しました...

  • インベントリシステム(サーバー、ネットワークなど)
  • サーバービルド-RHEL Kickstart、SuSE AutoYaST、(TODO:Debian Preseed、Solaris Jumpstart)

インベントリシステムとビルドシステムを組み合わせることで、サーバーを構築するために最初にデータをインベントリに入力する必要があるため、データベースの内容とデータセンターの内容が一致することを保証します。 。

次に、クライアントプログラム(funcwire)がすべてのサーバーに(ビルドプロセスの一部として)インストールされ、python-dmidecodeによって報告されるサーバーハードウェアとインベントリの内容を動的に監視します。すぐにわかります。

次に、ホットワイヤ内の各サーバー、ラック、プロジェクト、ハードウェアモデルなどが適切なWikiページに直接リンクするように、Wikiシステムを統合しました。

したがって、hotwire + wikiを使用してサーバー/ネットワーク/などを「文書化」しました(ここでは合流を使用しますが、適切なwikiはすべて使用します)。(ただし、サーバーが構築されると-hotwireはサーバーを変更しません-継続的な管理はcfengineを介して行われます)。


3
「howtire」リンクは機能しません。グーグルでも見つけることができません。死んだ?
マーク


2

一般に、ソフトウェア設計ドキュメントの抽象化に類似した詳細のいくつかの異なるレベルがあります。また、一般的なデバイスプラクティス/手順/構成も文書化します。必要に応じて管理パスワード。

理想的な状況では、次の人が必要とするほぼすべてのものに簡単にアクセスでき、ガイドラインと手順文書+ネットワークレイアウト図の間で文書化されます。

私の意見では、ガイドラインと手順のドキュメントは、すべてのITドキュメントがどこにある場合でも一元化する必要があり、ネットワーク図には複数の場所の独自のフォルダ構造がある場合があります。

walmart / targer / home depotのような多くのサテライトサイトの場合、すべてのブランチオフィスの一般的なドキュメントがあり、メインオフィスの相互接続に関する詳細な企業ドキュメント全体があり、オフィスLANドキュメントに飛び込むことができます。


2

開発者がシステムの開発に近づくにつれて、ネットワークを文書化するアプローチ...

  • 要件を検討してください-これは上記で十分に注目されていますが、WHOがdoc-oを参照し、何のために検討するかを検討してください。監査人は、ピアSysAdminとは異なるアーティファクトを探して読み取ります。

  • ドキュメントのメンテナンスを行う-多くの人が図と地図の価値に言及しており、視覚的な思想家として心から同意します。しかし、これらのことは、ホストを追加/削除するという1回の行為で無効にできます。doc-oの「正しいレベル」について考えてください-グループが実際に維持できるものです。

  • すべての日付を記入し、ネットワークを構成した理由に関するメモを含めます。多くの人は、日付を含めることを忘れていますが、DATEはネットワークの履歴へのポインタを提供します。問題解決に非常に貴重であり、ほとんどのネットワーク図に固有の期限切れを軽減します。

  • ドキュメントを「プロセス」にオフロードします-マシンの構成と命名の詳細が手順でよりよく説明されるため、多くの場合、しっかりした巧妙なビルド/展開手順が「ネットワークドキュメント」を合理化します。

重要なポイント:「システム」としてのドキュメントへのアプローチ。1日目から価値を提供する必要があり、それを維持する固有の責任を負っています。


2

このサイトでは、いくつかのシステムを使用して、自社および顧客のネットワークを文書化します。スケールしなかった多くのテクニック/ツールで試して失敗しましたが、今では次のように設定されています:

  • DokuWikiのヒント、構成の詳細な説明のためにと
  • テーブル(パッチポート/ MAC / IP /ホスト名/ロール/すべてのデバイスの管理ルックアップ、ネットワーク/ VLAN / VPN、ハードウェアの概要など)
  • Wikiページの変更を広めるためのRSS
  • Visio(これまでに購入したM $で最高の会社...)
  • ベンダーチケットシステムのログインを含む、KeePass for Passwords
  • デバイスが配置され、パッチが適用される場所を文書化するRackTables
  • チケットシステム、顧客がアクセス可能
  • WhatsUp Goldおよびその他の監視およびレポート用ツール
  • 人々を最新の状態に保つためのメーリングリスト

多くのIPネットワークを扱う場合、phpIPが適切なIPAMソリューションになる可能性があります。



2

カイル・ノーランドと他のポスターは、文書化の方法について多くのことをカバーしています。ネットワーク管理者およびシステム管理者がネットワークを簡単に文書化できるようにする、標準のWebベースのソフトウェア(社内でホストされる)の作成に取り組んでいます。

この記事の執筆時点(2012年4月)で、ソフトウェアには次の側面が含まれています。

  • データセンターのドキュメント。
  • デバイスの詳細(HW / OSの詳細を含む)
  • IPアドレス管理
  • アプリケーション依存関係マッピング
  • デバイスの関係-建物からバーチャル/ブレードまで。

詳細についてはこちらをご覧ください。フィードバックをお待ちしています。


1

通常は文書化されていませんが、親切であれば、通常Visioまたは同等のオープンソースのようなプログラムで行います。最も重要な情報は、どの機器が何に接続されているか、および管理コンソールのパスワードです。残りは通常、占うことができます。


2
通常、大規模なネットワークがある場所で文書化されます。おそらく、それはあるべき詳細ではないか、現在より少し遅れているかもしれませんが、通常は文書化されています。
スクラソン2009年

1
私はおしゃべりになろうとしていました。
ジェドバーグ09年

1

ITマネージャーとしての以前の職歴では、ドキュメントバインダーには、すべてのデバイスのVisio図、IPアドレス範囲の割り当てのリスト、Windows / Office / Acrobatのすべてのプロダクトキー、新しいインストールする必要があるものに関する指示が含まれていましたステップバイステップの手順を備えたコンピューター、コンポーネントレベルまでハードウェアインベントリを完了し、最後になりましたが重要な緊急電話番号リスト:ISPテクニカルサポート、ルーターメーカーテクニカルサポートなど


1

前述のように、それは多くの要因に依存します...

私の目標は、同僚​​に(概念的には)すべてを渡して、「3週間後に会いましょう」と言って、すべての重要な詳細がそこにあることを知ることができる十分なドキュメントを用意することでした。

  • すべてのサーバーとデバイス(スイッチ、プリンターなど)のパスワード
  • 登録が必要なサイトのパスワード-ISP、ドメイン名登録、ハードウェア保証、認証局など
  • 使用されるIPアドレスのマップ-内部、外部、dmz、DHCPのブロックなど
  • 各サーバーの詳細:シリアル番号、ディスクの量、RAMなどの標準的なものですが、セットアップノート(o / sおよびapp。install)から始めて、ボックスに対して行われたすべての実行ログも保持しました。次に、構成と後続の変更を行います。

完全にはできませんでしたが、サーバーのセットアップ方法、監視方法と監視方法、アカウントのセットアップと削除、バックアップなど、すべての主要なルーチンプロセスを文書化することを目指しました。



1

ネットワークのマップと文書化は、必要な情報を転送するための良い方法です。MS Visioはダイアグラムツールですが、静的であり、多くの時間を費やす必要があります。NetBrainは、これを行うための理想的なネットワーク図ツールであることがわかりました。ネットワークを即座に文書化し、文書をVisioまたはWordにエクスポートできます。ネットワークの文書化中に、必要なコンテンツをカスタマイズできます。カスタマイズされたコンテンツは次のとおりです。

  1. シリアル番号、OSバージョンなどのインベントリ関連のコンテンツ
  2. 動的ルーティング、QoS、トラフィックフィルタリングなどの設計関連のコンテンツ
  3. トラフィックパス関連のコンテンツ…
  4. 構成ファイルに関連するコンテンツ

Webサイトでネットワーク文書化することができます


1

Microsoft VisioやWhatsUp Goldなどのツールを使用して、ネットワークトポロジをマッピングします(それが役立つ場合)。


0

MS Visioはネットワークを文書化する良い方法ですが、無料のソリューションではありません。Gliffyは、コストを抑えたい場合に最適な製品です。

典型的なネットワーク図は、情報がデバイスをどのように流れるかを示します(通常はインターネットに出ます)。したがって、ダイアグラムには、コンピューター、プリンター、WAP、IP電話(該当する場合)、スイッチ、ルーターの場所とそれらの接続方法に関する情報が必要です。IPアドレスもデバイスの名前に含まれている場合があります。これは、ダイアグラムをその場で一目で見たい場合に役立ちます。


弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.