dtoro
5e3b946ded
- Rewrite AGENTS.md: DB as source of truth, MCP knowledge tools, archive refs - Fix OIKOS.md: seeds/ paths, remove Python-era notes, update deployment status - Fix commands.md, agent-enrollment.md: archive/knowledge/ links - Fix all SKILL.md files: remove hosts/*.yaml refs, point to inventory.yaml - Fix HERMES.md, schema.md, page-templates.md, llm-wiki.md: update paths - Fix bootstrap.sh: identity check reads inventory.yaml - Fix README.md, cutover-checklist.md: stale wiki references - Move convert-wiki.py to archive/ (one-shot done)
2.5 KiB
Operations domain — schema
The operations domain holds the procedural and time-stamped documentation: runbooks (repeatable procedures), investigations (incident evidence), and plans (design docs for non-trivial work). It follows writing-style; runbooks and plans use the imperative voice exception.
Where each kind lives: runbooks are skills under .agents/skills/; operator
reference (command cheatsheet, enrollment, Hermes agent) lives in
.agents/operations/; investigations are sources under
knowledge/sources/investigations/; plans stay in the repo-root plans/ folder (below).
Plans always live in plans/
Any plan or design doc for the Homelab is written into the repo plans/ folder as
plans/YYYY-MM-DD-slug.md — never a scratch path, an agent-private plan location, or a chat
message. An agent drafting a plan:
- Writes the file under
plans/using the plan template in page-templates.md. - Lists it in
plans/index.md. - On completion, moves it to
plans/done/and updates the index status.
This is the single source for homelab design intent; keeping it in-repo means the plan is
versioned, reviewable, and reachable by MCP get_page/search_docs like any other doc.
Runbooks
Repeatable procedures are skills — one folder per skill at .agents/skills/<name>/SKILL.md, with
YAML front-matter that the Oikos policy and lifecycle machinery reads:
---
name: <name>
risk_class: read_only | reversible_low | config_mutation | destructive
inputs: [<param>, ...]
verification: "<shell expression that proves success>"
docs_update_checklist: [<doc artifacts to update>]
transition: "<from> -> <to>" # only for lifecycle runbooks
---
risk_class values and the lifecycle transition states must match
seeds/policy.yaml and seeds/ontology.yaml.
Investigations
Incident records live in knowledge/sources/investigations/YYYY-MM-DD-slug.md and are evidence sources — written
once at incident time, then linked from the changelogs of the nodes they implicate. Sections:
## Summary, ## Timeline, ## Root cause, ## Mitigations applied, ## Open questions. Resolved
incidents move to knowledge/sources/investigations/archive/.
The operations log
plans/log.md and knowledge/log.md are append-only records of documentation operations on
those areas (## [YYYY-MM-DD] <op> | <summary>), distinct from the Oikos change ledger.