Wat is rpi-image-gen?

rpi-image-gen is een lichtgewicht, scriptbaar framework voor het genereren van Raspberry Pi OS-gebaseerde afbeeldingen. Het neemt een basis rootbestandssysteem (Raspberry Pi OS Lite of Full) en past gelaagde aanpassingen toe om een ready-to-flash .img-bestand te produceren.

In essentie is het een reproduceerbare dd workflow - geautomatiseerd, versie-gecontroleerd en zeer configureerbaar.

Waarom gebruiken?

In tegenstelling tot Yocto of Buildroot, rpi-image-gen bouwt het geen pakketten vanaf de broncode. In plaats daarvan maakt het gebruik van de binaire pakketten van Debian en de bestaande Raspberry Pi infrastructuur. Hierdoor kunt u:

  • Configuratiebestanden, services en gebruikers toevoegen
  • Systemd-eenheden in- of uitschakelen
  • Toepassingen en afhankelijkheden vooraf installeren
  • SSH-sleutels, Wi-Fi-referenties en apparaat-ID's insluiten

Het is de snelste manier om van prototype naar productie te gaan, terwijl u volledige controle houdt over uw systeeminstellingen.

Kernbegrippen

Een typisch rpi-image-gen project bestaat uit de volgende onderdelen:

  • Basisimage - de officiële Raspberry Pi OS Lite
  • Overlay directory - uw extra bestanden, services en scripts
  • Aanpassingshaken - scripts voor en na het injecteren van het bestandssysteem
  • Bouwconfiguratie - definiëren van rootfs, opstartpartities, lay-out en versiemarkeringen

rpi-image-gen schema

Samen produceren deze elementen een consistente, bootable image die klaar is voor provisioning.

Installatie

Volg de installatie-instructies op https://github.com/raspberrypi/rpi-image-gen.

Voorbeeld

Een typisch project kan er als volgt uitzien:

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

De belangrijkste bestanden zijn de YAML-configuratiebestanden - deze definiëren welke pakketten, bestanden en instellingen worden opgenomen in de gegenereerde image.

Configuratie Voorbeeld

config/deb12-cm5-min-desktop.yaml - definieert globale parameters zoals hostnaam, gebruikersgegevens, partitiegroottes en SSH-sleutels:

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 - somt de softwarepakketten, configuratiebestanden en aangepaste toevoegingen op, zoals een Qt-toepassing:

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

Voor een compleet werkend voorbeeld, zie: https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

Opdracht bouwen

Voer het volgende uit om de image te bouwen:

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

CI/CD en reproduceerbaarheid

Zodra uw buildscripts deterministisch zijn, kunt u ze integreren rpi-image-gen in een CI/CD-pijplijn (bijv. GitHub Actions, GitLab CI, Jenkins).

Elke build produceert een traceerbaar artefact onder versiebeheer, wat betrouwbare updates en eenvoudiger debuggen mogelijk maakt - een cruciale stap in de richting van productiekwaliteit.

Artikelen in deze serie

Bronnen