好模型像好合同
设计管理接口就像写好合同,二者的好属性基本相同:准确,另一方的反应才可预测,例外过多合同就失去价值;明确,各方理解一致才能互操作,语言要内部一致、术语熟悉,缺省要清楚;高效,不靠冗长和自我重复,模式要通过引用复用而不是处处重复。发散:接口一旦发布,歧义就会变成双方的实现成本。
主题对照
比较 YANG 建模中模式与实例、键、约束、配置与状态、rpc 与 action、augment 与 identity 的用法,以及从客户端用例建模、复用与多工具验证、空配置、leafref、XPath 性能和向后兼容规则。
设计管理接口就像写好合同,二者的好属性基本相同:准确,另一方的反应才可预测,例外过多合同就失去价值;明确,各方理解一致才能互操作,语言要内部一致、术语熟悉,缺省要清楚;高效,不靠冗长和自我重复,模式要通过引用复用而不是处处重复。发散:接口一旦发布,歧义就会变成双方的实现成本。
要准确向对端描述数据,就应创建数据模式,而不是用示例描述:示例有助于了解总体,但不够准确。以BookZone的图书目录为例,表中的具体条目即实例数据会随时间有进有出,而包含书名、ISBN、作者和定价四列的YANG结构保持不变。发散:接口设计最容易犯的错,是拿几条样例JSON当协议。
YANG列表的key对应关系表中的主键集。更新某本书时,要用键列在XPath中定位,例如/books/book[title=…]/author指向唯一一条元素。书中的基本建模原则是:尽可能使用有意义的键,允许用户使用任意字符串,而不是纯数字或UUID这类无意义的随机值。发散:管理接口的键还承担认知接口的责任。
类型定义(如pattern、union、range)让YANG模型更清晰,系统也能自动验证输入和输出。leafref是指向某个列表键列的指针,若作者名改成不存在的值,包含此修改的事务验证就会失败;must语句描述必须始终为真的限制。发散:没有约束的模型只是结构化注释,自动化需要系统能拒绝错误。
以书名人气指标为例:它不是管理人员可配置的数据,而是系统生成的、反映所发生事件的状态数据,管理人员在排障时特别希望监控它。YANG把这类数据标记为config false,与标记为config true的配置数据相对;config false可放在模型任何位置,作用于容器或列表时,其内部全部属于状态数据。发散:“我设置了什么”和“系统现在是什么”不能混在一起。
YANG中rpc与action的唯一区别是:rpc只能在模型顶层声明,action只能在容器、列表等内部使用;action是YANG 1.1新增的,所以许多现有模型只用rpc。编写新模型时,若操作作用于YANG树中的特定节点,就用action;若与特定节点无关,就用rpc。发散:操作放在哪里,会影响调用者如何理解领域边界。
YANG的新模块可用augment在既有模型的指定路径添加节点,不必改写原模块;也可定义派生identity,让引用根标识的identityref接受新值。AudioZone的推荐列表与streaming格式分别展示这两条扩展路径。发散:生态型接口应让新增结构和值各有明确入口。
IETF、IEEE、MEF、BBF等标准组织和OpenConfig等小组提供了经过评审和测试的模块,通常可作为后续工作和扩展的基础。选择基本模块时,要符合项目目标、受网元和服务支持,并遵守本组织的管理标准。可以在YANG Catalog中搜索已有类型,grouping、feature、identity等可重用节点也能这样搜索。发散:复用成熟抽象能降低互操作成本。
编写模块时要持续测试:确保模块可编译、语法正确,生成的数据模型一致且合乎逻辑;正则表达式等复杂结构既要匹配所需数据,也要符合YANG语法规则。pyang提供–strict和–ietf等检查,但它不是唯一的验证工具;yangvalator.org同时用pyang、confdc、yanglint等检查,通过全部工具验证的模块才更可信。
YANG Catalog的Impact Analysis工具用彩色编码图显示模块之间的依赖关系:哪些模块依赖某个模块、某个模块又依赖哪些模块。节点周围的环表示成熟度,也能标出瓶颈模块,即阻塞多个模块进展的未批准模块。为标准组织开发依赖他人进展的模块时,可借此快速找准工作重点。发散:模型发布后就进入生态,升级会影响谁必须心中有数。
YANG模型是服务器与客户端之间的契约,确定两者的接口和行为。它多由服务器侧(厂商和许多标准组织)编写,偶尔由客户端侧推动,如OpenConfig和强势买家。不管站在哪一边,都应从客户端侧的用例入手:客户端希望观察、配置和了解什么?然后对配置和状态建模,再加通知和操作。发散:从设备内部结构起步,容易把旧CLI思维固化进新接口。
书中用下达命令类比控制系统:命令要么完全接受并执行,要么彻底不接受;确认前单位不改变行为;询问命令时原样上报,不增不减;命令的详述不与状态报告或自主决定混杂。发现问题要尽快报告,只要不改变原命令就尽量继续执行,情况糟糕则关闭并求助。接收单位可以有一定自主性,程度取决于角色、能力和任务敏感性。
YANG模块一交到用户手中就被认为已发布,再改动内容用户可能会不高兴,所以一经发布就应开始考虑向后兼容规则。规则大意是:客户端对使用新版本模块的服务器执行的任何合法操作,对旧版本仍可执行。发布非向后兼容模块的正确方法,是为模块提供新的命名空间和文件名,通常也换新前缀,让所有人一眼看出这是新模块。
明智的做法是保留一个有意义且允许的空配置。例如BGP要配置AS编号才能工作,但应确保只在使用BGP时才要求AS编号;常见做法是把整个模块内容放进一个presence容器。反例是建模者没意识到must语句从一开始就适用,使初始的空配置无效。发散:模型要区分“系统支持”和“用户启用”。
每当用leafref代指某物,而不只是用普通字符串或整数,YANG模型的可读性和价值都会显著增加。聪明的用户没有leafref也能推断关系,但要自动化,就必须把这种语义提供给机器。作为配置的leafref要求所指实例必须存在,删除目标会使事务失败;若目标如硬件可能随时被移除,应加require-instance false。
XPath表达式可以简短地写出约束,却可能让服务器反复遍历大列表。书中举出的特定must表达式在朴素实现下随列表规模呈平方增长;改用unique能更直接表达唯一性,也更便于实现优化,但实际复杂度取决于服务器实现和索引。发散:模型验证成本要用目标实现和预期数据量测试。
配置向后兼容的要点是:模块早期版本中的全部有效配置,在所有新版本中必须继续有效,每个有效值的含义也不能变。所以列表和leaf都要保留、名称不变,但可以添加可选的新节点;枚举值和范围只能扩展;不能在已有数据上新增must、mandatory等约束,但可以删除约束;已有默认值不能改。非向后兼容会让客户失望甚至转投竞争对手。
YANG建模时,container把同类信息归组,list在组内允许重复实例,leaf承载带类型的具体值。把它们混成一种节点,会丢掉“有几个对象”和“对象有什么属性”的区分。
YANG模块以namespace取得全局身份,同名空间会使不同模块无法区分。前缀只是较短的引用写法,规范上无需全局唯一,但重复前缀会妨碍阅读和工具使用。设计模块时先保证命名空间唯一,再选易辨的前缀。
YANG 的 grouping 定义可重复使用的数据节点集合,uses 将它放进具体上下文。书名与格式引用同时用于购买历史、购买动作和发货通知;改动共同定义可减少三处漂移。树形输出会展开分组;过度嵌套则增加模型追踪成本。分组不只是文本宏,名字等语义仍受定义处作用域约束。
列表以ISBN作键时,同一本书仍可能出现多个相同format-id,使“书名+格式”无法确定唯一版本。YANG的unique format-id可在同一book的format列表中增加非键唯一约束,同时保留ISBN键。发散:外部选择条件若不同于内部主键,应单独声明它的唯一性。
分别让title和format引用全局有效值,会容许书名与格式各自存在、组合却不存在。应在format的leafref路径用谓语筛选title指向的book,再选它的format-id。发散:多字段引用要验证关系本身;各字段单独有效不代表组合有效。
YANG模型可拆成多个模块,让新功能只改变相关模块的修订记录,便于客户端识别受影响范围。模块太少会把无关变化绑在一起,太多又难追踪依赖;按相对稳定的功能边界拆分。发散:模块粒度应服务于变更沟通,而非追求文件数。
早期接口模型将配置interfaces与状态interfaces-state分成两棵树,客户端须自己关联同一接口。NMDA使同一模式节点在不同数据存储中呈现各自实例,接口模式只定义一次,减少字段重复及按名称猜测映射。发散:视图分离可以留在数据层,而非复制模型定义。
模块能编译只说明模式结构满足相应检查,仍需用合法与非法实例数据测试取值范围、引用和约束。书中先用编译器检查YANG,再实例化到ConfD发起NETCONF操作,另用yanglint验证实例。部署前还须核对目标设备实现,不能由测试引擎通过推定设备行为。
共享YANG模块时,代码文件之外还要给出名称、修订、组织、成熟度、来源仓库与路径等元数据,供他人判断版本和出处。书中目录只保存模块位置及元数据,实际文件仍来自代码仓库;使用者应回到源文件和设备能力核对,而不只凭搜索结果采用。
模型通过编译或pyang -f lint只是起点。作者应以客户端身份实际读取、配置并触发模型中的操作,制作示例和测试用例,再收集用户及实现者反馈。发布前让熟悉YANG的审查者检查语义和可用性。
YANG模块名和命名空间都应全局唯一且发布后保持稳定。私有模块可用组织名作为模块名前缀、组织控制的URL作为命名空间基础;未注册的命名空间不应冒用IANA管理的URN。另选简短清晰的引用前缀,降低跨模块阅读负担。
配置是否有效应能由配置及其YANG模型判断;must等配置约束不应依赖config false运行状态。运行状态瞬变会使同一配置时而有效、时而无效,破坏预验证与跨设备编排的可预测性。编译器放行不等于模型语义正确。
固定选项可用枚举;需由其他模块扩展且具有“某类的子类”关系时,identity更合适。比较identity值时用derived-from()或derived-from-or-self()考虑派生值;只做字符串相等判断可能让新增子类型被旧约束遗漏。
点击箭头逐层展开,点击卡片标题查看详情。路径上下文仅用于连接层级,不计入主题卡片数。
来源书籍
网络自动化与模型驱动管理类
书籍类型:工程实践
清单覆盖 8/8
187 张卡片
主题索引
比较服务组合中接口与协议失配的分类、适配器的生成与合成方式,以及兼容性分层与组合验证。
主题索引
比较键、约束规则与基表/视图更新语义在保证数据正确性上的作用。