907dd98b24
Move CI/CD, runner setup, secrets, and project structure to TECHNICAL.md. Streamline README as a user-facing guide with install/upgrade instructions. Fix Docker badges for arm64. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
74 lines
2.9 KiB
Markdown
74 lines
2.9 KiB
Markdown
# Talos CM5 Builder
|
|
|
|
Custom Talos Linux images for Raspberry Pi 5 / CM5 on Compute Blade hardware.
|
|
|
|
[](https://hub.docker.com/r/svrnty/talos-rpi5)
|
|
[](https://hub.docker.com/r/svrnty/talos-rpi5)
|
|
[](https://hub.docker.com/r/svrnty/talos-rpi5)
|
|
|
|
The official Talos Image Factory does not support CM5 — the mainline kernel lacks CM5 device trees and RP1 driver support. This builder uses the RPi downstream kernel (via [talos-rpi5/talos-builder](https://github.com/talos-rpi5/talos-builder) patches) to produce working CM5 images with our extensions and overclock config.
|
|
|
|
## Current versions
|
|
|
|
| Component | Version | |
|
|
|-----------|---------|---|
|
|
| Talos Linux | `v1.12.3` | [](https://hub.docker.com/r/svrnty/talos-rpi5) |
|
|
| RPi Kernel | `6.12.47` | arm64 only |
|
|
| iscsi-tools | `v0.1.6` | |
|
|
| util-linux-tools | `2.40.4` | |
|
|
|
|
## Image tags
|
|
|
|
Release images are published to [`docker.io/svrnty/talos-rpi5`](https://hub.docker.com/r/svrnty/talos-rpi5) with the format:
|
|
|
|
```
|
|
v<talos>-k<kernel>-<revision>
|
|
```
|
|
|
|
For example: `v1.12.3-k6.12.47-2`
|
|
|
|
| Segment | Meaning |
|
|
|---------|---------|
|
|
| `v1.12.3` | Upstream Talos Linux version |
|
|
| `k6.12.47` | RPi downstream kernel version |
|
|
| `2` | Build revision (bumped for config/patch changes on the same upstream versions) |
|
|
|
|
## Usage
|
|
|
|
### Install from raw disk image
|
|
|
|
Download `metal-arm64.raw.zst` from the [latest release](../../releases/latest) and flash to eMMC:
|
|
|
|
```bash
|
|
zstd -d metal-arm64.raw.zst -o metal-arm64.raw
|
|
# Flash to eMMC/SD via your preferred tool (dd, balenaEtcher, etc.)
|
|
```
|
|
|
|
### Upgrade an existing node
|
|
|
|
```bash
|
|
talosctl upgrade --image docker.io/svrnty/talos-rpi5:v1.12.3-k6.12.47-2
|
|
```
|
|
|
|
### What's included
|
|
|
|
- RPi downstream kernel with CM5/RP1 support
|
|
- Overclock: 2.6GHz (`arm_freq=2600`, `over_voltage_delta=50000`, `arm_boost=1`)
|
|
- Extensions: `iscsi-tools`, `util-linux-tools`
|
|
|
|
## Building
|
|
|
|
For local builds, CI/CD setup, runner configuration, and project structure, see [TECHNICAL.md](TECHNICAL.md).
|
|
|
|
## License
|
|
|
|
This project is licensed under the [Mozilla Public License 2.0](LICENSE).
|
|
|
|
It builds upon the following MPL 2.0 licensed upstream projects:
|
|
|
|
- [siderolabs/talos](https://github.com/siderolabs/talos) — Talos Linux OS
|
|
- [siderolabs/pkgs](https://github.com/siderolabs/pkgs) — Talos package definitions
|
|
- [talos-rpi5/sbc-raspberrypi5](https://github.com/talos-rpi5/sbc-raspberrypi5) — Raspberry Pi 5 SBC overlay
|
|
|
|
Our patches to these projects are in the `patches/` directory and are distributed under the same MPL 2.0 terms.
|