README: add Quick run block, demo GIF, rationale and gallery; add terminal renderer script

2026-10-03 01:26:09 -04:00
parent 04620af37e
commit 3fcd4b9c6f
5 changed files with 132 additions and 0 deletions
@@ -4,6 +4,34 @@

 A powerful server drive mapping tool that generates visual ASCII representations of server layouts and provides comprehensive drive information. Maps physical drive bays to logical Linux device names using PCI bus paths for reliable, persistent identification.

+![driveAtlas mapping the drive bays of a 4U server](docs/img/demo.gif)
+
+## ⚡ Quick run
+
+```bash
+# Run on any server that has a config below (as root)
+bash <(curl -s https://code.lotusguild.org/LotusGuild/driveAtlas/raw/branch/main/driveAtlas.sh)
+
+# Or with wget
+bash <(wget -qO- https://code.lotusguild.org/LotusGuild/driveAtlas/raw/branch/main/driveAtlas.sh)
+```
+
+## Why this exists
+
+When a drive fails in a 10-bay case with no backplane and no per-bay LEDs, `/dev/sdX` letters tell you nothing about which physical drive to pull, and they change between boots. driveAtlas maps **physical bays to drives using stable PCI paths**, draws the chassis in ASCII, and lists every drive with its serial, SMART status, temperature and Ceph OSD, so you can verify the right drive by **serial number** before touching hardware. Each server has a small per-model configuration describing its layout.
+
+## Gallery
+
+A 4U Sliger case with ten hand-cabled bays: the front elevation, bay-to-device map and the sorted drive table with SMART health (a warning triangle flags drives that need attention, with the reason):
+
+![driveAtlas on compute-storage-01](docs/img/compute-storage-01.png)
+
+A second node with partly populated bays (empty bays show `--`):
+
+![driveAtlas on storage-01](docs/img/storage-01.png)
+
+<sub>Rendered from real command output with `scripts/render_terminal.py`; drive serials and private IPs are masked.</sub>
+
 ## Features

 - 🗺️ **Visual ASCII art maps** showing physical drive bay layouts