查找 并解决重复路由
同步配置或升级控制面前,请检查是否存在重复路由。两条无法区分的路由会让流量的归属不明确,已有的重复路由也可能阻止后续服务更新。
API7 企业版 3.10.7 引入了本文介绍的写入时检查。该检查适用于通过控制面创建或更新路由、更新服务以及导入 OpenAPI,包括通过 ADC 和 API 客户端进行的变更。
前置条件
- 可以访问目标网关组的服务和路由,包括由其他团队管理的配置。
- 已备份或导出当前配置,且拟应用的配置已纳入版本控制。
- 有测试环境可在同步到生产环境之前验证路由变更。
识别完全重复的路由
比较同一网关组内的路由。将各个服务的主机和 path_prefix 与各个路由的路径组合,得到实际匹配的 URL。将每个 HTTP 方法列表视为一个集合。列表顺序不用于区分路由,未指定方法或列表为空均表示匹配所有方法。同时比较各个路由的优先级。
对于同一网关组中匹配相同 URL 的路由:
| 路由 A | 路由 B | 写入结果 |
|---|---|---|
GET,优先级 0 | GET,优先级 0 | 完全重复,返回 400 并拒绝写入。 |
GET, POST,优先级 0 | POST, GET,优先级 0 | 完全重复,方法顺序不影响结果。 |
所有方法,优先级 0 | 所有方法,优先级 0 | 完全重复。 |
GET,优先级 0 | GET,优先级 10 | 允许写入。匹配时优先使用优先级更高的路由。 |
GET,优先级 0 | GET, POST,优先级 0 | 此检查允许写入。方法集合有重叠,但不完全相同。 |
GET,优先级 0 | POST,优先级 0 | 允许写入。方法集合没有交集。 |
/orders/* 和 /orders/1 等路径虽然重叠,但对应的 URL 并不相同。配置了 vars 的路由不参与这项基于 URL 的检查,未激活的服务在激活前也不参与检查。请单独核对这些情况。通过写入检查无法证明流量会到达预期路由。
同步前检查配置
在部署流水线中执行以下检查:
- 导出目标网关组的配置,并与拟应用的变更合并。纳入当前部署所管理范围之外的资源。
- 按照上述规则比较实际匹配的 URL、方法集合和优先级。对于每一组完全重复的路由,报告服务和路由的标识,并暂停部署,直到负责人解决冲突。
- 单独报告方法部分重叠、包含通配符的路径及带条件的路由,以供复核。如果你的组织禁止重叠,请明确记录这项策略比控制面的完全重复检查更严格。
- 对同一网关组的部署依次 执行。应用审核通过的变更,再次导出结果配置。在存在并发变更时,写入时检查只能尽力检测冲突,仍需进行最终核查。
控制台的冲突检查仅供参考,可能报告写入时检查允许的重叠。如果另一次部署在同步前更改了目标网关组,即使客户端静态检查未发现问题,也无法保证同步成功。
解决已有的重复路由和被阻止的服务更新
升级不会删除已有的重复路由。编辑重复路由时可能返回 400,更新其所属服务的任何操作也可能被阻止,包括修改描述或标签。更新服务时会重新检查该服务的所有路由,因为更改主机、路径前缀或激活状态都可能影响流量匹配。
根据冲突错误中的服务 ID、路由 ID、URL、方法和优先级找到两个资源。确定哪条路由应接收流量。删除废弃的路由、更改匹配条件,或在确实需要区分优先顺序时为路由设置不同的优先级。请验证流量会选择哪条路由,避免仅为了消除错误而修改优先级。
先修正引发冲突的路由,再重试服务更新。保持声明式配置源与实际生效的配置一致,以免下次同步时重新创建重复路由。
从部分完成的同步中恢复
同步过程中可能在部分资源 写入成功后,遇到另一项写入失败。命令失败并不表示所有变更都已回滚。
- 停止进一步的部署尝试,保留失败命令的输出、资源标识和控制面错误信息。
- 重新读取目标网关组的服务和路由,与部署前导出的配置和预期配置分别比较,确定哪些变更已成功应用。
- 修正预期配置中的冲突,复核剩余变更,然后再次同步。如果要回退,请在应用备份前根据当前状态复核回退变更。
- 确认数据面配置已同步,测试每个受影响的主机、路径和 HTTP 方法。通过请求日志确认选中的路由,包括方法重叠或优先级不同的情况。