一份没有注释的配置

假设你是一个新接手某一网络项目的维护工程师，面对设备配置里一望无际的接口，是否会感到一筹莫展，这种感觉很容易进化成负面情绪——无奈与焦躁，最后让你变得不淡定，不淡定就意味着更容易出错。我们要让网络变得更容易维护，工程师不容易出错，出于这个高尚的目的，作为普通的配置，能为可靠性要求极高的数据中心做什么呢？我们要让配置更给力，让工程师因为我们精心设计的配置时刻保持淡定。

(一)       从设备命名开始说起

设备是网络维护的基本单元，面对网络中成百上千的设备，如何准确地锁定故障设备，以最短的时间赶赴设备跟前。那么工程师是怎么知道哪台设备故障了呢？是成天守在设备跟前，那么多设备，守不过来啊；那等着业务部门报障，那就太迟啦，等着被投诉吧。事情往往不会那么杯具，我们所有的网络设备都通过网管平台管理了，设备一旦发生故障，就会产生日志或者失去与网管平台的连接，网管平台是能够及时感知的，然后就是网管平台给会工程师发短信，无论工程师在哪，只要有手机信号，都能够立刻知道有设备出事了。

那么一个新的问题是，面对成百上千的设备，网管平台以什么方式告诉工程师是具体哪一台呢？其实问题的解决往往就是那么容易，集团军可把几万名士兵按照“师-团-营-连-排-班-人名”的编制成功地管理起来，我们也参照着可以把网络设备进行合理的命名，让网管平台按照设备命名的方式告知工程师是哪台设备出了故障。

根据我们对已经积累经验的分析，结合下图，设备命名要具备如下特征：

1.      城市，可以让工程师迅速锁定机房的地理位置，运维是按照城市为单位，可以迅速地把告警短信发送给对应城市的值班工程师，如北京使用BJ、上海使用SH；

2.      地点，可以让某个城市的值班工程师安排人员迅速赶赴某个地点，如上地东方电子机房使用SD，滨江电信机房使用BT等等，通常客户在同一个城市机房数量是有限的，使用2维编码足矣；

3.      机房，在楼宇中有太多的房间，机房编号用于锁定具体房间，如0301表示3楼1房；

4.      机柜，机房内按照ABCD划分了机柜列，每个机柜按1234排列，线程工程师可以迅速赶赴设备跟前，如H16表示第H列第16柜，对于IRF设备，可能占用2个机柜，那么就要使用C1D1来表示，说明虚拟设备1在C列1柜，虚拟设备2在D列1柜；

5.      厂家编号，设备故障必须要知会厂家，有厂家的帮助会让现场处理人员底气更足，如H(ighest)表示会给你最大帮助的H3C；

6.      设备型号，可以让厂家人员找到更合适的人员为客户提供帮助，通常设备型号与厂家编号合在一起，如H12518表示H3C的S12518设备;

7.      设备虚拟名称，用于表明该设备的用途，如LC1，表示LANCore第1台；

8.      IRF标识，用于表明这台设备是IRF设备，用小写i表示；

9.      设备编号，用于表明某个机柜从上到下相同型号设备的第几台，如BJ-SD-0301-A5-H5800-NL-2说明这台S5800在北京上地东电301机房A列第5柜从上往下数第2台，它的作用是普通内网（Normal LAN）；

10.   设备名字的每一段都使用“-”分割，便于网管系统识别处理；

11.   在项目建设验收后，将所有设备命名打印成标签，贴在设备前面板，便于现场工程师核对设备身份。

从这一点也说明了，设备位置布置一定要事先规划好，尽量避免设备的物理位置变动，导致设备命名修改。数据中心的建设向来就是欲善其事，先利其器的工作，具备很强的计划性和项目可管理性。

进入任何领域，我们无意冒犯，我们会因为对完美的追求而变得刻薄，对缺陷的不容忍而变得冷酷。

(二)       哪些配置可以添加注释

既然注释如此重要，那么哪些配置可以添加注释（Description）呢，我们做了统计：

1.      所有接口及VLAN；

2.      VSI及VPN Instance；

3.      NQA；

4.      ACL；

5.      静态路由；

6.      OSPF。

接口（Interface）是设备互联组成网络的核心元素，接口种类比较多，不同种类接口用途不一，常见的可以分为如下几类：

1.      2层物理接口，如交换机以太网接口、RPR物理接口等；

2.      3层物理接口，如路由器各种接口；

3.      2层链路聚合接口；

4.      3层物理子接口；

5.      VLAN虚拟接口和VLAN、RPR业务接口；

6.      环回接口；

7.      隧道接口；

8.      虚模板等虚拟接口；

以上各类接口都可以添加注释，注释和设备命名一样，要遵循一定的规则，下面是参考。

对上图拓扑进行描述：

l  HZ-BJ-11-E1-HP-1，是一台HP服务器，位置在杭州滨江机房1楼1房E列1柜，从上往下数第1台；

l  这台HP服务器连接到同机柜的S5800交换机G1/0/3端口上，该交换机名为HZ-BJ-11-E1-H5800-A-1，其VLAN300用于服务器接入（A表示Access），该交换机通过2条10G链路以链路聚合方式连接到S12500组成的IRF系统，2条1G链路端口分别是Te1/0/49和Te1/0/50，链路聚合虚拟接口是Bridge-Aggregationg1；

l  2台S12500和S5800在同一个机房，命名为HZ-BJ-11-C2D2-H12500-C-i-1，C2D2表示IRF系统成员1在C列2柜，成员2在D列2柜，IRF-C表示这是IRF系统组成的Core设备，IRF系统使用2条10G连接而成，端口分别是Te1/0/1、Te2/0/1，连接接入S5800的两个聚合10G端口分别为Te1/5/0/1和Te2/5/0/1，使用虚拟聚合接口Bridge-Aggregation1，核心到互联网出口分别使用G1/4/0/1和G2/4/0/1，分别使用Tag模式VLAN100和No Tag模式VLAN150；

l  互联网出口设备HZ-BJ-11-F2-H6608-IG-1是一台SR6608设备，在同一个机房的F列2柜，IG表示Internet Gateway，端口G3/0/1连接IRF核心G1/4/0/1，G3/0/1连接IRF核心G2/4/0/1，分别采用Tag100子接口方式和No Tag方式，再通过Tunnel0接口与上海卢湾3楼1房MSR5040建立GRE隧道作VPN；

l  上海卢湾3楼1房MSR5040在A列1柜，也是互联网出口，命名为SH-LW-31-H5040-IG-1，它也通过Tunnel0接口连接到HZ-BJ-11-F2-H6608-IG-1作VPN。

各接口注释如下所示：

下面介绍一下接口及VLAN注释规则：

1.      对于交换机二三层特性分离的特点，物理接口注释体现物理连接，VLAN和VLAN接口体现业务用途；

2.      物理连接可以使用“对端设备名字-对端设备物理接口编号”来表示，如HZ-BJ-11-C2D2-H12500-C-i-1的Te1/5/0/1接口注释为“HZ-BJ-11-E1-H5800-A-1-Te1/0/49”；

3.      2层IRF物理接口则可以使用“对端接口编号-IRF”来表示，如HZ-BJ-11-C2D2-H12500-C-i-1上Te1/1/0/1上接口注释为“T2/1/0/1-IRF”；

4.      VLAN和对应VLAN接口注释保持一致，用于描述用途，如HZ-BJ-11-C2D2-H12500-C-i-1上VLAN100和Vlan-Interface100接口注释都是“HZ-BJ-11_F2_H6608-IG-1-Itc-Main”，表示和HZ-BJ-11-F2-H6608-IG-1互联主链路，Itc表示Interconnection，Main表示主链路；

5.      对于路由器大部分接口都是三层物理接口，所以接口注释既要体现物理连接，也要体现业务用途，如HZ-BJ-11-F2-H6608-IG-1的G3/0/1注释是“HZ-BJ-11-C2D2-H12500-C-i-1-Itc-Backup”，表示是连接到IRF核心的备用线路；

6.      三层物理子接口，子接口和VLAN注释使用相同规则，都用于描述用途，如HZ-BJ-11-F2-H6608-IG-1的G3/0/0.100的注释是“HZ-BJ-11-C2D2-H12500-C-i-1-Itc-Main”，子接口所在物理接口注释只表示物理连接，如G3/0/0的注释为“HZ-BJ-11-C2D2-H12500-C-i-1-G1/4/0/1”；

7.      2层链路聚合接口是一种虚拟接口，可以使用“对端设备名字-对端设备链路聚合接口编号”格式，如HZ-BJ-11-E1-H5800-A-1的Bridge-Aggregation接口1的注释为HZ-BJ-11-C2D2-H12500-C-i-1-BAGG1；

8.      有的VLAN是用于接入的，并不是互联的，如HZ-BJ-11-E1-H5800-A-1的VLAN300，其注释为Servers-Access，表示用于服务器接入；

9.      环回接口注释规则也是用途，如HZ-BJ-11-F2-H6608-IG-1的Loopback0接口注释为“Router-ID & MPLS-LSR-ID”表示用于作为Router-ID和MPLS的LSR-ID；

10.   隧道接口等其余虚拟接口也是用“用途”规则，如SH-LW-31-H5040-IG-1的Tunnel0注释是“HZ-BJ-11-F2-H6608-IG-1-Tunnel0-VPN”。

从上述繁杂的举例中，不妨总结一下注释的要素：

1.      连接特性：即对端设备名字；

2.      物理连接特性：对端设备名字-接口编号；

3.      用途：实际用途，如接入、互联、VPN等等；

4.      3层连接特性：对端设备名字-用途；

5.      2、3层分离：对于子接口和VLAN等采用2、3层分离的注释方式，即物理接口采用物理连接特性注释，子接口和VLAN采用3层连接特性或用途注释；

6.      2、3层合并：一般针对路由器比较有效，即物理接口注释同时体现“物理连接特性”和“用途”。

(三)       其余注释的规则

对于ACL等模块，注释主要用于说明用途，各单词首字母大写，各汉字拼音首字母大写。

(四)       重申注释的意义

可能初次尝试添加注释，特别是接口注释，会觉得这个工作量浩大，但网络是一个可以分割的系统，可以化繁为简，也可以聚少成多，多次实践，掌握其中的规律，可以提高配置效率。但更重要的意义开篇已经提到，看到一望无际接口，如果接口没有注释，那就无法知道每个接口的用途或连接状况，在做具体操作时需要翻阅大量工程文档，极度拖缓时机，网络维护往往会有“机不可失，时不再来”的感叹，既然如此事后诸葛，我们为何不早作打算，在配置初期添加注释，虽然增加了工作量，但考虑到这个付出对于维护工作的好处，无疑是值得的。