Remove obsolete eMMC provisioning scripts and documentation for reTerminal DM4, including udev rules, flash trigger scripts, and related guides.
This commit is contained in:
@@ -1,17 +1,44 @@
|
||||
# reTerminal DM4 eMMC auto-provisioning
|
||||
# reTerminal DM4 eMMC provisioning
|
||||
|
||||
Automatically flash a **golden image** to the CM4 eMMC when the reTerminal is connected in **boot mode** (eMMC disable jumper). Optional **backup** mode saves the current eMMC to a timestamped image file instead. Uses **cloud-init** for first-boot configuration.
|
||||
Automatically **deploy** or **backup** the CM4 eMMC when the reTerminal is connected in **USB boot mode** or when it **boots over the network**. Uses **cloud-init** for first-boot configuration.
|
||||
|
||||
| File | Purpose |
|
||||
|------|--------|
|
||||
| **EMMC-PROVISIONING-GUIDE.md** | Full setup and usage guide – read this first. |
|
||||
| **flash-emmc-on-connect.sh** | Script that runs `rpiboot` then either flashes the golden image to eMMC or backs up eMMC to a file (mode set via dashboard or `mode` file). |
|
||||
| **cm4-flash-trigger.sh** | Called by udev when CM4 in boot mode is connected; starts the flash job. |
|
||||
| **90-cm4-boot-mode.rules** | udev rule: when USB device 2b8e is added, run the trigger script. |
|
||||
| **cloud-init/** | Example NoCloud files (`user-data`, `meta-data`, `network-config`) for the golden image. |
|
||||
| **dashboard/** | Flask web UI: auto-detect device (USB or network), prompt **Backup or Deploy**, show status and connection steps. See **dashboard/README.md**. |
|
||||
| **network-client/** | Script for network-booted devices: register with the dashboard and perform Deploy (pull image, write eMMC) or Backup (upload eMMC). See **network-client/README.md**. |
|
||||
---
|
||||
|
||||
Quick start: see **EMMC-PROVISIONING-GUIDE.md**.
|
||||
## Project layout
|
||||
|
||||
**Proxmox:** LXC 201 + host setup is documented in **PROXMOX-LXC-DEPLOYMENT.md**. Use **scripts/deploy-to-proxmox.sh** to deploy to a Proxmox host; flash runs on the host, golden image is in a bind-mounted dir shared with the LXC.
|
||||
```
|
||||
emmc-provisioning/
|
||||
├── README.md ← You are here
|
||||
├── docs/ Documentation
|
||||
│ ├── EMMC-PROVISIONING-GUIDE.md Full setup and usage
|
||||
│ ├── PROXMOX-LXC-DEPLOYMENT.md Proxmox LXC + host setup
|
||||
│ └── PORTAL_STYLING_GUIDE.md Dashboard UI styling reference
|
||||
├── host/ Scripts that run on the provisioning host (Proxmox host)
|
||||
│ ├── flash-emmc-on-connect.sh rpiboot + wait for Backup/Deploy choice, then dd
|
||||
│ ├── cm4-flash-trigger.sh Called by udev; starts the flash job
|
||||
│ └── 90-cm4-boot-mode.rules udev rule (USB vendor 2b8e)
|
||||
├── scripts/ Deployment and one-off scripts
|
||||
│ ├── deploy-to-proxmox.sh Deploy to Proxmox host + LXC 201
|
||||
│ └── install-usbboot-on-host.sh Build and install rpiboot on the host
|
||||
├── dashboard/ Flask web UI (runs in LXC or standalone)
|
||||
│ ├── app.py
|
||||
│ ├── templates/
|
||||
│ ├── cm4-dashboard.service
|
||||
│ └── README.md
|
||||
├── cloud-init/ Example NoCloud files for the golden image
|
||||
│ ├── user-data
|
||||
│ ├── meta-data
|
||||
│ └── network-config
|
||||
└── network-client/ For network-booted devices
|
||||
├── provisioning-client.sh Register + poll, then Deploy or Backup
|
||||
└── README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
1. **Read** [docs/EMMC-PROVISIONING-GUIDE.md](docs/EMMC-PROVISIONING-GUIDE.md) for setup and usage.
|
||||
2. **Proxmox:** Use [scripts/deploy-to-proxmox.sh](scripts/deploy-to-proxmox.sh) to deploy to a Proxmox host; see [docs/PROXMOX-LXC-DEPLOYMENT.md](docs/PROXMOX-LXC-DEPLOYMENT.md).
|
||||
3. **Manual host:** Copy scripts from `host/` to the host and install the udev rule (see the guide).
|
||||
4. Put **golden.img** in `/var/lib/cm4-provisioning/` (or your configured path). When a device is detected (USB or network), the **dashboard** asks **Backup** or **Deploy**.
|
||||
|
||||
Reference in New Issue
Block a user