mendersoftware/mender-convert

mender-convert Docker镜像文档

镜像概述

mender-convert Docker镜像是Mender项目提供的容器化工具，用于将常规Linux系统镜像转换为支持Mender OTA（Over-The-Air）更新的固件镜像。该镜像封装了mender-convert工具及其所有依赖，提供隔离、一致的运行环境，避免宿主机依赖冲突问题，简化嵌入式设备固件的OTA更新集成流程，适用于嵌入式开发、固件构建及OTA功能集成场景。

核心功能和特性

• 镜像转换能力：支持将常见嵌入式Linux镜像（如Raspbian、Debian、Yocto Project构建的镜像等）转换为Mender兼容格式，集成Mender客户端和OTA更新逻辑。
• 容器化环境：内置mender-convert工具及所有依赖（如qemu-user-static、parted、e2fsprogs等），无需在宿主机单独安装依赖，保证跨环境一致性。
• 配置灵活性：支持通过自定义配置文件（mender-convert.conf）调整转换参数，如分区大小、Mender服务器地址、更新策略等，满足不同硬件和业务需求。
• 硬件兼容性：兼容多种嵌入式硬件平台（如ARM、x86等），支持自定义硬件配置文件以适配特定设备。
• 自动化集成：可直接集成到CI/CD流程中，实现固件镜像的自动化转换和OTA兼容性验证。

使用场景和适用范围

• 嵌入式设备制造商：为产品固件添加OTA更新功能，无需手动修改系统镜像。
• 固件开发团队：在开发流程中快速验证OTA功能，减少环境配置时间。
• OTA功能集成项目：需要为现有Linux系统镜像添加Mender OTA支持的场景。
• CI/CD流程：作为固件构建流水线的一环，自动将构建完成的镜像转换为Mender格式。
• 多平台开发：在同一开发环境中处理不同硬件平台的镜像转换任务。

使用方法和配置说明

获取镜像

从Docker镜像仓库拉取（需替换<version>为具体版本号）：

bash
docker pull mendersoftware/mender-convert:<version>

基本使用步骤

1. 准备待转换的Linux系统镜像（如input.img）和自定义配置文件（可选，如mender-convert.conf）。
2. 通过docker run命令运行镜像，挂载宿主机目录（存放输入镜像、配置文件及输出目录）。
3. 执行转换命令，指定输入镜像路径、输出路径及配置参数。

示例：docker run命令

bash
docker run --rm -v $(pwd):/workdir \
  mendersoftware/mender-convert:<version> \
  --disk-image input.img \
  --config mender-convert.conf \
  --output-dir output

• --rm：容器退出后自动删除。
• -v $(pwd):/workdir：将当前目录挂载到容器内/workdir目录，用于输入输出文件共享。
• --disk-image：指定待转换的输入镜像路径（容器内路径，需在挂载目录中）。
• --config：指定自定义配置文件路径（可选，不指定则使用默认配置）。
• --output-dir：指定转换后输出文件的存放目录（容器内路径，对应宿主机挂载目录下的子目录）。

示例：自定义配置文件（mender-convert.conf）

conf
# 设置Mender服务器地址
MENDER_SERVER_URL="https://mender.example.com"
# 设置设备类型
MENDER_DEVICE_TYPE="raspberrypi4"
# 设置根分区大小（MB）
MENDER_ROOTFS_SIZE_MB=2048

环境变量说明

输出说明

转换成功后，输出目录将包含：

• 转换后的Mender兼容镜像（如mender.img）
• Mender Artifact文件（.mender格式，用于OTA更新）
• 转换日志（mender-convert.log）
• 分区表和配置摘要文件

注意事项

• 宿主机需支持Docker权限挂载，且输入镜像所在目录需对Docker容器可读，输出目录需可写。
• 转换大型镜像时，建议宿主机预留足够磁盘空间（通常为输入镜像大小的2-3倍）。
• 自定义硬件平台时，需提供对应的硬件配置文件（可参考Mender官方硬件支持列表）。