Что такое rpi-image-gen?

rpi-image-gen это легкая, скриптовая основа для создания Raspberry Pi OS-основанных изображений. Она берет базовую корневую файловую систему (Raspberry Pi OS Lite или Full) и применяет многоуровневые настройки для создания готового к прошивке файла .img.

По сути, это воспроизводимый рабочий процесс dd - автоматизированный, контролируемый по версиям и очень настраиваемый.

Зачем его использовать?

В отличие от Yocto или Buildroot, rpi-image-gen не собирает пакеты из исходных текстов. Вместо этого он использует бинарные пакеты Debian и существующую Raspberry Pi инфраструктуру. Это позволяет Вам:

  • Добавлять конфигурационные файлы, службы и пользователей
  • Включать или отключать модули systemd
  • Предварительно устанавливать приложения и зависимости
  • Встраивать ключи SSH, учетные данные Wi-Fi и идентификаторы устройств

Это самый быстрый способ перейти от прототипа к производству, сохраняя при этом полный контроль над настройкой Вашей системы.

Основные понятия

Типичный rpi-image-gen Проект состоит из следующих компонентов:

  • Базовый образ - официальный Raspberry Pi OS Lite
  • Каталог Overlay - Ваши дополнительные файлы, сервисы и скрипты
  • Скрипты кастомизации - скрипты до и после внедрения в файловую систему
  • Конфигурация сборки - определение корневых файлов, загрузочных разделов, компоновки и меток версий

rpi-image-gen схема

Все вместе эти элементы создают последовательный загрузочный образ, готовый к предоставлению.

Установка

Следуйте инструкциям по установке на сайте https://github.com/raspberrypi/rpi-image-gen.

Пример

Типичный проект может выглядеть следующим образом:

deb12-cm5-min-desktop
├── README.md
├── config
│   └── deb12-cm5-min-desktop.yaml
├── device
│   ├── cm5-device.yaml
│   └── rootfs-overlay
│       ├── etc
│       │   ├── lightdm
│       │   └── skel
│       └── usr
│           └── local
└── layer
    ├── image
    │   └── simple-dual-nosparse
    │       ├── bdebstrap
    │       ├── device
    │       ├── genimage.cfg.in.btrfs
    │       ├── genimage.cfg.in.ext4
    │       ├── image.yaml
    │       ├── mke2fs.conf
    │       ├── pre-image.sh
    │       └── setup.sh
    └── packages.yaml

Наиболее важными файлами являются файлы конфигурации YAML - они определяют, какие пакеты, файлы и настройки будут включены в сгенерированный образ.

Пример конфигурации

config/deb12-cm5-min-desktop.yaml - определяет глобальные параметры, такие как имя хоста, учетные данные пользователя, размеры разделов и ключи SSH:

device:
  layer: cm5-device
  hostname: cm5-dev
  user1: pi
  user1pass: StrongPass!1

image:
  layer: image-rpios-nosparse
  rootfs_type: ext4
  boot_part_size: 512M
  root_part_size: 4G
  compression: zstd
  name: deb12-cm5-min-desktop

layer:
  custom: base-packages

ssh:
  pubkey_user1: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB"   # your custom public key
  pubkey_only: y

layer/packages.yaml - перечисляет пакеты программного обеспечения, конфигурационные файлы и пользовательские дополнения, например, приложение Qt:

# METABEGIN
# X-Env-Layer-Name: base-packages
# X-Env-Layer-Desc: Installs base packages
#  for sw development.
# X-Env-Layer-Version: 1.0.0
# X-Env-Layer-Requires: debian-bookworm-arm64-multi,
#  rpi-debian-bookworm,
#  rpi-misc-utils,
#  rpi-essential-base,
#  rpi-misc-skel,
#  rpi-user-credentials,
#  systemd-net-min,
#  fake-hwclock,
#  openssh-server
# METAEND
---
mmdebstrap:
  setup-hooks:
    - echo "hello - no setup-hooks in base-packages"
  packages:
    # Firmware to enable SHIFT boot manager and EEPROM maintenance
    - raspberrypi-bootloader
    - rpi-eeprom
    - raspberrypi-ui-mods
    - lightdm
    - lightdm-gtk-greeter
    - labwc
    - wf-panel-pi
    - lxsession
    - lxpanel
    - pcmanfm
    - lxterminal
    - gvfs
    - xserver-xorg
    - xwayland
    - wayland-utils
    - wlr-randr
    - x11-xserver-utils
    - xdg-user-dirs
    - xdg-utils
    - policykit-1
    # helper and utilities
    - bash
    - sudo
    - vim-tiny
    - less
    - nano
    - network-manager
    - bash-completion
    # library manager
    - libinput10
    - libinput-bin
    - libinput-dev
    # sqlite
    - sqlite3
    - libsqlite3-0
    - libsqlite3-dev
  customize-hooks:
    - echo "hello - customize-hooks in base-packages"
    - $BDEBSTRAP_HOOKS/enable-units "$1" lightdm
    - sed "s|alias ls='ls --color=auto'|alias ll='ls -al --color=auto'|" /home/$IGconf_device_user1/.bashrc > $1/home/$IGconf_device_user1/.bashrc
    - uchroot $1 'mkdir -m 0700 -p ${HOME}/.config/labwc'
    - cp "${IGconf_device_assetdir}/rootfs-overlay/etc/skel/.config/labwc/autostart" "$1/home/$IGconf_device_user1/.config/labwc/autostart"
    - cp "${IGconf_device_assetdir}/rootfs-overlay/etc/skel/.config/labwc/environment" "$1/home/$IGconf_device_user1/.config/labwc/environment"
    - cp "${IGconf_device_assetdir}/rootfs-overlay/etc/skel/.config/labwc/rc.xml" "$1/home/$IGconf_device_user1/.config/labwc/rc.xml"
    - chown "${IGconf_device_user1}:${IGconf_device_user1}" "$1/home/$IGconf_device_user1/.config/labwc/autostart"
    - chown "${IGconf_device_user1}:${IGconf_device_user1}" "$1/home/$IGconf_device_user1/.config/labwc/environment"
    - chown "${IGconf_device_user1}:${IGconf_device_user1}" "$1/home/$IGconf_device_user1/.config/labwc/rc.xml"

Полный рабочий пример см: https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

Команда Build

Чтобы создать образ, выполните команду:

rpi-image-gen build -S path-to-project-folder -c deb12-cm5-min-desktop.yaml

CI/CD и воспроизводимость

Когда Ваши сценарии сборки станут детерминированными, Вы сможете интегрировать их rpi-image-gen в конвейер CI/CD (например, GitHub Actions, GitLab CI, Jenkins).

Каждая сборка создает отслеживаемый, версионированный артефакт, что обеспечивает надежные обновления и облегчает отладку - важнейший шаг на пути к развертыванию производственного уровня.

Статьи из этой серии

Источники