cloud-init在Ubuntu 20.04多网卡环境下的网络配置问题分析

问题背景

在Ubuntu 20.04(Focal)系统中，当用户将cloud-init从23.4.4版本升级到24.1.3版本后，发现一个严重的网络配置问题：具有多个网络接口(特别是EC2实例中的ENA设备)的系统无法正常启动网络服务。这个问题会导致系统无法进行网络通信，严重影响业务运行。

问题现象

系统启动时，cloud-init的init-local阶段会失败，无法正确生成/etc/network/interfaces.d/50-cloud-init.cfg配置文件。关键的错误日志显示：

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/cloudinit/cmd/main.py", line 781, in status_wrapper
    ret = functor(name, args)
  File "/usr/lib/python3/dist-packages/cloudinit/cmd/main.py", line 442, in main_init
    init.apply_network_config(bring_up=bring_up_interfaces)
  File "/usr/lib/python3/dist-packages/cloudinit/stages.py", line 1060, in apply_network_config
    return self.distro.apply_network_config(
  File "/usr/lib/python3/dist-packages/cloudinit/distros/__init__.py", line 440, in apply_network_config
    self._write_network_state(network_state, renderer)
  File "/usr/lib/python3/dist-packages/cloudinit/distros/debian.py", line 129, in _write_network_state
    return super()._write_network_state(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/cloudinit/distros/__init__.py", line 364, in _write_network_state
    renderer.render_network_state(network_state)
  File "/usr/lib/python3/dist-packages/cloudinit/net/eni.py", line 561, in render_network_state
    util.write_file(fpeni, header + self._render_interfaces(network_state))
  File "/usr/lib/python3/dist-packages/cloudinit/net/eni.py", line 544, in _render_interfaces
    self._render_iface(iface, render_hwaddress=render_hwaddress)
  File "/usr/lib/python3/dist-packages/cloudinit/net/eni.py", line 485, in _render_iface
    lines.extend(self._render_route(route, indent="    "))
  File "/usr/lib/python3/dist-packages/cloudinit/net/eni.py", line 406, in _render_route
    route_line += "%s %s %s" % (default_gw, mapping[k], route[k])
KeyError: 'gateway'

技术分析

经过深入分析，这个问题源于cloud-init 24.1.3版本中的一个关键变更。在之前的版本中，cloud-init会为每个路由表项都包含网关信息。但在新版本中，引入了无网关的路由表项，这导致ENI渲染器在处理这些路由时出现异常。

具体来说，问题出现在以下两个关键点：

1. 数据源处理阶段：EC2数据源现在会生成一些没有网关的路由表项，特别是在多网卡配置的情况下。

2. ENI渲染器阶段：当尝试渲染这些无网关的路由时，渲染器会尝试访问不存在的'gateway'键，从而抛出KeyError异常。

值得注意的是，这个问题在单网卡系统中不会出现，因为EC2数据源在检测到单一网络设备时会移除这些特殊路由。这解释了为什么问题只在多网卡环境中显现。

解决方案

对于遇到此问题的用户，有以下几种解决方案：

1. 临时解决方案：在cloud.cfg配置文件中添加activators配置项：

   system_info:
     network:
       renderers: ['eni', 'netplan', 'sysconfig']
       activators: ['eni', 'netplan', 'network-manager', 'networkd']
   

   这可以确保系统使用正确的网络激活器。

2. 永久解决方案：升级到包含修复补丁的cloud-init版本。开发团队已经提交了修复该问题的补丁，主要修改了ENI渲染器对无网关路由的处理逻辑。

3. 配置回退：如果业务允许，可以考虑暂时回退到23.4.4版本，等待稳定修复版本发布。

最佳实践建议

对于在EC2环境中运行Ubuntu 20.04并使用多网卡配置的用户，建议：

1. 在升级cloud-init前，先在测试环境中验证网络配置是否正常。

2. 考虑使用netplan作为主要的网络渲染器，因为它对现代Linux发行版的网络配置支持更好。

3. 定期检查cloud-init的更新日志，了解可能影响网络配置的重大变更。

4. 对于生产环境，建议建立完善的监控机制，确保能及时发现网络配置失败的情况。

总结

这个案例展示了基础设施工具链中版本升级可能带来的潜在风险，特别是在处理关键系统配置如网络时。开发者和系统管理员需要充分理解工具的工作原理，建立完善的测试流程，并准备好回滚方案，以确保系统稳定性。