pengembangan-web-mp.com

Bagaimana Anda mendokumentasikan jaringan?

Saya tidak yakin bagaimana mengajukan pertanyaan ini, karena saya tidak di lapangan. Katakanlah Anda adalah admin jaringan dan Anda meninggalkan pekerjaan Anda. Bagaimana orang baru tahu harus mulai dari mana?

66
Esteban Araya

Itu tergantung pada ukuran jaringan, jumlah pengguna, jumlah node (komputer, server, printer, dll.) Dan ukuran staf TI Anda, antara lain.

Itu juga tergantung pada tujuan Anda. Apakah Anda mendokumentasikan jaringan untuk tujuan pelatihan dan pemeliharaan, asuransi/pencegahan kerugian, dll?

Secara pribadi, saya mendokumentasikan jaringan saya sedemikian rupa sehingga saya tahu saya dapat memperoleh informasi yang hilang berdasarkan apa yang didokumentasikan . Dari sudut pandang praktis, ada titik pengembalian yang menurun ketika dokumentasi Anda terlalu terperinci.

Aturan praktis yang baik yang saya gunakan adalah bahwa harus ada dokumentasi di lokasi yang diketahui yang cukup menyeluruh sehingga jika saya tertabrak bus malam ini, administrator lain dapat menjaga jaringan inti tetap berjalan sementara ia mengisi bagian yang hilang di atas beberapa hari/minggu ke depan.

Berikut ini adalah ikhtisar dari apa yang saya anggap paling penting tentang salah satu jaringan saya. Sebagai catatan, ini adalah toko khusus Windows dengan sekitar 100 pengguna dan 5 kantor.

  • Kredensial administrator untuk semua server. Jelas ini harus dijaga agar tetap aman.
  • Alamat IP dan nama NetBIOS untuk setiap node di jaringan dengan alamat IP statis, termasuk server, workstation, printer, firewall, router, switch, dll.
  • Informasi perangkat keras server dasar, seperti Tag Servis atau yang setara, kapasitas total disk, total RAM, dll.
  • Peran utama setiap server, seperti Pengontrol Domain, Server File, Server Cetak, Server Terminal, dll.
  • Lokasi kaset/drive cadangan.
  • Informasi tentang nomor akun dan kredensial untuk layanan seperti penyedia data dan suara kantor jarak jauh.
  • DNS eksternal untuk situs web dan perutean.

Jika ada sesuatu yang aneh tentang pengaturan atau alur kerja yang tidak akan segera jelas bagi administrator baru, saya akan menulis "brief" singkat tentang itu juga.

55
Kyle Noland

Saya menemukan yang terbaik untuk menggabungkan semua hal berikut:

  • Prosa: Tinjauan umum dalam bentuk paragraf, yang membantu dengan gambaran besar awal dan juga dapat menggambarkan evolusi dari waktu ke waktu
  • Tabel: Daftar tabel, baik alamat-kunci, kunci-lingkungan, atau kunci-mesin (lebih disukai semua yang di atas)
  • Diagram: Jelas membutuhkan diagram dengan berbagai tingkat detail. Pada jaringan ukuran apa pun yang layak, hanya mustahil untuk secara waras menangkap semuanya pada satu halaman dan membuatnya mudah dicerna. Anda menginginkan satu diagram di tingkat global, dengan perangkat infrastruktur (router, sakelar, titik akhir terowongan, dll.), Dan beberapa diagram lainnya untuk sumber daya komputasi yang dikerjakan oleh masing-masing router atau titik akhir tersebut.

Catatan tambahan tentang diagram ... Distribusi geografis adalah cara yang mudah untuk melakukan segmentasi, tetapi Anda juga memerlukan pandangan logis berdasarkan fungsi instalasi. Juga, beri label seperti orang gila, gunakan sepenuhnya tipografi dan warna.

11
Adam D'Amico

Cara paling efektif dan menyeluruh untuk memulai proses ini adalah membangunnya dari skenario pemulihan bencana - mis. bangunan terbakar dan yang kita miliki hanyalah backup di luar kantor. Apa yang perlu kita beli terlebih dahulu, dan bagaimana itu perlu dikonfigurasi?

Kyle sudah memberikan perincian yang luar biasa, tetapi saya menemukan bahwa pendekatan DR membantu saya untuk mengambil hal-hal satu demi satu.

5
Kara Marfia

Di mana saya bekerja - kami menghadapi masalah yang sama ketika saya mulai di sini. Dengan meningkatnya jumlah server dan layanan, Anda menemukan semakin banyak dokumentasi yang ketinggalan zaman, dan dengan itu muncul sikap yang tak terhindarkan bagi staf untuk tidak mempercayai dokumentasi, setidaknya dokumentasi teknis tentang nama server, grup server, jaringan, dll.

Kami mulai mengembangkan proyek open-source bernama hotwire untuk mengatasi ini ...

  • Sistem Inventaris (Server, Jaringan, dll)
  • Pembuatan Server - RHEL Kickstart, SuSE AutoYaST, (TODO: Debian Preseed, Solaris Jumpstart)

Dengan menggabungkan sistem inventaris dengan sistem build, kami telah memastikan bahwa apa yang ada di database konsisten dengan apa yang ada di pusat data kami, karena kami sekarang harus memasukkan data ke dalam inventaris terlebih dahulu agar dapat membangun server .

Program klien (funcwire) kemudian diinstal pada semua server (sebagai bagian dari proses build) yang kemudian secara dinamis mengawasi perangkat keras server seperti yang dilaporkan oleh python-dmidecode , dan apa yang ada dalam inventaris, jadi jika ada perubahan, admin akan segera tahu.

Kami kemudian telah mengintegrasikan sistem wiki kami sehingga setiap server, rak, proyek, model perangkat keras dll dalam tautan hotwire langsung ke halaman wiki yang sesuai.

Karenanya kami telah "mendokumentasikan" server/jaringan/etc kami menggunakan hotwire + wiki (kami menggunakan pertemuan di sini, tetapi wiki yang layak akan melakukannya). (Namun perlu dicatat bahwa setelah server dibangun - hotwire tidak memodifikasinya dengan cara apa pun - manajemen berkelanjutan dilakukan melalui cfengine).

4
Xerxes

Saya menggunakan MikroTik Dude untuk memetakan hal-hal secara otomatis, ini adalah aplikasi yang luar biasa mengingat itu gratis. Itu juga dapat memonitor status saat ini. Halaman Web Bung

4
Sam Mackrill

Jawaban Kyle adalah saran yang bagus. Paling tidak, Anda mungkin bisa keluar dengan mendaftar:

  • Server (termasuk nama host, IP, dan peran)
  • Perangkat keras jaringan (sakelar, router, firewall)
  • Arsip kata sandi utama (kata sandi domain, kata sandi admin)
  • Dokumen kasar yang menguraikan kebijakan jaringan dan pengaturan aneh (termasuk di sini outlier seperti mesin yang bukan bagian dari domain)
4
kdmurray

Kyle Noland dan poster-poster lainnya telah membahas banyak tentang cara mendokumentasikan. Kami sedang berupaya membuat perangkat lunak berbasis web standar (di-host secara internal oleh Anda) yang memudahkan administrator jaringan dan sistem untuk mendokumentasikan jaringan mereka.

Kami memiliki aspek-aspek berikut yang tercakup dalam perangkat lunak pada tulisan ini (Apr 2012):

  • Dokumentasi Pusat Data.
  • Detail perangkat (termasuk detail HW/OS)
  • Manajemen Alamat IP
  • Pemetaan ketergantungan aplikasi
  • Hubungan perangkat - dari bangunan hingga virtual/blades.

Anda dapat membaca lebih lanjut di sini dan kami sangat menghargai umpan balik Anda.

2
Raj J

Untuk beberapa tutorial lebih lanjut tentang bagaimana/apa yang harus didokumentasikan, ada networkdocumentation.com .

Untuk beberapa contoh bagus, lihat ratemynetworkdiagram.com . misalnya Yang ini cukup bagus , dan yang ini luar biasa ;).

2
Dan

Pendekatan mendokumentasikan jaringan sebagai pendekatan pengembang mengembangkan sistem ...

  • Pertimbangkan persyaratan - ini telah dicatat dengan baik di atas, tetapi pertimbangkan WHO akan berkonsultasi dengan dokter dan untuk TUJUAN APA. Auditor akan mencari dan membaca artefak yang berbeda dari rekan SysAdmin.

  • Melakukan pemeliharaan dokumen - banyak orang telah menyebutkan nilai diagram dan peta, dan sebagai pemikir visual saya sangat setuju. TETAPI hal-hal itu dapat dibatalkan dengan satu tindakan menambah/menghapus Host. Pikirkan tentang 'tingkat yang benar' dari doc-o - yang benar-benar dapat dipertahankan oleh kelompok Anda.

  • Kencangkan semuanya dan sertakan catatan MENGAPA Anda mengkonfigurasi jaringan seperti yang Anda lakukan. Banyak, banyak orang lupa untuk memasukkan tanggal - tetapi DATE memberikan petunjuk ke dalam sejarah jaringan. Tak ternilai untuk pemecahan masalah dan mengurangi out-of-dateness yang melekat pada sebagian besar diagram jaringan.

  • Dokumentasi offload ke dalam "proses" - berkali-kali prosedur membangun/penempatan yang dibuat dengan baik akhirnya merampingkan "dokumentasi jaringan" karena detail konfigurasi dan penamaan mesin lebih baik dijelaskan dalam prosedur.

Takeaway Kunci: pendekatan dokumentasi sebagai 'sistem'; itu harus memberikan nilai sejak hari pertama dan membawa tanggung jawab inheren untuk mempertahankannya.

2
Netais LLC

Di situs kami, kami menggunakan beberapa sistem untuk mendokumentasikan jaringan kami dan pelanggan. Kami mencoba dan gagal dengan banyak teknik/alat yang tidak skala, tapi sekarang kami cukup dengan yang berikut ini:

  • DokuWiki untuk kiat, deskripsi terperinci tentang konfigurasi dan
  • Tabel (Patchport/MAC/IP/Hostname/Peran/Admin-Lookup untuk semua perangkat, Jaringan/VLAN/VPN, ikhtisar perangkat keras, dll)
  • RSS untuk menyebarkan perubahan halaman wiki
  • Visio (perusahaan terbaik yang pernah dibeli oleh M $ ...) untuk menggambar diagram segalanya
  • KeePass untuk Kata Sandi, termasuk login untuk sistem tiket vendor
  • RackTables untuk mendokumentasikan di mana perangkat berada dan ditambal
  • Sistem Tiket, dapat diakses oleh pelanggan
  • WhatsUp Gold dan alat lainnya untuk memantau dan melaporkan
  • Milis agar orang selalu mendapat informasi terbaru

Jika seseorang berurusan dengan banyak jaringan IP, phpIP bisa menjadi solusi IPAM yang cocok.

2
PEra

Umumnya Anda memiliki beberapa tingkat detail yang mirip dengan abstraksi dalam dokumentasi desain perangkat lunak. Anda juga mendokumentasikan praktik/prosedur/konfigurasi perangkat umum. Kata sandi administratif sebagaimana berlaku.

Dalam situasi yang ideal, hampir semua hal yang dibutuhkan orang berikutnya mudah diakses dan didokumentasikan antara pedoman dan dokumen prosedur Anda + diagram tata letak jaringan.

Pedoman dan dokumen prosedur harus, menurut pendapat saya, dipusatkan di mana pun semua dokumen TI berada, dan diagram jaringan mungkin memiliki struktur folder sendiri untuk beberapa lokasi.

Dalam hal banyak situs satelit seperti walmart/targer/home depot, Anda akan memiliki dokumen generik untuk semua kantor cabang, dan kemudian beberapa dokumen korporasi terperinci dari interkoneksi kantor utama dan kemudian Anda dapat menyelam ke dalam dokumen LAN kantor.

2
sclarson

Saya akan menyarankan http://opennetadmin.com . Itu melakukan banyak hal yang disarankan orang dalam komentar lain.

1
Matt P

Memetakan dan mendokumentasikan jaringan Anda mungkin merupakan cara yang baik untuk mentransfer informasi yang diperlukan. MS Visio adalah alat diagram, tetapi ini statis dan Anda harus menghabiskan banyak waktu untuk itu. Saya menemukan NetBrain adalah alat diagram jaringan yang ideal untuk melakukan ini. Ini dapat mendokumentasikan jaringan secara instan dan dokumentasinya dapat diekspor ke Visio atau Word. Saya dapat menyesuaikan konten yang saya inginkan saat mendokumentasikan jaringan saya. Konten yang disesuaikan meliputi: 

  1. Konten terkait inventaris seperti nomor seri, versi OS, dll
  2. Konten yang terkait dengan desain seperti perutean dinamis, QoS, pemfilteran lalu lintas 
  3. Konten terkait jalur lalu lintas ... 
  4. Konten terkait file konfigurasi 
  5. Diagram

Anda dapat mencoba mendokumentasikan jaringan Anda di situs web.

1
user64604

Seperti yang disebutkan, itu tergantung pada sejumlah faktor ...

Tujuan saya adalah memiliki dokumentasi yang cukup sehingga saya dapat (secara konseptual, setidaknya) menyerahkan semuanya kepada rekan kerja dan mengatakan "sampai jumpa dalam 3 minggu," dan tahu bahwa semua detail penting ada di sana.

  • Kata sandi untuk semua server dan perangkat (sakelar, printer, dll.)
  • Kata sandi untuk semua situs yang diperlukan pendaftaran - ISP, pendaftaran nama domain, jaminan perangkat keras, otoritas sertifikat, dll.
  • Peta alamat IP yang digunakan - internal, eksternal, dmz, blok DHCP, dll.
  • Detail setiap server: hal-hal standar seperti nomor seri, jumlah disk, ram, dll., Tetapi kami juga menyimpan log yang berjalan dari semua yang dilakukan pada kotak, dimulai dengan catatan pengaturan (o/s dan aplikasi. Instal), lalu konfigurasi dan perubahan selanjutnya.

Saya tidak pernah berhasil melakukannya sepenuhnya, tetapi saya bertujuan untuk mendokumentasikan semua proses rutin utama - bagaimana server diatur, bagaimana dan apa yang dipantau, pengaturan dan penghapusan akun, cadangan, dll.

Biasanya tidak didokumentasikan, tetapi jika Anda baik, Anda biasanya melakukannya dalam program seperti Visio atau yang setara dengan sumber terbuka. Informasi yang paling penting adalah peralatan apa yang terhubung dengan apa, dan kata sandi untuk konsol manajemen apa pun. Sisanya biasanya bisa diramalkan.

1
jedberg

Dalam karir saya sebelumnya sebagai Manajer TI, binder dokumentasi saya termasuk diagram Visio semua perangkat, daftar alokasi rentang alamat IP, semua kunci produk untuk Windows/Office/Acrobat, instruksi tentang apa yang perlu diinstal pada perangkat baru. komputer dengan petunjuk langkah-demi-langkah caranya, menyelesaikan inventaris perangkat keras hingga ke tingkat komponen, dan yang terakhir adalah daftar nomor telepon darurat: dukungan teknis ISP, dukungan teknis produsen router, dll.

1
Scott

Saya menggunakan alat seperti Microsoft Visio atau WhatsUp Gold untuk memetakan topologi jaringan jika itu membantu.

1
user3943

MS Visio adalah cara yang baik untuk mendokumentasikan jaringan, tetapi ini bukan solusi gratis. Gliffy adalah produk yang bagus jika Anda ingin menghemat biaya.

Diagram jaringan umum menunjukkan bagaimana informasi mengalir melalui perangkat Anda (dan biasanya keluar ke Internet). Jadi, Anda harus memiliki informasi dalam diagram Anda tentang di mana komputer Anda, printer, WAP, telepon IP (jika ada), sakelar, dan router berada dan bagaimana mereka terhubung. Alamat IP juga dapat disertakan dengan nama perangkat Anda. Ini berguna jika Anda ingin melirik diagram Anda untuk mendapatkan informasi dengan cepat.

0
zewsk