dtoro
c9fb5fe553
- Rewrote README from 'living documentation' to 'Oikos — agentic homelab operating system written in Go.' - Added quick start, architecture diagram, component ports table. - Added Phase 1-6 status table with checkmarks. - Added API usage examples, Hermes query examples, CLI reference. - Added repo layout table. - Note: Gitea repo path (dtoro/Homelab-Docs → dtoro/oikos) requires Gitea UI rename — references in oikos/cards/, bootstrap.sh, and deploy scripts will need updating after the rename.
130 lines
4.9 KiB
Markdown
130 lines
4.9 KiB
Markdown
# Oikos
|
|
|
|
Agentic homelab operating system written in Go. Single binary (`cmd/oikos`),
|
|
Docker-deployed on mac-mini, with a standalone Hermes MCP agent gateway
|
|
(`cmd/hermes`). Manages the **hubris** Proxmox homelab autonomously — observes
|
|
state, classifies actions against policy, executes approved procedures over SSH,
|
|
learns from outcomes, and escalates when uncertain.
|
|
|
|
**For agents running on enrolled clients:** start with [AGENTS.md](AGENTS.md).
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Dev stack (postgres + api + scheduler + notifier)
|
|
docker compose --profile dev up -d
|
|
|
|
# Full stack (adds Hermes agent gateway)
|
|
docker compose --profile full up -d
|
|
|
|
# Build standalone binary
|
|
go build -o bin/oikos -tags timetzdata ./cmd/oikos
|
|
|
|
# Run all roles in one process (dev mode)
|
|
OIKOS_DATABASE_URL="postgres://oikos:oikos_dev@localhost:5432/oikos?sslmode=disable" \
|
|
go run ./cmd/oikos all
|
|
```
|
|
|
|
## Architecture
|
|
|
|
```
|
|
┌──────────────────────────────────┐
|
|
│ mac-mini (Docker) │
|
|
│ │
|
|
Workstation ─── │ hermes (8092) ──MCP── api (8090) │
|
|
(mesh) │ MCP gateway REST + MCP │
|
|
│ │
|
|
│ scheduler ── notifier ── postgres │
|
|
│ (observe) (Matrix) (Timescale)│
|
|
└──────────────────────────────────┘
|
|
```
|
|
|
|
| Component | Port | Role |
|
|
|-----------|------|------|
|
|
| `oikos api` | 8090 | REST API + MCP server (15 tools) |
|
|
| `oikos scheduler` | — | Probe runner, signal lifecycle, metrics |
|
|
| `oikos notifier` | — | Approval tokens, Matrix alerts |
|
|
| `hermes serve` | 8092 | MCP client gateway, query routing |
|
|
|
|
## Phases
|
|
|
|
| Phase | Status | Description |
|
|
|-------|--------|-------------|
|
|
| 1 — Ontology + DB | ✅ | TimescaleDB, migrations, seeds, blast_radius |
|
|
| 2 — API | ✅ | OpenAPI-first REST + MCP, auth, SSE, audit |
|
|
| 3 — Control loop | ✅ | Scheduler, actuator, learning, classifier, notifier |
|
|
| 4 — Hermes agent | ✅ | Standalone MCP client gateway, agent activity |
|
|
| 5 — Secrets | ✅ | Infisical backend + SOPS fallback, rotation runbooks |
|
|
| 6 — Deploy | ✅ | CI pipeline, cutover checklist, watchdog, rollback |
|
|
|
|
Full plan: [plans/2026-07-06-consolidate-oikos-control-plane-onto-mac-mini.md](plans/2026-07-06-consolidate-oikos-control-plane-onto-mac-mini.md).
|
|
|
|
## Operations
|
|
|
|
### API endpoints
|
|
|
|
```bash
|
|
curl http://localhost:8090/api/v1/entities?type=service # fleet
|
|
curl http://localhost:8090/api/v1/health # fleet health
|
|
curl http://localhost:8090/api/v1/agent-activity # agent log
|
|
```
|
|
|
|
### Hermes queries
|
|
|
|
```bash
|
|
# Structured tool call
|
|
curl -X POST localhost:8092/query -H "Content-Type: application/json" \
|
|
-d '{"tool":"get_blast_radius","args":{"entity_id":"service:authentik"}}'
|
|
|
|
# Natural language
|
|
curl -X POST localhost:8092/query -H "Content-Type: application/json" \
|
|
-d '{"query":"what depends on authentik?"}'
|
|
```
|
|
|
|
### CLI
|
|
|
|
```bash
|
|
oikos migrate # apply DB migrations
|
|
oikos seed # ingest ontology/inventory/policy seeds
|
|
oikos export # export DB state to YAML
|
|
oikos api # serve REST + MCP
|
|
oikos scheduler # run observe loop
|
|
oikos notifier # run notification loop
|
|
oikos all # all roles in one process
|
|
oikos secret list # enumerate SOPS secrets
|
|
oikos secret migrate # SOPS → Infisical
|
|
```
|
|
|
|
## Repo layout
|
|
|
|
```
|
|
cmd/oikos/ Go entry point — single binary
|
|
cmd/hermes/ Hermes MCP client gateway
|
|
internal/ Go packages (httpapi, mcp, scheduler, actuator, learning,
|
|
notifier, policy, secrets, db, config, ontology, domain)
|
|
api/openapi.yaml API contract (OpenAPI 3.1)
|
|
migrations/ Forward-only SQL migrations (TimescaleDB)
|
|
seeds/ Bootstrap YAML (ontology, inventory, policy)
|
|
compose/ Dockerfiles + Caddy config
|
|
scripts/ Deploy, watchdog, verification, rollback
|
|
hermes/ Hermes config, persona, skills
|
|
knowledge/wiki/ Narrative documentation (containers, hosts, infrastructure)
|
|
.agents/ Agent instruction files + skills
|
|
plans/ Design documents
|
|
```
|
|
|
|
## For agents
|
|
|
|
See [AGENTS.md](AGENTS.md) for the full orientation. Quick reference:
|
|
|
|
- **Source of truth:** DB (runtime) then repo (bootstrap + docs)
|
|
- **Mutations:** classify against policy, request approval for `destructive`/`config_mutation`
|
|
- **Wiki:** files under `knowledge/wiki/`, changelog at bottom of each page
|
|
- **Secrets:** Infisical (primary) or SOPS (fallback) — never hardcode
|
|
|
|
## Related
|
|
|
|
- [OIKOS.md](.agents/OIKOS.md) — operating model, OODA loop, ontology
|
|
- [plans/](plans/) — design documents and cutover checklist
|
|
- [docs/adr/](docs/adr/) — architecture decision records
|