O que é rpi-image-gen?

rpi-image-gen é uma estrutura leve e com script para gerar imagens baseadas em Raspberry Pi OSpara a geração de imagens baseadas em -. Ele usa um sistema de arquivos raiz básico (Raspberry Pi OS Lite ou Full) e aplica personalizações em camadas para produzir um arquivo .img pronto para o flash.

Em essência, é um fluxo de trabalho dd reproduzível, automatizado, com controle de versão e altamente configurável.

Por que usá-lo?

Diferente de Yocto ou Buildroot, rpi-image-gen não reconstrói pacotes a partir do código-fonte. Em vez disso, ele aproveita os pacotes binários do Debian e a infraestrutura existente do Raspberry Pi existente. Isso permite que o senhor:

  • Adicionar arquivos de configuração, serviços e usuários
  • Ativar ou desativar unidades do systemd
  • Pré-instalar aplicativos e dependências
  • Incorporar chaves SSH, credenciais Wi-Fi e IDs de dispositivos

É a maneira mais rápida de passar do protótipo à produção, mantendo controle total sobre a configuração do sistema.

Conceitos básicos

Um projeto típico rpi-image-gen consiste nos seguintes componentes:

  • Imagem base - a imagem oficial Raspberry Pi OS Lite
  • Diretório de sobreposição - seus arquivos, serviços e scripts adicionais
  • Ganchos de personalização - scripts de injeção pré e pós-sistema de arquivos
  • Configuração de compilação - definição de rootfs, partições de inicialização, layout e tags de versão

rpi-image-gen esquema

Juntos, esses elementos produzem uma imagem consistente e inicializável que está pronta para o provisionamento.

Instalação

Siga as instruções de instalação em https://github.com/raspberrypi/rpi-image-gen.

Exemplo

Um projeto típico pode ser assim:

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

Os arquivos mais importantes são os arquivos de configuração YAML, que definem quais pacotes, arquivos e configurações estão incluídos na imagem gerada.

Exemplo de configuração

config/deb12-cm5-min-desktop.yaml - define parâmetros globais, como nome do host, credenciais de usuário, tamanhos de partição e chaves 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 - lista os pacotes de software, os arquivos de configuração e as adições personalizadas, como um aplicativo 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 obter um exemplo de trabalho completo, consulte: https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

Comando de construção

Para criar a imagem, execute:

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

CI/CD e reprodutibilidade

Quando os scripts de compilação forem determinísticos, o senhor poderá integrar rpi-image-gen em um pipeline de CI/CD (por exemplo, GitHub Actions, GitLab CI, Jenkins).

Cada compilação produz um artefato rastreável e com controle de versão, permitindo atualizações confiáveis e depuração mais fácil - uma etapa crucial para a implementação em nível de produção.

Artigos desta série

Fontes