何ですか？ rpi-image-gen?

rpi-image-genを生成するための軽量でスクリプト可能なフレームワークです。 Raspberry Pi OS-ベースのイメージを生成するための軽量でスクリプト可能なフレームワークです。ベースとなるルートファイルシステム (Raspberry Pi OSLiteまたはFull)を受け取り、レイヤーのカスタマイズを適用して、すぐにフラッシュできる.imgファイルを生成します。

要するに、再現可能な dd ワークフローであり、自動化され、バージョン管理され、高度に設定可能です。

なぜ使うのですか？

とは異なり Yoctoまたは Buildroot, rpi-image-genとは異なり、ソースからパッケージを再構築しません。代わりに、Debian のバイナリパッケージと既存の Raspberry Piインフラストラクチャを利用します。これにより、以下のことが可能になります：

  • 設定ファイル、サービス、ユーザの追加
  • systemd ユニットの有効化、無効化
  • アプリケーションと依存関係のプリインストール
  • SSH キー、Wi-Fi 認証情報、デバイス ID の埋め込み

システムのセットアップを完全にコントロールしながら、プロトタイプから本番環境に移行する最速の方法です。

コアコンセプト

典型的な rpi-image-genプロジェクトは以下のコンポーネントで構成されます：

  • ベースイメージ - 公式 Raspberry Pi OSLite
  • オーバーレイディレクトリ - 追加ファイル、サービス、スクリプト
  • カスタマイズフック - ファイルシステム注入前後のスクリプト
  • ビルド設定 - rootfs、ブートパーティション、レイアウト、バージョンタグの定義

rpi-image-gen計画

これらの要素を組み合わせて、プロビジョニングの準備が整った一貫性のあるブート可能なイメージを作成します。

インストール

以下のインストール手順に従ってください。 https://github.com/raspberrypi/rpi-image-gen.

例

典型的なプロジェクトは次のようなものです：

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

もっとも重要なファイルはYAML設定ファイルです。これらのファイルは生成されるイメージに含まれるパッケージ、ファイル、設定を定義します。

設定例

config/deb12-cm5-min-desktop.yaml - ホスト名、ユーザー認証情報、パーティションサイズ、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 - ソフトウェアパッケージ、設定ファイル、および 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"

完全な動作例については https://github.com/interelectronix/rpi-image-gen-projects/tree/main/deb12-cm5-min-desktop

ビルドコマンド

イメージを構築するには

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

CI/CDと再現性

ビルドスクリプトが決定論的であれば、CI/CDパイプラインに統合できます。 rpi-image-genをCI/CDパイプラインに統合することができます(例:GitHub Actions,GitLab CI,Jenkins)。

各ビルドは、追跡可能でバージョン管理された成果物を生成し、信頼性の高い更新と容易なデバッグを可能にします。

このシリーズの記事

情報源