네트워크를 어떻게 문서화합니까?


66

현장에 있지 않기 때문에이 질문을하는 방법을 잘 모르겠습니다. 네트워크 관리자이고 퇴근했다고 가정 해 보겠습니다. 새 사람은 어디서부터 시작해야하는지 어떻게 알 수 있습니까?


6
또한 : 문서를 사용하면 언젠가 휴가를 보낼 수 있고 너무 아파서 부상을 당했을 경우 회사를 보호 할 수 있습니다.
Kara Marfia

답변:


55

네트워크 크기, 사용자 수, 노드 수 (컴퓨터, 서버, 프린터 등) 및 IT 직원의 크기에 따라 다릅니다.

그것은 또한 당신의 목표에 달려 있습니다. 교육 및 유지 관리 목적, 보험 / 손실 방지 등을 위해 네트워크를 문서화하고 있습니까?

개인적으로, 나는 내가 무엇을 기반으로 누락 된 정보를 도출 할 수 알고있는 방식으로 내 네트워크를 문서화 되어 문서화합니다. 실질적인 입장에서 문서가 너무 세분화되면 수익이 감소하는 시점이 있습니다.

내가 사용하는 좋은 경험 법칙은 오늘 밤 버스에 부딪 치면 다른 관리자가 핵심 네트워크를 계속 실행하면서 누락 된 부분을 채울 수 있도록 충분히 알려진 알려진 위치에 문서가 있어야한다는 것입니다. 다음 몇 일 / 주.

다음은 내 네트워크 중 하나에 대해 가장 중요하게 생각하는 사항에 대한 개요입니다. 기록을 위해 이것은 약 100 명의 사용자와 5 명의 사무실이있는 Windows 전용 상점입니다.

  • 모든 서버에 대한 관리자 자격 증명. 분명히 이것은 안전하게 유지되어야합니다.
  • 서버, 워크 스테이션, 프린터, 방화벽, 라우터, 스위치 등 고정 IP 주소를 가진 네트워크의 모든 노드에 대한 IP 주소 및 NetBIOS 이름
  • 서비스 태그 또는 이와 동등한 시스템, 총 디스크 용량, 총 RAM 등과 같은 기본 서버 하드웨어 정보
  • 도메인 컨트롤러, 파일 서버, 프린트 서버, 터미널 서버 등과 같은 각 서버의 주요 역할
  • 백업 테이프 / 드라이브의 위치.
  • 원격 사무실 음성 및 데이터 공급자와 같은 서비스의 계정 번호 및 자격 증명에 대한 정보
  • 웹 사이트 및 라우팅을위한 외부 DNS.

새로운 관리자에게 즉시 알 수없는 설정이나 워크 플로에 이상한 점이 있으면 이에 대한 간단한 "간결한"내용도 작성합니다.


8
버스 별 히트 시나리오의 경우 +1
romandas

11

다음을 모두 통합하는 것이 가장 좋습니다.

  • 산문 : 단락 형태의 일반적인 개요. 초기 큰 그림을 돕고 시간 경과에 따른 진화를 설명 할 수 있음
  • 테이블 : 주소 키, 환경 키 또는 기계 키 형식의 테이블 형식 목록 (위의 모든 항목)
  • 다이어그램 : 여러 세부 수준의 다이어그램이 필요합니다. 적당한 크기의 네트워크에서는 모든 페이지를 한 페이지에 깔끔하게 캡처하여 쉽게 소화 할 수 없습니다. 인프라 장치 (라우터, 스위치, 터널 엔드 포인트 등)가있는 글로벌 수준의 다이어그램 하나와 각 라우터 또는 엔드 포인트가 앞쪽에있는 컴퓨팅 리소스를위한 다이어그램이 필요합니다.

다이어그램에 대한 추가 참고 사항 ... 지리적 분포는 쉽게 분할 할 수있는 방법이지만 설치 기능을 기반으로하는 논리적 뷰가 필요합니다. 또한 서체와 색상을 최대한 활용하여 미친 듯이 라벨을 붙입니다.


5

이 프로세스를 시작하는 가장 효과적이고 철저한 방법은 재난 복구 시나리오에서 구축하는 것입니다. 예를 들어 건물이 화염에 휩싸였으며 오프 사이트 백업 만 있으면됩니다. 먼저 무엇을 구매해야하며 어떻게 구성해야합니까?

카일은 이미 큰 세부 사항을 제공했지만 DR 접근 방식으로 한 번에 한 장씩 가져갈 수 있습니다.


4

카일의 대답은 훌륭한 조언입니다. 그래도 최소한 목록을 작성하지 않아도 될 수 있습니다.

  • 서버 (호스트 이름, IP 및 역할 포함)
  • 네트워크 하드웨어 (스위치, 라우터, 방화벽)
  • 마스터 비밀번호 아카이브 (도메인 비밀번호, 관리자 비밀번호)
  • 네트워크 정책 및 이상한 설정을 개략적으로 설명하는 대략적인 문서

4

내가 일하는 곳-처음 시작할 때 같은 문제에 직면했습니다. 서버와 서비스의 수가 증가함에 따라 점점 더 오래된 문서가 발견되고 직원이 문서, 최소한 서버 이름, 서버 그룹, 네트워크 등에 대한 기술 문서를 신뢰하지 않는 것이 불가피한 태도입니다.

우리는 이것을 해결하기 위해 hotwire 라는 오픈 소스 프로젝트를 개발하기 시작했습니다 ...

  • 인벤토리 시스템 (서버, 네트워크 등)
  • 서버 빌드-RHEL 킥 스타트, SuSE AutoYaST (TODO : 데비안 사전 설정, Solaris Jumpstart)

인벤토리 시스템을 빌드 시스템과 결합함으로써, 우리는 이제 서버를 구축하기 위해 먼저 인벤토리에 데이터를 입력해야하므로 데이터베이스에있는 것이 데이터 센터에있는 것과 일치하도록합니다. .

클라이언트 프로그램 (funcwire)은 모든 서버에 (빌드 프로세스의 일부로) 설치되어 python-dmidecode에 의해보고 된대로 서버 하드웨어와 인벤토리에 무엇이 있는지 동적으로 감시합니다. 즉시 알게 될 것입니다.

그런 다음 핫 와이어의 각 서버, 랙, 프로젝트, 하드웨어 모델 등이 해당 위키 페이지에 직접 연결되도록 위키 시스템을 통합했습니다.

따라서 우리는 hotwire + wiki를 사용하여 서버 / 네트워크 / 등을 "문서화"했습니다 (여기서는 합류를 사용하지만 괜찮은 위키는 그렇게 할 것입니다). (그러나 서버가 일단 구축되면-핫 와이어는 어떠한 방식으로도 서버를 수정하지 않습니다-지속적인 관리는 cfengine을 통해 수행됩니다).


3
"Howtire"링크가 작동하지 않습니다. 구글을 통해서도 찾을 수 없습니다. 죽었어?
마크

4

MikroTik Dude를 사용하여 사물을 자동으로 매핑합니다. 무료라고 생각하는 멋진 응용 프로그램입니다. 현재 상태를 모니터링 할 수도 있습니다. 친구 웹 페이지


2

일반적으로 소프트웨어 설계 문서의 추상화와 비슷한 몇 가지 세부 수준이 있습니다. 또한 일반적인 장치 관행 / 프로 시저 / 구성도 문서화합니다. 해당되는 경우 관리 비밀번호.

이상적인 상황에서 가이드 라인과 절차서 + 네트워크 레이아웃 다이어그램 사이에 다음 사람이 필요로하는 거의 모든 것이 쉽게 액세스 가능하고 문서화됩니다.

제 생각에 가이드 라인과 절차 문서는 모든 IT 문서가있는 곳마다 중앙 집중화되어야하며 네트워크 다이어그램은 여러 위치에 대한 자체 폴더 구조를 가질 수 있습니다.

월마트 / 타거 / 홈 디포와 같은 많은 위성 사이트의 경우 모든 지사에 대한 일반 문서와 본사 상호 연결에 대한 자세한 전체 회사 문서를 보유한 다음 사무실 LAN 문서로 다이빙 할 수 있습니다.


2

개발자가 시스템 개발에 접근함에 따라 네트워크를 문서화하는 접근법 ...

  • 요구 사항을 고려하십시오-이것은 위에서 잘 언급되었지만 WHO가 doc-o 및 WHAT PURPOSE를 참조 할 것을 고려하십시오. 감사자는 피어 SysAdmin과 다른 아티팩트를 찾아서 읽습니다.

  • 문서 관리-많은 사람들이 다이어그램과지도의 가치에 대해 언급했으며 시각적 사상가로서 나는 진심으로 동의합니다. 그러나 호스트를 추가 / 제거하는 단 한 번의 작업으로 이러한 사항을 무효화 할 수 있습니다. 그룹이 실제로 유지할 수있는 doc-o의 '올바른 수준'에 대해 생각해보십시오.

  • 모든 방식으로 날짜를 정하고 네트워크를 구성한 이유에 대한 메모를 포함시킵니다. 많은 사람들이 날짜를 포함하는 것을 잊지 만 DATE는 네트워크 기록에 대한 포인터를 제공합니다. 문제 해결에 매우 중요하며 대부분의 네트워크 다이어그램의 본질적인 구식을 완화시킵니다.

  • 문서를 "프로세스"로 오프로드하십시오. 시스템 구성 및 이름 지정에 대한 세부 사항이 절차에 더 잘 설명되어 있기 때문에 견고하고 정교하게 제작 된 빌드 / 배치 절차로 인해 "네트워크 문서"가 간소화됩니다.

주요 테이크 아웃 : '시스템'으로서 문서에 접근; 1 일째부터 가치를 제공해야하며이를 유지해야하는 고유 한 책임이 수반됩니다.


2

우리 사이트에서는 여러 시스템을 사용하여 자체 및 고객 네트워크를 문서화합니다. 우리는 확장하지 않은 많은 기술 / 도구로 시도하고 실패했지만 지금은 다음과 같이 설정되었습니다.

  • 도쿠 위키 팁, 구성의 상세한 설명 및 대한
  • 테이블 (모든 장치에 대한 패치 포트 / MAC / IP / 호스트 이름 / 역할 / 관리자 조회, 네트워크 / VLAN / VPN, 하드웨어 개요 등)
  • 위키 페이지의 변경 사항을 전파하는 RSS
  • 모든 것의 다이어그램을 그리는 Visio (최고의 회사 M $ ...)
  • 공급 업체 티켓 시스템에 대한 로그인을 포함하여 암호 용 KeePass
  • 장치가 위치하고 패치되는 위치를 문서화하는 RackTables
  • 고객이 이용할 수있는 티켓 시스템
  • WhatsUp Gold 및 모니터링 및보고를위한 기타 도구
  • 사람들을 최신 상태로 유지하는 메일 링리스트

많은 IP 네트워크를 다루는 경우 phpIP 가 적합한 IPAM 솔루션이 될 수 있습니다.



2

Kyle Noland와 다른 포스터는 문서화 방법에 대해 많은 것을 다루었습니다. 네트워크 및 시스템 관리자가 네트워크를보다 쉽게 ​​문서화 할 수 있도록 표준 웹 기반 소프트웨어 (내부에서 호스팅)를 개발하고 있습니다.

이 글을 쓰는 시점에 소프트웨어에서 다루는 내용은 다음과 같습니다 (2012 년 4 월) :

  • 데이터 센터 문서.
  • 장치 세부 사항 (HW / OS 세부 사항 포함)
  • IP 주소 관리
  • 응용 프로그램 종속성 매핑
  • 장치 관계 – 건물에서 가상 / 블레이드까지.

자세한 내용은 여기를 참조 하십시오 . 의견을 보내 주시면 감사하겠습니다.


1

일반적으로 문서화되어 있지 않지만 친절하다면 Visio 또는 오픈 소스와 같은 프로그램에서 일반적으로 수행합니다. 가장 중요한 정보는 어떤 장비가 어떤 장비에 연결되어 있으며 모든 관리 콘솔의 암호입니다. 나머지는 대개 신성 할 수 있습니다.


2
일반적으로 네트워크가 큰 장소에 문서화되어 있습니다. 아마도 현재 또는 현재보다 약간 뒤떨어져 있다는 것을 자세하게 설명하지는 않지만 일반적으로 문서화되어 있습니다.
sclarson

1
나는 뺨을 찌르려고했다.
jedberg

1

IT 관리자로서의 이전 경력에서 필자의 문서 바인더에는 모든 장치의 Visio 다이어그램, IP 주소 범위 할당 목록, Windows / Office / Acrobat의 모든 제품 키, 새로운 제품에 설치해야 할 지침이 포함되어있었습니다. 단계별 지침이있는 컴퓨터 구성 요소 수준까지 하드웨어 인벤토리를 완성하고 비상 전화 번호 목록 (ISP 기술 지원, 라우터 제조업체 기술 지원 등)


1

언급했듯이, 그것은 여러 가지 요인에 달려 있습니다 ...

저의 목표는 (적어도 적어도 개념적으로는) 모든 것을 동료에게 전달하고 "3 주 후에 보자"고 말할 수있는 충분한 문서를 가지고 있었고 모든 중요한 세부 사항이 있다는 것을 알고있었습니다.

  • 모든 서버 및 장치 (스위치, 프린터 등)의 비밀번호
  • 등록이 필요한 모든 사이트의 비밀번호-ISP, 도메인 이름 등록, 하드웨어 보증, 인증 기관 등
  • 사용 된 IP 주소 맵-내부, 외부, dmz, DHCP 블록 등
  • 각 서버의 세부 사항 : 일련 번호, 디스크 양, 램 등과 같은 표준 항목이지만, 설치 정보 (o / s 및 app. install)로 시작하여 상자에 수행 된 모든 것에 대한 실행 로그도 유지했습니다. 그런 다음 구성 및 후속 변경 사항이 적용됩니다.

나는 그것을 완전히 관리하지는 못했지만 서버 설정 방법, 모니터링 방법 및 모니터링 방법, 계정 설정 및 제거, 백업 등 모든 주요 일상 프로세스를 문서화하는 것을 목표로 삼았습니다.



1

네트워크를 매핑하고 문서화하면 필요한 정보를 전송하는 좋은 방법 일 수 있습니다. MS Visio는 다이어그램 도구이지만 정적 인 도구이므로 많은 시간을 소비해야합니다. NetBrain이이를위한 이상적인 네트워크 다이어그램 도구라는 것을 알았습니다. 네트워크를 즉시 문서화 할 수 있으며 문서를 Visio 또는 Word로 내보낼 수 있습니다. 네트워크를 문서화하는 동안 원하는 내용을 사용자 정의 할 수 있습니다. 사용자 정의 된 내용은 다음과 같습니다. 

  1. 일련 번호, OS 버전 등과 같은 재고 관련 내용 
  2. 동적 라우팅, QoS, 트래픽 필터링과 같은 디자인 관련 컨텐츠 
  3. 교통 경로 관련 내용… 
  4. 구성 파일 관련 내용 
  5. 도표

웹 사이트에서 네트워크문서화 할 수 있습니다 .


1

도움이된다면 Microsoft Visio 또는 WhatsUp Gold와 같은 도구를 사용하여 네트워크 토폴로지를 매핑합니다.


0

MS Visio는 네트워크를 문서화하는 좋은 방법이지만 무료 솔루션은 아닙니다. Gliffy는 비용을 낮추고 자한다면 좋은 제품입니다.

일반적인 네트워크 다이어그램은 정보가 장치를 통해 (그리고 일반적으로 인터넷으로) 어떻게 흐르는 지 보여줍니다. 따라서 다이어그램에 컴퓨터, 프린터, WAP, IP 전화 (해당되는 경우), 스위치 및 라우터의 위치와 연결 방법에 대한 정보가 있어야합니다. 장치 이름에 IP 주소가 포함될 수도 있습니다. 이 정보는 다이어그램을보고 즉시 정보를 볼 때 유용합니다.


당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.