2026-09-28 22:06:48 +00:00
|
|
|
# runbook-tutorials
|
|
|
|
|
|
2026-09-29 00:24:05 +02:00
|
|
|
A user interface specialized to present runbook tutorials that with parameters
|
|
|
|
|
can guide through actual IT administration and operation tasks.
|
|
|
|
|
|
|
|
|
|
- **Intent:** `INTENT.md` · **Scope:** `SCOPE.md`
|
2026-09-29 10:49:10 +02:00
|
|
|
- **Pack specification:** `docs/pack-spec.md` (v0.1, runnable) and `docs/pack-spec-v0.2.md` (v0.2: stages, gates, datapoints, actors, modes; validates, not yet runnable). Schemas in `schema/`. UX findings: `docs/ux-review-2026-09-29.md`
|
2026-09-29 00:24:05 +02:00
|
|
|
- **Packs live where the procedure lives:** `runbooks/<pack>/pack.yaml` in the owning repo.
|
2026-09-29 10:36:29 +02:00
|
|
|
Examples: `net-kingdom/runbooks/`, and here `runbooks/example-hello/` and
|
|
|
|
|
`runbooks/showcase-lighthouse/` (a harmless story to try the UI on).
|
2026-09-29 00:24:05 +02:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
python3 -m rtut validate <repo-root> # validate every pack
|
|
|
|
|
python3 -m rtut list <repo-root> # id, engine, exercise status, title
|
|
|
|
|
python3 -m rtut show <pack.yaml> # steps with owners and done-when
|
|
|
|
|
python3 -m rtut render <pack.yaml> <step> -p name=value
|
|
|
|
|
python3 -m rtut launch <pack.yaml> # legacy-command packs: start the existing console
|
2026-09-29 00:45:20 +02:00
|
|
|
python3 -m rtut ui <repo-root> # local web UI on 127.0.0.1:8877: walk a pack, record a run
|
|
|
|
|
python3 -m rtut run new|start|verify|done|finish <pack.yaml> ... # the same run record from the terminal
|
2026-09-29 00:24:05 +02:00
|
|
|
make test
|
|
|
|
|
```
|
|
|
|
|
|
2026-09-29 00:45:20 +02:00
|
|
|
Status: specification, validator, legacy launch, run records with verification and
|
|
|
|
|
exercise-status diff, and a first local web UI work. Terminal walk-through mode and
|
|
|
|
|
the console migration are open (`workplans/`).
|
