Checklist for network architecture documentation
Michael Morris blogged about a great checklist for network architecture documentation here. Here is the checklist:
- Introduction and Business Drivers - this describes why you are writing the network architecture and what are the main business drivers for the network. Availability and consistent performance are given, but what else drives your network? Incredibly high availability for JIT manufacturing? Or maybe flexibility for fast growth?
- Global Network Design - a high-level description, with diagrams, of how the network goes together. People need to understand the big picture to see how all the little parts go together.
- Site Tiers - This is a key part of the network architecture. How do you categorize your sites? Maybe into five Tiers (1-5)? Maybe just three (Big, Medium, Small)? Any which way, you need a way to classify each of your sites so an appropriate Network Design Templates can be used. You should also include Site Decision Matrixes to help people decide which tier a site is, perhaps based on number of employees, or types of applications used, or business criticality.
- Network Design Templates - diagrams for each Site Tier ("1-5" or "Big, Medium, Small", etc.) that can be used repeatedly to build homogeneous networks at each site.
- Bill of Materials - the actual BOM that is used to order the equipment for each Site Tier. It is very important this BOM matches your Network Design Templates exactly since one missing piece of hardware can make a world of difference during installation. Your VAR or Cisco Sales can provide a detailed BOM for you based on your Network Design Templates and standards. Also include any other hardware used in the network like UPSs and cabling.
- WAN Options - types of WAN options that the network architecture will support, for example, MPLS, private lines, and IPSec tunnels. This list should include the WAN technologies that will likely be needed. Even if your entire network is using MPLS, you should have a few other technologies supported since needs can arise that may not be solved by a single WAN technology.
- Site Tracking List - once you have chosen a Site Tier, applied a Template, and picked appropriate WAN technologies for the site, you need to track all these decisions. This way you know how the NYC site is built - maybe as a Tier-2 site with dual MPLS circuits.
- Internet Access - how do people get outbound Internet access? What inbound access to company resources is provided from the Internet?
- Routing - since routing is arguably the key technology in a network, you need a section explaining how routing works. Sections should include normal and backup traffic flows, global routing, IGPs, BGP, static routes, and default routing.
- Configuration Standards - now that you have all the standards defined, you need actual device configuration standards. You should have exact configs for SNMP, booting, DHCP, HSRP, BGP, OSPF, ACLs, interfaces, VLANs, LAN switching....etc....etc...etc. In short, if it's a command on your equipment, have a written configuration standard for it.
- IP Addressing - how your global IP addressing and summarization is done, the policies for subnet allocation, and site specific IP subnetting standards. For example, if you assign a /22 to a Tier-3 site, how is that /22 divided into subnets? This is key to ensure IP addressing is the same at all sites.
- QoS - this can be a huge section that describes all aspects of QoS in your network. From LAN QoS, to IPT, to WAN QoS, to QoS with MPLS carriers, to where the actual applications fit into the QoS model. Take your time on this section since it is a key business enabler, but can also cause huge problems if implemented wrong.
- Wireless LAN - how does the WLAN work? (NOTE: this may require it's own architecture document like IPT and SANs if your WLAN is not simple.)
- Naming Conventions - these are more important than you may originally think. Spend some time to ensure your naming conventions are correct.
- Software Standards - levels, versions, and features sets of software used in the network. From IOS, to VPN concentrators, to firewalls. Each piece of equipment in use should have a software standard. You will also want to include a process for software maintenance and changes.
- Best Practices - a list of best practices for your network; things you have learned over the years that are unique to your environment.
- Network Architecture Review Board and Architecture Revision Process - these are the rules and guidelines on how you will make changes to all the stuff written above.