¿Qué es rpi-image-gen?

rpi-image-gen es un marco ligero y programable para generar Raspberry Pi OS-imágenes. Toma un sistema de archivos raíz base (Raspberry Pi OS Lite o Full) y aplica personalizaciones por capas para producir un archivo .img listo para flashear.

En esencia, es un flujo de trabajo dd reproducible - automatizado, controlado por versiones y altamente configurable.

¿Por qué utilizarlo?

A diferencia de Yocto o Buildroot, rpi-image-gen no reconstruye los paquetes desde el código fuente. En su lugar, aprovecha los paquetes binarios de Debian y la Raspberry Pi existente. Esto le permite

  • Añadir archivos de configuración, servicios y usuarios
  • Activar o desactivar unidades systemd
  • Preinstalar aplicaciones y dependencias
  • Incrustar claves SSH, credenciales Wi-Fi e ID de dispositivos

Es la forma más rápida de pasar del prototipo a la producción, manteniendo un control total sobre la configuración de su sistema.

Conceptos básicos

Un rpi-image-gen proyecto consta de los siguientes componentes:

  • Imagen base - la oficial Raspberry Pi OS Lite
  • Directorio superpuesto - sus archivos, servicios y scripts adicionales
  • Ganchos de personalización - scripts de inyección previos y posteriores al sistema de archivos
  • Configuración de compilación - definición de rootfs, particiones de arranque, disposición y etiquetas de versión

rpi-image-gen esquema

Juntos, estos elementos producen una imagen de arranque consistente y lista para el aprovisionamiento.

Instalación

Siga las instrucciones de instalación en https://github.com/raspberrypi/rpi-image-gen.

Ejemplo

Un proyecto típico podría tener este aspecto:

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

Los archivos más importantes son los archivos de configuración YAML - éstos definen qué paquetes, archivos y configuraciones se incluyen en la imagen generada.

Ejemplo de configuración

config/deb12-cm5-min-desktop.yaml - define parámetros globales como el nombre de host, las credenciales de usuario, el tamaño de las particiones y las claves 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 - enumera los paquetes de software, los archivos de configuración y los añadidos personalizados, como una aplicación 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"

Para ver un ejemplo de trabajo completo, consulte: https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

Comando de construcción

Para construir la imagen, ejecute

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

CI/CD y reproducibilidad

Una vez que sus scripts de compilación sean deterministas, podrá integrarlos rpi-image-gen en una canalización CI/CD (por ejemplo, GitHub Actions, GitLab CI, Jenkins).

Cada compilación produce un artefacto rastreable y versionado, lo que permite actualizaciones fiables y una depuración más sencilla, un paso crucial hacia el despliegue en producción.

Artículos de esta serie

Fuentes