Cloud-init 在 Ubuntu Noble 中安装 Docker 时出现 Broken Pipe 问题的分析与解决

问题背景

在使用 cloud-init 自动化配置 Ubuntu Noble 系统时，用户遇到了一个关于 apt-get 更新过程中出现 Broken Pipe 错误的问题。具体表现为在 cloud-init 执行过程中，当尝试添加 Docker 官方仓库并安装 docker-ce 时，apt-get update 命令意外中断，导致后续的软件包安装失败。

问题现象

从日志中可以看到，cloud-init 在执行 apt-get update 命令时遇到了 Broken Pipe 错误：

2025-02-08 08:32:58,873 - distros[ERROR]: Failed to update package using apt: Unexpected error while running command.
Command: ['eatmydata', 'apt-get', '--option=Dpkg::Options::=--force-confold', '--option=Dpkg::options::=--force-unsafe-io', '--assume-yes', '--quiet', 'update']
Exit code: -
Reason: [Errno 32] Broken pipe

问题分析

Broken Pipe 错误通常发生在进程间通信时，一个进程试图向已经关闭的管道写入数据。在这个场景中，可能有以下几个原因：

1. 网络连接不稳定：在添加外部仓库后执行 apt-get update 时，网络连接可能不稳定，导致与仓库服务器的连接中断。

2. SSH 会话超时：如果 cloud-init 是通过 SSH 会话执行的，长时间运行的 apt 操作可能导致 SSH 会话超时断开。

3. APT 操作超时：某些仓库服务器响应缓慢，导致 apt 操作超过了默认的超时时间。

4. 资源限制：系统资源不足可能导致进程异常终止。

解决方案

经过测试和验证，以下解决方案可以有效解决这个问题：

1. 配置 Packer 的 expect_disconnect 参数： 在 Packer 的配置文件中添加 expect_disconnect = true 参数，这可以防止 SSH 会话断开导致构建失败。

2. 添加 cloud-init 状态等待： 在 shell provisioner 中添加 cloud-init status --wait 命令，确保 cloud-init 完全执行完毕后再进行后续操作。

3. 调整 APT 超时设置： 在 cloud-config 中增加 APT 的超时配置：

   apt:
     conf: |
       binary::apt::DPkg::Lock::Timeout 180;
       APT::Acquire::Retries "3";
       APT::Acquire::http::Timeout "120";
       APT::Install-Suggests 0;
       APT::NeverAutoRemove 0;
       APT::Get::Update 1;
       APT::Get::Assume-Yes 1;
       APT::Get::Fix-Broken 1;
       APT::Get::Install-Recommends 0;
   

最佳实践建议

1. 分阶段执行：将软件安装分为多个阶段，先安装基础依赖，再添加外部仓库，最后安装目标软件。

2. 增加日志记录：配置 cloud-init 输出更详细的日志，便于问题排查。

3. 使用本地镜像：对于频繁使用的仓库，可以考虑设置本地镜像源，减少网络依赖。

4. 资源预留：确保虚拟机有足够的 CPU 和内存资源执行自动化配置。

5. 超时设置：对于网络操作，适当增加超时时间，特别是从国外源下载时。

总结

在自动化部署过程中，网络操作的不稳定性是一个常见挑战。通过合理配置超时参数、优化执行流程和增加容错机制，可以有效提高 cloud-init 配置的成功率。对于 Docker 这类需要添加外部仓库的软件安装，特别需要注意网络操作的稳定性问题。

这个问题也提醒我们，在自动化配置设计中，需要考虑各种边界条件和异常情况，通过增加重试机制和超时控制来提高系统的鲁棒性。