Kaj je rpi-image-gen?

rpi-image-gen je lahkotno, skriptno ogrodje za generiranje Raspberry Pi OSslike, ki temeljijo na -. Za osnovni korenski datotečni sistem (Raspberry Pi OS Lite ali Full) in uporabi večplastne prilagoditve, da ustvari datoteko .img, ki je pripravljena za flash.

V bistvu gre za ponovljiv delovni postopek dd - avtomatiziran, nadzorovan z različicami in zelo prilagodljiv.

Zakaj ga uporabljati?

Za razliko od spletne strani Yocto ali Buildroot, rpi-image-gen ne obnovi paketov iz izvorne kode. Namesto tega uporablja binarne pakete Debiana in obstoječe Raspberry Pi infrastrukturo. To vam omogoča, da:

  • dodajanje konfiguracijskih datotek, storitev in uporabnikov
  • Omogočite ali onemogočite enote systemd
  • predhodno namestitev aplikacij in odvisnosti
  • vgraditi ključe SSH, poverilnice Wi-Fi in ID-je naprav

To je najhitrejši način za prehod od prototipa do proizvodnje, pri čemer ohranite popoln nadzor nad nastavitvami sistema.

Osnovni koncepti

Tipičen rpi-image-gen Projekt je sestavljen iz naslednjih delov:

  • Osnovna slika - uradna Raspberry Pi OS Lite
  • Prekrivni imenik - vaše dodatne datoteke, storitve in skripte
  • kavlji za prilagajanje - skripte pred in po vbrizganju datotečnega sistema
  • Konfiguracija za sestavljanje - opredelitev korenskih diskov, zagonskih razdelkov, postavitve in oznak različic

rpi-image-gen shema

Ti elementi skupaj ustvarijo dosledno zagonsko sliko, ki je pripravljena za zagotavljanje.

Namestitev

Sledite navodilom za namestitev na spletnem mestu https://github.com/raspberrypi/rpi-image-gen.

Primer

Tipičen projekt je lahko videti takole:

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

Najpomembnejše datoteke so konfiguracijske datoteke YAML - te določajo, kateri paketi, datoteke in nastavitve so vključeni v ustvarjeno sliko.

Primer konfiguracije

config/deb12-cm5-min-desktop.yaml - določa globalne parametre, kot so ime gostitelja, poverilnice uporabnika, velikosti razdelkov in ključi 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 - vsebuje seznam programskih paketov, konfiguracijskih datotek in dodatkov po meri, kot je aplikacija 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"

Za celoten delujoč primer glejte: https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

Ukaz za izdelavo

Če želite ustvariti sliko, zaženite:

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

CI/CD in ponovljivost

Ko so skripte za sestavljanje deterministične, lahko vključite rpi-image-gen v cevovod CI/CD (npr. GitHub Actions, GitLab CI, Jenkins).

Vsaka sestava ustvari sledljiv artefakt z različicami, kar omogoča zanesljive posodobitve in lažje odpravljanje napak - kar je ključni korak na poti do uporabe v produkcijskem okolju.

Članki v tej seriji

Viri