godebos/debos

debos - Debian 操作系统镜像构建工具

概述

debos 是一款用于简化各类基于Debian的操作系统（OS）镜像创建的工具。与其他专注于特定用例的工具不同，debos 更侧重于作为工具链，使常见操作变得简单，同时提供足够的灵活性以满足幕后可能需要的任何调整。debos 以YAML文件作为输入，按顺序执行文件中列出的操作，这些操作均为自包含且相互独立。

核心功能与特性

主要操作（Actions）

debos 通过YAML配方文件中的操作（actions）实现镜像定制，主要支持以下操作：

• debootstrap：使用 debootstrap 构建目标根文件系统
• apt：通过 apt 安装软件包及其依赖
• download：从互联网下载单个文件
• filesystem-deploy：将根文件系统部署到已创建的镜像中
• image-partition：创建镜像文件、分区并格式化
• ostree-commit：从根文件系统创建 OSTree 提交
• ostree-deploy：将 OSTree 分支部署到镜像
• overlay：递归复制目录或文件到目标文件系统
• pack：将目标文件系统创建为tarball
• raw：将文件直接写入输出镜像的指定偏移量
• recipe：包含指定路径的配方操作
• run：在文件系统或主机中运行命令或脚本
• unpack：从归档文件中解压文件到文件系统

完整的操作语法说明可参考：https://godoc.org/github.com/go-debos/debos/actions

关键特性

• 基于YAML配方文件定义构建流程，结构清晰
• 操作自包含且独立，便于维护和扩展
• 支持模板变量（通过 -t 选项）和环境变量（通过 -e 选项）定制
• 默认使用 fakemachine 创建隔离虚拟机执行构建，确保构建环境一致性和可重复性
• 提供详细的命令行选项，支持调试（如 --debug-shell）、资源配置（--cpus、--memory）等

使用场景

适用于需要创建定制化基于Debian的操作系统镜像的场景，例如：

• 嵌入式设备的系统镜像构建
• 开发或测试环境的标准化镜像
• 特定用途的最小化Debian系统（如服务器、边缘设备）
• 需要包含特定软件包、配置或脚本的定制化系统

安装方法

Docker 容器安装

官方Docker容器可用：

bash
docker pull godebos/debos

使用说明参见 https://github.com/go-debos/debos/blob/master/docker/README.md%E3%80%82

Debian 系统安装

bash
sudo apt install golang git libglib2.0-dev libostree-dev qemu-system-x86 \
     qemu-user-static debootstrap systemd-container
export GOPATH=/opt/src/gocode  # 或其他适合你的路径
go get -u github.com/go-debos/debos/cmd/debos
/opt/src/gocode/bin/debos --help

使用示例

简单示例

以下示例将创建一个arm64架构镜像，安装多个软件包，修改 /etc/hostname 为 "debian"，并最终生成tarball。

创建 example.yaml 文件：

yaml
{{- $image := or .image "debian.tgz" -}}

architecture: arm64

actions:
  - action: debootstrap
    suite: "buster"
    components:
      - main
      - non-free
    mirror: https://deb.debian.org/debian
    variant: minbase

  - action: apt
    packages: [ sudo, openssh-server, adduser, systemd-sysv, firmware-linux ]

  - action: run
    chroot: true
    command: echo debian > /etc/hostname

  - action: pack
    file: {{ $image }}
    compression: gz

运行构建命令：

bash
debos example.yaml

默认生成的tarball名为 debian.tgz，如需修改名称，可通过模板变量指定：

bash
debos -t image:"debian-arm64.tgz" example.yaml

其他示例

构建树莓派3定制化镜像的示例可参考：https://github.com/go-debos/debos-recipes

命令行选项

基本命令格式：

bash
debos [选项] <YAML配方文件>
debos [--help]

主要选项：

• -b, --fakemachine-backend=：指定fakemachine后端（默认：auto）
• --artifactdir=：打包归档和ostree仓库的目录（默认：当前目录）
• -t, --template-var=：模板变量（使用 -t 变量:值 语法）
• --debug-shell：出错时进入交互式shell
• -s, --shell=：重新定义交互式shell二进制文件（默认：/bin/bash）
• --scratchsize=：磁盘支持的临时空间大小
• -c, --cpus=：构建VM使用的CPU数量（默认：2）
• -m, --memory=：构建VM的内存大小（默认：2048MB）
• --show-boot：显示fakemachine的启动/控制台消息
• -e, --environ-var=：环境变量（使用 -e 变量:值 语法）
• -v, --verbose：详细输出
• --print-recipe：打印最终配方
• --dry-run：生成最终配方但不执行实际构建
• --disable-fakemachine：不使用fakemachine

环境变量配置

debos从主机读取预定义的环境变量列表并传播到fakemachine，当前包含代理相关变量：http_proxy, https_proxy, ftp_proxy, rsync_proxy, all_proxy, no_proxy。

• 变量大小写处理：对每个变量，会探测主机中的小写和大写变体，若存在则传播到fakemachine（例如主机的 HTTP_PROXY 和 no_proxy 都会被传播）。
• 通过 -e, --environ-var 选项可指定、覆盖或取消环境变量，语法：debos -e 变量:值 ...。
• 取消环境变量（阻止传播到fakemachine）：使用 -e 变量（不带值），支持同时指定多个 -e。

代理配置注意事项

代理环境变量会从主机传播到fakemachine，但存在以下已知问题：

• localhost问题：fakemachine中无法使用localhost，建议使用网络中有效的地址，debos会在环境变量包含localhost时发出警告。
• 变量名称差异：不同应用可能使用不同的代理变量名称或大小写，需确认应用所需的变量格式。

Fakemachine后端

默认情况下（除非使用 --disable-fakemachine），debos通过 https://github.com/go-debos/fakemachine 创建并启动虚拟机，在其中执行配方定义的操作，确保配方在不同主机环境下的可重复性。

• 后端选择：fakemachine支持多种虚拟化后端，默认根据主机支持情况自动选择，可通过 --fakemachine-backend 选项覆盖。
• 降级处理：若主机不支持任何后端，debos会回退到直接在主机上运行配方。

更多fakemachine后端信息参见 https://github.com/go-debos/fakemachine%E3%80%82