Was ist rpi-image-gen?

rpi-image-gen ist ein leichtgewichtiges, skriptfähiges Framework zur Erzeugung von Raspberry Pi OS-basierten Images. Es nimmt ein Basis-Root-Dateisystem (Raspberry Pi OS Lite oder Full) und wendet mehrschichtige Anpassungen an, um eine flashfertige .img-Datei zu erzeugen.

Im Wesentlichen ist es ein reproduzierbarer dd-Workflow - automatisiert, versionskontrolliert und hochgradig konfigurierbar.

Warum verwenden Sie es?

Anders als Yocto oder Buildroot, rpi-image-gen werden die Pakete nicht aus den Quellen neu erstellt. Stattdessen nutzt es die Binärpakete von Debian und die bestehende Raspberry Pi Infrastruktur. Dies ermöglicht Ihnen:

  • Konfigurationsdateien, Dienste und Benutzer hinzufügen
  • systemd-Einheiten zu aktivieren oder zu deaktivieren
  • Anwendungen und Abhängigkeiten vorinstallieren
  • SSH-Schlüssel, Wi-Fi-Anmeldedaten und Geräte-IDs einbetten

Das ist der schnellste Weg, um vom Prototyp zur Produktion zu gelangen und dabei die volle Kontrolle über Ihr System-Setup zu behalten.

Zentrale Konzepte

Ein typisches rpi-image-gen Projekt besteht aus den folgenden Komponenten:

  • Basis-Image - das offizielle Raspberry Pi OS Lite
  • Overlay-Verzeichnis - Ihre zusätzlichen Dateien, Dienste und Skripte
  • Anpassungshaken - Skripte zur Injektion in das Dateisystem vor und nach der Installation
  • Build-Konfiguration - Definition von Rootfs, Boot-Partitionen, Layout und Versions-Tags

rpi-image-gen Schema

Zusammen erzeugen diese Elemente ein konsistentes, bootfähiges Image, das für die Bereitstellung bereit ist.

Installation

Folgen Sie den Installationsanweisungen unter https://github.com/raspberrypi/rpi-image-gen.

Beispiel

Ein typisches Projekt könnte wie folgt aussehen:

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

Die wichtigsten Dateien sind die YAML-Konfigurationsdateien - sie legen fest, welche Pakete, Dateien und Einstellungen in das generierte Image aufgenommen werden.

Beispiel für eine Konfiguration

config/deb12-cm5-min-desktop.yaml - definiert globale Parameter wie Hostname, Benutzeranmeldedaten, Partitionsgrößen und SSH-Schlüssel:

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 - listet die Softwarepakete, Konfigurationsdateien und benutzerdefinierte Ergänzungen, wie z.B. eine Qt-Anwendung, auf:

# 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"

Ein vollständiges Arbeitsbeispiel finden Sie unter: https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

Build-Befehl

Um das Image zu erstellen, führen Sie aus:

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

CI/CD und Reproduzierbarkeit

Sobald Ihre Build-Skripte deterministisch sind, können Sie sie rpi-image-gen in eine CI/CD-Pipeline integrieren (z.B. GitHub Actions, GitLab CI, Jenkins).

Jeder Build erzeugt ein nachvollziehbares, versioniertes Artefakt, das zuverlässige Aktualisierungen und eine einfachere Fehlersuche ermöglicht - ein entscheidender Schritt auf dem Weg zu einer produktionsgerechten Bereitstellung.

Artikel in dieser Serie

Quellen