Skip to main content

Generate flashable, headless Raspberry Pi images (no setup-alpine, no rpi-imager-pre-fill required)

Project description

pi-bake

Generate flashable, headless Raspberry Pi images. Flash one .img.gz per Pi, boot, SSH in. No setup-alpine interactive walk, no rpi-imager GUI clicking through pre-fill, no console on the Pi.

What gets baked

Per node, from CLI flags or the Python API:

  • Hostname/etc/hostname
  • SSH pubkey/root/.ssh/authorized_keys (mode 0600) + sshd PasswordAuthentication no
  • WiFi creds (optional) → /etc/wpa_supplicant/wpa_supplicant.conf so the Pi auto-joins on first boot. Omit for wired-only.
  • Timezone, regulatory country (sensible defaults)
  • First-boot script that apk adds the small set of packages (openssh-server, iproute2, etc.), enables services, then self-disables.

That's it. No role-specific code, no totaldns, no platform lock-in. Once the Pi is on the network, whatever orchestrator you use (pyinfra, Ansible, plain SSH) takes over.

Install

pip install pi-bake

System tools (one-time per dev machine):

# Fedora
sudo dnf install mtools dosfstools
# Debian / Ubuntu
sudo apt install mtools dosfstools
# Alpine
apk add mtools dosfstools

The Alpine baker uses mtools (no root). The Raspbian baker (v0.2) will additionally need sudo for losetup.

Quick start

# What can we bake for what?
pi-bake list-boards
pi-bake list-os --board pi-zero-2-w

# Bake an Alpine image for a Pi Zero 2 W with WiFi creds.
pi-bake build \
  --board pi-zero-2-w \
  --os alpine \
  --hostname pi-radio-1 \
  --ssh-pubkey ~/.ssh/id_ed25519.pub \
  --wifi-ssid totaldns-lab \
  --wifi-psk secret \
  --out ~/sdcards/pi-radio-1.img.gz

# Flash. Replace mmcblk0 with your SD card's actual device.
zcat ~/sdcards/pi-radio-1.img.gz | sudo dd of=/dev/mmcblk0 bs=4M status=progress

# Boot the Pi. Wait ~30s. Then:
ssh root@pi-radio-1.lan uptime

For wired-only nodes (eth0), omit the WiFi flags:

pi-bake build \
  --board pi-5 --os alpine --hostname boat \
  --ssh-pubkey ~/.ssh/id_ed25519.pub \
  --out ~/sdcards/boat.img.gz

YAML recipes (v0.0.5+)

Operators bake the same image from a YAML recipe. Better for multi-node deployments + version control:

pi-bake build --config ~/recipes/pi-5.yaml

Already have a working CLI invocation? Round-trip it to YAML:

pi-bake build \
  --board pi-5 --os alpine --hostname boat \
  --ssh-pubkey ~/.ssh/id_ed25519.pub \
  --out ~/sdcards/boat.img.gz \
  --to-yaml ~/recipes/boat.yaml \
  --no-bake

--no-bake skips the actual image build — useful when you only want to capture the recipe. Drop it to bake AND save the YAML.

References:

  • pi-bake.example.yaml — annotated reference for every field, dnsmasq-style. Read once, never go hunting for options again.
  • examples/ — minimal, tested recipes for common shapes (wifi-station, wired AP, BE200 host on Alpine edge).

Validate a recipe without baking:

pi-bake build --config recipe.yaml --to-yaml /tmp/normalized.yaml --no-bake

This runs the strict validator (unknown keys are an error) and writes a canonical normalized YAML — surfaces schema errors instantly while you're editing.

Supported boards × OSes

Board Alpine Raspbian Debian
Pi Zero W ✓ (armhf) ✗ (32-bit ARMv6 not packaged)
Pi Zero 2 W ✓ (32-bit ARMv7 / arm64)
Pi 3
Pi 4
Pi 5 ✓ (3.21+)

Run pi-bake list-os --board <b> for the current matrix.

Status

v0.1: Alpine baker is fully working (no-root, mtools). Raspbian

  • Debian backends are stubbed with a clear error pointing at the v0.2 roadmap. Most Pi 4 / Pi 5 deployments bootstrap with rpi-imager's pre-fill flow today — pi-bake will take that over in v0.2.

Python API

The CLI is a thin wrapper around pi_bake.build():

from pi_bake import build, NodeConfig

build(
    board="pi-zero-2-w",
    os_name="alpine",
    version=None,                       # latest known-good
    node=NodeConfig(
        hostname="pi-radio-1",
        ssh_pubkey=open(".../id_ed25519.pub").read(),
        wifi_ssid="totaldns-lab",
        wifi_psk="secret",
    ),
    out_path="~/sdcards/pi-radio-1.img.gz",
)

Roadmap

  • v0.2 — Raspbian + Debian backends. losetup -P + firstrun.sh injection. Needs sudo; CLI prompts honestly.
  • v0.2 — dynamic OS version discovery. Pull https://dl-cdn.alpinelinux.org/alpine/ and the rpi downloads index instead of the hardcoded versions tuples in the catalog.
  • v0.3 — multi-image batch. pi-bake build-many topology.json emits an .img.gz per node entry in one go.
  • v0.3 — static IP option. Today we DHCP from first reachable iface; static-IP-only deployments need a --static-v4 flag.
  • v0.3 — encrypted overlay for the rootfs (LUKS).

Why does this exist

Three reasons to bake images instead of using rpi-imager pre-fill or hand-running setup-alpine:

  1. Per-node config in a script. Topology files (any shape — JSON, YAML, a hand-written shell script) drive pi-bake build in a loop. Lab grows from 1 Pi to 20 without 20 separate keyboard sessions.
  2. Reproducible. Same inputs → same .img.gz. Re-flash a replacement SD card identically; clone a node by changing the hostname.
  3. Alpine RPi has no rpi-imager pre-fill equivalent. This is the only convenient headless flow for the Pi Zero W / 2 W family running Alpine.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_pi_bake-0.2.0.tar.gz (90.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_pi_bake-0.2.0-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

Details for the file py_pi_bake-0.2.0.tar.gz.

File metadata

  • Download URL: py_pi_bake-0.2.0.tar.gz
  • Upload date:
  • Size: 90.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for py_pi_bake-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cd3762e69ead300283e979d21197b0aaa188e1f9f3a385a13f529606bdc48097
MD5 100a3d7a73cc3b7acca205348522e93f
BLAKE2b-256 f54fb41397ce6b8b157ff15ce58c3fb44c267d7fe8a423c8bd96ff47e4778aa3

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_pi_bake-0.2.0.tar.gz:

Publisher: workflow.yml on kurt-cb/pi-bake

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py_pi_bake-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: py_pi_bake-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 43.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for py_pi_bake-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee2d0c6df7b473f2d1e5f22529e3a407491f70655c889fc1b198866b736e3d31
MD5 700359b2d455222feebda13155c7fa5d
BLAKE2b-256 1108ea086eb91c49d13a7b6a07c5123fdfe735a4fb623cf4f142411ff1afff05

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_pi_bake-0.2.0-py3-none-any.whl:

Publisher: workflow.yml on kurt-cb/pi-bake

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page