Cloud-init中NetworkManager渲染器配置默认网关metric的问题分析

问题背景

在Linux网络配置中，metric（度量值）是一个重要的参数，它决定了路由的优先级。当系统存在多个默认网关时，metric值较小的路由将被优先使用。在cloud-init项目中，用户可以通过网络配置为默认网关指定metric值，但在使用NetworkManager(NM)渲染器时，这一配置未能生效。

问题现象

用户通过cloud-init配置了一个静态IP网络接口，并尝试为默认网关设置metric值为99。具体配置如下：

network:
  config:
    - name: enp1s0
      subnets:
        - address: 10.0.2.2/24
          gateway: 10.0.2.1
          type: static
          routes:
            - destination: 0.0.0.0/0
              gateway: 10.0.2.1
              metric: 99
      type: physical
  version: 1

然而，生成的NetworkManager连接配置文件(/etc/NetworkManager/system-connections/cloud-init-enp1s0.nmconnection)中并未包含metric配置，导致实际路由表中的metric值保持默认值100：

default via 10.0.2.1 dev enp1s0 proto static metric 100

技术分析

NetworkManager的metric配置机制

NetworkManager使用route-metric参数而非简单的metric来配置路由的优先级。这与传统的网络配置方式有所不同：

1. 在NetworkManager配置中，route-metric用于指定特定连接的默认路由metric
2. 这个参数影响该连接上所有路由的metric值
3. 它位于连接文件的[ipv4]或[ipv6]部分

cloud-init的实现问题

cloud-init的NetworkManager渲染器当前存在以下问题：

1. 虽然正确解析了用户配置中的metric值
2. 但在生成NM连接文件时，没有将metric转换为NM识别的route-metric参数
3. 导致用户指定的metric值被忽略，系统使用默认值

解决方案

该问题已在cloud-init的最新版本中修复。修复方案主要包括：

1. 在NetworkManager渲染器中添加对metric参数的处理
2. 将用户配置的metric值转换为NM识别的route-metric参数
3. 确保生成的连接文件包含正确的metric配置

修复后的配置将生成类似如下的NM连接文件：

[ipv4]
method=manual
may-fail=false
address1=10.0.2.2/24
gateway=10.0.2.1
route1=0.0.0.0/0,10.0.2.1
route-metric=99

最佳实践建议

对于需要在cloud-init中配置网络metric的用户，建议：

1. 明确指定每个接口的metric值，特别是在多网卡环境中
2. 对于默认网关路由，metric值应设置在subnets部分的routes中
3. 确保使用的cloud-init版本包含此修复
4. 在多网关环境中，合理规划metric值以确保流量按预期路由

总结

网络metric配置是复杂网络环境中的重要参数，特别是在多网卡、多网关场景下。cloud-init通过修复NetworkManager渲染器中的metric处理逻辑，确保了用户配置能够正确生效，为自动化部署提供了更可靠的网络配置能力。用户在使用时应注意配置格式和参数的正确性，并保持cloud-init版本更新以获取最佳兼容性。