Raspberry Pi Image Generation Tool 使用指南

Raspberry Pi Image Generation Tool 使用指南

1. 项目目录结构及介绍

Raspberry Pi Image Generation Tool (rpi-image-gen) 是一个用于创建定制软件镜像的工具，适用于 Raspberry Pi 设备。以下是项目的目录结构及其介绍：

• bin/: 存放可执行脚本和工具。
• config/: 包含设备的根文件系统配置文件，定义了磁盘镜像的配置标识符和顶层属性。
• device/: 包含特定于设备的元数据和脚本。
• examples/: 提供了一些示例配置文件和脚本，用于展示如何定制安装和修改。
• image/: 定义了用于创建设备磁盘镜像文件的配置。
• keydir/: 存储密钥文件。
• legacy/: 包含旧版本的代码和文件。
• meta-hooks/: 包含在特定执行流程中可能运行的钩子脚本。
• meta/: 包含定义了镜像构建的不同层的 YAML 文件。
• profile/: 包含设备的 YAML 层，用于定制根文件系统。
• scripts/: 包含构建过程中使用的辅助脚本。
• templates/: 存储模板文件。
• depends/: 包含了构建工具的依赖关系列表。
• .gitignore: 指定了 Git 忽略的文件和目录。
• .gitlab-ci.yml: 用于 GitLab CI/CD 的配置文件。
• LICENSE: 项目的许可证文件。
• README.adoc: 项目的自述文件。
• build.sh: 主要的构建脚本，用于生成镜像。
• install_deps.sh: 脚本用于安装构建所需的依赖。

2. 项目的启动文件介绍

项目的启动文件是 build.sh 脚本，它是构建定制镜像的主要入口点。执行该脚本会启动以下流程：

1. 设置构建环境。
2. 使用 mmdebstrap 和 bdebstrap 构建根文件系统。
3. 通过 genimage 工具创建磁盘镜像文件。
4. 生成软件物料清单（SBOM）并识别 CVE。

用户可以通过修改 build.sh 脚本中的参数来自定义构建过程。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 和 profile/ 目录下，以下是主要的配置文件：

• sys-build.defaults: 包含了默认的系统构建配置，如分区布局、文件系统类型等。
• config/*.yaml: 包含了设备的根文件系统配置，定义了顶层属性和磁盘镜像配置标识符。
• profile/*.yaml: 包含了设备的 YAML 层，这些层定义了要安装的包列表以及要在 chroot 环境中执行的操作。

用户可以通过编辑这些配置文件来定制自己的 Raspberry Pi 镜像。例如，可以添加或删除包，定义特定的 chroot 操作，或修改磁盘分区布局。