coulomb/runbook-tutorials
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A userinterface specialized to present runbook tutorials that with parameters can guide through actual it administration and operation tasks.
87 commits 1 branch 0 tags 1.4 MiB
Find a file
Exact
tegwick f0ea260895
Some checks failed
CI Smoke / host-smoke (push) Successful in 0s
Details
CI Smoke / container-smoke (push) Successful in 1s
Details
Tests / tests (push) Failing after 11s
Details
Work Records / validate (push) Successful in 14s
Details
docs(reuse): establish reviewed NetKingdom security capabilities 
Assistant: codex
Assistant-Model: gpt-6-astra
Assistant-Session: 01a137ca-5c77-7a71-b9ae-23ad9b0b5684
2026-10-14 06:45:11 +02:00
.claude/rules Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
.forgejo/workflows Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02) 2026-09-29 21:32:19 +02:00
attribute-sets Maturity from run history, pack revision digests, attribute sets, projects and templates (RBT-WP-0008) 2026-09-29 12:36:34 +02:00
docs Close the runbook-tutorials workplans: statuses, backlog with qualified tasks, documents refreshed (RBT-WP-0009-T03, T07) 2026-09-29 21:45:24 +02:00
project-templates Maturity from run history, pack revision digests, attribute sets, projects and templates (RBT-WP-0008) 2026-09-29 12:36:34 +02:00
projects Some example work 2026-10-03 01:31:18 +02:00
registry docs(reuse): establish reviewed NetKingdom security capabilities 2026-10-14 06:45:11 +02:00
rtut Evidence export of closed runs and rtut seal (RBT-WP-0009-T04) 2026-09-29 21:35:03 +02:00
runbooks Retire exercise_status: maturity is the only notion; add CLI tests (RBT-WP-0009-T01) 2026-09-29 21:28:56 +02:00
tests Evidence export of closed runs and rtut seal (RBT-WP-0009-T04) 2026-09-29 21:35:03 +02:00
workplans CUST-WP-0075-T03: route human gates to hub decisions 2026-10-03 03:33:36 +02:00
.custodian-brief.md chore(consistency): sync task status from DB [auto] 2026-10-03 03:54:57 +02:00
.gitignore Add run records, step state machine, verification and exercise-status diff (RBT-WP-0003) 2026-09-29 00:43:38 +02:00
.repo-classification.yaml Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
AGENTS.md Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
CLAUDE.md Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
INTENT.md Retire exercise_status: maturity is the only notion; add CLI tests (RBT-WP-0009-T01) 2026-09-29 21:28:56 +02:00
LICENSE Scaffold runbook-tutorials repo: intent, scope, agent rules, State Hub registration 2026-09-29 00:20:46 +02:00
Makefile Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02) 2026-09-29 21:32:19 +02:00
pyproject.toml Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02) 2026-09-29 21:32:19 +02:00
README.md Close the runbook-tutorials workplans: statuses, backlog with qualified tasks, documents refreshed (RBT-WP-0009-T03, T07) 2026-09-29 21:45:24 +02:00
SCOPE.md Close the runbook-tutorials workplans: statuses, backlog with qualified tasks, documents refreshed (RBT-WP-0009-T03, T07) 2026-09-29 21:45:24 +02:00
WORK-RECORDS.md chore: refresh WORK-RECORDS index after CUST-WP-0075-T02 status corrections 2026-10-03 03:14:07 +02:00

README.md

runbook-tutorials

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
  • Documents: docs/README.md (index). Pack specification: docs/pack-spec-v0.2.md (current: stages, gates, datapoints, actors, modes) and docs/pack-spec.md (v0.1, still supported). Schemas in rtut/schema/.
  • Packs live where the procedure lives: runbooks/<pack>/pack.yaml in the owning repo. Examples: net-kingdom/runbooks/, and here runbooks/example-hello/ and runbooks/showcase-lighthouse/ (a harmless story to try the UI on).

Install

Python 3.12 or newer.

make install        # editable install with the test dependencies (pip install -e ".[test]")
make check          # validate every pack, attribute set, project and template
make test           # run the tests

A plain pip install . works too and provides the rtut command; the JSON schemas ship inside the package.

python3 -m rtut validate <repo-root>      # validate every pack
python3 -m rtut list <repo-root>          # id, engine, maturity, 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
python3 -m rtut maturity <pack.yaml>      # draft | reviewed | rehearsed | proven | stale, from run history
python3 -m rtut review <pack.yaml> --by you     # record a review of the current revision
python3 -m rtut project list|validate|status|attrs|new|run <repo-root> ...   # projects, attribute sets, templates
python3 -m rtut ui <repo-root> [<repo-root> ...]   # local web UI on 127.0.0.1:8877: projects, templates, runbooks; v0.1 and v0.2 runs (guided flow, data view, overview)
python3 -m rtut run new|start|verify|done|finalize <pack.yaml> ...   # the same run record from the terminal
make test

Status: see SCOPE.md; the workplans are in workplans/.