ネットワークをどのように文書化しますか？
私は現場にいないので、この質問をする方法がわかりません。あなたがネットワーク管理者で、仕事を辞めたとします。新しい男はどのようにしてどこから始めればよいのかをどのようにして知っていますか？
それは、とりわけ、ネットワークのサイズ、ユーザー数、ノード（コンピューター、サーバー、プリンターなど）の数、およびITスタッフのサイズに依存します。
それはあなたの目標にも依存します。トレーニングとメンテナンス、保険/損失防止などのためにネットワークを文書化していますか？
個人的には、isの文書化に基づいて欠落している情報を導き出せるようにネットワークを文書化しています。実用的な立場からすると、ドキュメントが細かくなりすぎると、利益が減少するポイントがあります。
私が使用する良い目安は、今夜バスに遭遇した場合、別の管理者が不足している部分を埋めている間、コアネットワークを実行し続けることができる十分な詳細がある既知の場所にドキュメントがあることです。次の数日/週。
これは、私のネットワークの1つについて最も重要だと思うものの概要です。記録のために、これは約100人のユーザーと5つのオフィスを持つWindowsのみのショップです。
- すべてのサーバーの管理者資格情報。明らかにこれは安全に保たれるべきです。
- サーバー、ワークステーション、プリンター、ファイアウォール、ルーター、スイッチなど、静的IPアドレスを持つネットワーク上のノードのIPアドレスとNetBIOS名.
- サービスタグなどの基本的なサーバーハードウェア情報、合計ディスク容量、合計RAMなど.
- ドメインコントローラー、ファイルサーバー、プリントサーバー、ターミナルサーバーなどの各サーバーの主な役割.
- バックアップテープ/ドライブの場所。
- リモートオフィスの音声やデータプロバイダーなどのサービスのアカウント番号と資格情報に関する情報。
- Webサイトおよびルーティング用の外部DNS。
新しい管理者にはすぐにはわからない設定やワークフローに何か奇妙なことがあった場合は、それについても短い「概要」を書きます。
次のすべてを組み込むのが最善です。
- 散文：最初の全体像の把握に役立ち、時間の経過に伴う変化を説明できる段落形式の一般的な概要
- テーブル：アドレス順、環境順、またはマシン順（できれば上記すべて）の表形式のリスト
- 図：複数の詳細レベルを持つ図が必要です。適切なサイズのネットワークでは、1ページにすべてをまともな形でキャプチャして、簡単に消化できるようにすることは不可能です。インフラストラクチャデバイス（ルーター、スイッチ、トンネルエンドポイントなど）を備えたグローバルレベルの1つの図と、これらの各ルーターまたはエンドポイントの前にあるコンピューティングリソースの別の図が必要です。
図に関する追加の注意事項...地理的分布はセグメント化する簡単な方法ですが、インストール機能に基づく論理ビューも必要です。また、書体や色を駆使して、クレイジーなラベルを付けましょう。
このプロセスを開始する最も効果的で完全な方法は、災害復旧シナリオから構築することです。建物は炎上し、私たちが持っているのはオフサイトのバックアップだけです。最初に何を購入する必要があり、どのように構成する必要がありますか？
カイルはすでにかなりの詳細を述べましたが、DRアプローチは私が物事を一度に一つずつ取るのを助けるのを見つけます。
私が働いているところ-私が最初にここから始めたとき、私たちは同じ問題に直面しました。サーバーとサービスの数が増えるにつれて、古くなったドキュメントがますます増え、それに伴って、スタッフがドキュメント、少なくともサーバー名、サーバーグループ、ネットワークなどに関する技術ドキュメントを信頼しないという避けられない態度が生まれています。
これに対処するために、 hotwire というオープンソースプロジェクトの開発を開始しました...
- 在庫システム（サーバー、ネットワークなど）
- サーバービルド-RHEL Kickstart、SuSE AutoYaST、（TODO：Debian Preseed、Solaris Jumpstart）
サーバーを構築できるようにするには、最初にデータをインベントリに入力する必要があるため、インベントリシステムとビルドシステムを組み合わせることで、データベースの内容とデータセンターの内容との整合性を確保します。 。
次に、クライアントプログラム（funcwire）がすべてのサーバーに（ビルドプロセスの一部として）インストールされ、 python-dmidecode によって報告されるようにサーバーハードウェアを動的に監視し、インベントリに何があるか、したがって、何か変更があった場合、管理者はすぐにそれを知ることができます。
その後、各サーバー、ラック、プロジェクト、ハードウェアモデルなどが適切なWikiページに直接ホットワイヤーリンクでリンクできるように、Wikiシステムを統合しました。
そのため、hotwire + wikiを使用してサーバー/ネットワークなどを「文書化」しました（ここでは合流を使用していますが、適切なwikiでも使用できます）。 （ただし、サーバーが構築されると、ホットワイヤーによってサーバーが変更されることはありません。継続的な管理はcfengineを介して行われます）。
私はMikroTik Dudeを使用して自動的に地図を作成します。これは無料であることを考えると素晴らしいアプリケーションです。現在のステータスも監視できます。 デュードウェブページ
カイルの答えは素晴らしいアドバイスです。ただし、最低限でも、おそらくリストから抜け出すことができます。
- サーバー（ホスト名、IP、役割を含む）
- ネットワークハードウェア（スイッチ、ルーター、ファイアウォール）
- マスターパスワードアーカイブ（ドメインパスワード、管理者パスワード）
- ネットワークポリシーと奇妙な設定の概要を示す大まかなドキュメント（ドメインの一部ではないマシンなどの外れ値をここに含めます）
カイル・ノーランドと他のポスターは、どのように文書化するかについて大いに取り上げました。私たちは、ネットワークおよびシステム管理者によるネットワークの文書化を容易にする、標準のWebベースのソフトウェア（内部でホストされる）の作成に取り組んでいます。
この記事の執筆時点（2012年4月）で、ソフトウェアには次の側面が含まれています。
- データセンターのドキュメント。
- デバイスの詳細（HW/OSの詳細を含む）
- IPアドレス管理
- アプリケーション依存関係マッピング
- デバイスの関係-建物から仮想/ブレードまで。
詳細は こちら をご覧ください。フィードバックをお待ちしています。
ドキュメント化の方法/内容に関するその他のチュートリアルについては、 networkdocumentation.com があります。
いくつかの良い例については、 ratemynetworkdiagram.com を参照してください。例えばこれは かなり良い で、これは awesome ;）です。
開発者がシステムの開発に近づくにつれてネットワークを文書化するアプローチ...
要件を検討してください。これは上記で十分に説明されていますが、WHOがdoc-oを参照し、その目的を検討することを検討してください。監査人は、ピアSysAdminとは異なるアーティファクトを探して読み取ります。
ドキュメントのメンテナンスを行う-多くの人々が図やマップの価値に言及しており、視覚的な思想家として心から同意します。ただし、これらのことは、ホストの追加/削除という1回の操作で無効にすることができます。あなたのグループが実際に維持できるdoc-oの「適切なレベル」について考えてください。
すべての日付を記入し、ネットワークを構成した理由をメモしてください。多くの人が日付を含めるのを忘れていますが、日付はネットワークの履歴へのポインタを提供します。問題解決に非常に貴重であり、ほとんどのネットワークダイアグラムに固有の古い状態を緩和します。
ドキュメントを「プロセス」にオフロード-多くの場合、堅牢で巧妙に作成されたビルド/デプロイメント手順は、マシンの構成と命名の詳細が手順でより適切に記述されるため、「ネットワークドキュメント」を合理化します。
重要なポイント：「システム」としてのドキュメントへのアプローチ。 1日目から価値を提供する必要があり、それを維持する固有の責任を伴います。
私たちのサイトでは、いくつかのシステムを使用して、自社および顧客のネットワークを文書化しています。多くのテクニック/ツールが失敗したため、試してみましたが失敗しましたが、次のように設定できました。
- DokuWiki ヒント、構成の詳細な説明、および
- テーブル（パッチポート/ MAC/IP /ホスト名/役割/すべてのデバイスの管理-ルックアップ、ネットワーク/ VLAN/VPN、ハードウェアの概要など）
- Wikiページの変更を広めるRSS
- すべての図を描くためのVisio（M $がこれまでに購入した最高の会社...）
- KeePass for Passwords（ベンダーチケットシステムのログインを含む）
- RackTables デバイスが配置され、パッチが適用されている場所を文書化します
- チケットシステム、顧客がアクセス可能
- WhatsUp Goldとその他の監視およびレポート用ツール
- 人々を最新に保つためのメーリングリスト
多数のIPネットワークを扱う場合、 phpIP が適切なIPAMソリューションになる可能性があります。
一般に、ソフトウェア設計ドキュメントの抽象化に似た、いくつかの異なる詳細レベルがあります。また、一般的なデバイスプラクティス/手順/構成も文書化します。必要に応じて管理パスワード。
理想的な状況では、次の人が必要とする可能性のあるほぼすべてのものに簡単にアクセスでき、ガイドラインと手順文書+ネットワークレイアウト図の間で文書化できます。
私の意見では、ガイドラインと手順のドキュメントは、すべてのITドキュメントがどこにあっても一元化されている必要があり、ネットワークダイアグラムには、複数の場所に独自のフォルダー構造がある場合があります。
Walmart/targer/home depotのような多くのサテライトサイトの場合、すべての支社の一般的なドキュメントがあり、本社の相互接続に関する企業全体の詳細なドキュメントがいくつかあり、オフィスのLANドキュメントに飛び込むことができます。
http://opennetadmin.com をお勧めします。それは人々が他のコメントで提案したことの多くをします。
ネットワークをマップして文書化すると、必要な情報を転送するのに適した方法になる場合があります。 MS Visioはダイアグラムツールですが、静的であり、多くの時間を費やす必要があります。 NetBrainはこれを行うのに理想的なネットワーク図ツールであることがわかりました。ネットワークを即座に文書化でき、VisioまたはWordにエクスポートできます。ネットワークを文書化しながら、必要なコンテンツをカスタマイズできます。カスタマイズされたコンテンツは次のとおりです。
- シリアル番号、OSバージョンなどの在庫関連のコンテンツ
- 動的ルーティング、QoS、トラフィックフィルタリングなどの設計関連コンテンツ
- 交通経路関連コンテンツ…
- 設定ファイル関連内容
- 図
ウェブサイトで ネットワークの文書化 を試すことができます。
前述のように、それはいくつかの要因に依存します...
私の目標は、（概念的には）すべてを同僚に渡し、「3週間後にお会いしましょう」と言って、すべての重要な詳細がそこにあることを知ることができる十分なドキュメントを用意することでした。
- すべてのサーバーとデバイス（スイッチ、プリンターなど）のパスワード
- 登録が必要なサイトのパスワード-ISP、ドメイン名登録、ハードウェア保証、認証局など.
- 使用されるIPアドレスのマップ-内部、外部、dmz、DHCPのブロックなど.
- 各サーバーの詳細：シリアル番号、ディスクの容量、RAMなどの標準的なものですが、セットアップノート（o/sおよびアプリインストール）から始めて、ボックスに対して行われたすべての実行ログも保持しました。次に、ll構成とその後の変更。
完全に管理することはできませんでしたが、すべての主要なルーチンプロセス（サーバーのセットアップ方法、監視の方法と内容、アカウントのセットアップと削除、バックアップなど）を文書化することを目的としました。
通常はドキュメント化されていませんが、親切な場合は通常、Visioなどのプログラムまたは同等のオープンソースで行います。最も重要な情報は、どの機器が何に接続されているか、および管理コンソールのパスワードです。残りの部分は通常神聖です。
以前のITマネージャーとしてのキャリアでは、私のドキュメントバインダーには、すべてのデバイスのVisio図、IPアドレス範囲の割り当ての一覧、Windows/Office/Acrobatのすべてのプロダクトキー、新規にインストールする必要があるものに関する指示が含まれていましたステップバイステップの手順が記載されたコンピューター、コンポーネントレベルまでのハードウェアインベントリ、および緊急電話番号リスト（ISPテクニカルサポート、ルーターメーカーテクニカルサポートなど）.
Microsoft VisioやWhatsUp Goldなどのツールを使用して、ネットワークトポロジを計画します。
MS Visioはネットワークを文書化する良い方法ですが、無料のソリューションではありません。 Gliffyは、コストを低く抑えたい場合に最適な製品です。
典型的なネットワーク図は、情報がデバイスを介して（通常はインターネットに）流れる方法を示しています。そのため、コンピューター、プリンター、WAP、IP電話（該当する場合）、スイッチ、ルーターの場所、およびそれらの接続方法に関する情報を図に含める必要があります。デバイスの名前にIPアドレスが含まれている場合もあります。これは、オンザフライでダイアグラムを一目で確認したい場合に役立ちます。