Che cos'è rpi-image-gen?

rpi-image-gen è un framework leggero e scrivibile per generare immagini basate su Raspberry Pi OSimmagini basate su -. Prende un filesystem di base (Raspberry Pi OS Lite o Full) e applica personalizzazioni stratificate per produrre un file .img pronto per l'uso.

In sostanza, è un flusso di lavoro dd riproducibile - automatizzato, controllato dalla versione e altamente configurabile.

Perché usarlo?

A differenza Yocto o Buildroot, rpi-image-gen non ricostruisce i pacchetti dal sorgente. Invece, sfrutta i pacchetti binari di Debian e l'infrastruttura esistente. Raspberry Pi infrastruttura esistente. Questo le permette di:

  • Aggiungere file di configurazione, servizi e utenti
  • Abilitare o disabilitare le unità systemd
  • Preinstallare applicazioni e dipendenze
  • Incorporare chiavi SSH, credenziali Wi-Fi e ID del dispositivo

È il modo più rapido per passare dal prototipo alla produzione, mantenendo il pieno controllo sulla configurazione del sistema.

Concetti fondamentali

Un progetto tipico rpi-image-gen è costituito dai seguenti componenti:

  • Immagine di base - l'immagine ufficiale Raspberry Pi OS Lite
  • Directory di sovrapposizione - i suoi file, servizi e script aggiuntivi
  • Ganci di personalizzazione - script di iniezione pre e post-filesystem
  • Configurazione della build - definizione di rootfs, partizioni di avvio, layout e tag di versione

rpi-image-gen schema

Insieme, questi elementi producono un'immagine coerente e avviabile, pronta per il provisioning.

Installazione

Segua le istruzioni per l'installazione su https://github.com/raspberrypi/rpi-image-gen.

Esempio

Un progetto tipico potrebbe apparire come questo:

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

I file più importanti sono i file di configurazione YAML - questi definiscono quali pacchetti, file e impostazioni sono inclusi nell'immagine generata.

Esempio di configurazione

config/deb12-cm5-min-desktop.yaml - definisce i parametri globali come il nome dell'host, le credenziali dell'utente, le dimensioni della partizione e le chiavi 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 - elenca i pacchetti software, i file di configurazione e le aggiunte personalizzate, come un'applicazione 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"

Per un esempio completo di lavoro, veda: https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

Comando di costruzione

Per creare l'immagine, esegua:

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

CI/CD e riproducibilità

Una volta che i suoi script di compilazione sono deterministici, può integrarli rpi-image-gen in una pipeline CI/CD (ad esempio, GitHub Actions, GitLab CI, Jenkins).

Ogni build produce un artefatto tracciabile e versionato, consentendo aggiornamenti affidabili e un debugging più semplice - un passo fondamentale verso la distribuzione di livello produttivo.

Articoli in questa serie

Fonti