Web Development & Hosting

Basic network documentation

A common practice in the IT world is to build out infrastructure quickly. As soon as an issue arises, the tendency is to firefight and move on. The problem with that approach is that too many potential issues, weaknesses, vulnerabilities, fall through the cracks. The biggest issue is when you take this practice to the data center. As we migrate more and more of our infrastructure to a Los Angeles data center, more and more tasks require remote assistance. What happens when you need to move a network cable? You need proper documentation or even the best network infrastructure in the world will not help you. Here is a list of the bare minimum documentation every server admin should create:

Network connections

The primary diagram you need is one with all the network connections. Note the port numbers, the orientation of the ports and any other information that might help during a crisis. Also, document the ISP-side details of network connections. Data centers like Rack Alley have several carrier connections in-house so make sure to note such details.

VLAN

Most applications, servers, and routers run on individual virtual networks within a physical network for security reasons. Document the different VLANs, VLAN ID’s, paths, and the addresses of all the devices on each VLAN.

Labels

Another important part of documenting your network is to label every component. Label each server, router, and switch with easy to read labels that include names, addresses, mac, and VLAN. Label cables on both sides with identifiers or use a numbered cable and indicate both sides in a separate document.