dtoro
d4d99a7473
Problem: the hexagonal refactor churns the backend tree for nine more phases; the UI delivery stack (web/ SPA, cmd/desktop Wails wrapper, compose/web image) must move to its own repo first so doc/layout rewrites land once on a backend-only tree. Change: - New repo git.hubris.network/dtoro/oikos-web (v0.33.0): web/, desktop/ (updateURL repointed to oikos-web releases), compose/, own CI (web + desktop jobs), own deploy script (CI-green gate, TOCTOU guard, version-tagged images, prune-to-3), own webhook receiver on :9798 + launchd unit, own compose project publishing the same 8091:80. - Cutover executed on mac-mini in order: oikos stack's web service stopped+removed, oikos-web project brought up on 8091; outer Caddy untouched (targets the published port) — serving + Authentik flow + /wails 404 quirk verified post-cutover. - Stripped from oikos: web/, cmd/desktop/, compose/web/, desktop CI workflow, ci.yml web job, Makefile ui/desktop/desktop-package/install targets, the compose web service, oikos-web from deploy.sh's fallback prune list; wails + go-keyring dropped from go.mod, vendor synced. - README / CONTRIBUTING / AGENTS.md / .agents dev+operations docs now point at the new repo; mbse + mascot design docs carry a path note. Risk: production SPA serving depends on the new pipeline now; rollback is versioned-image re-up of the old web service from a pre-split checkout (port 8091). Desktop builds installed before the split still check dtoro/oikos releases — one manual reinstall, noted in the oikos-web release notes. Verification: go vet, make test (race), make generate-check, golangci (no new findings; baseline down 400→365); post-cutover curls — localhost:8091 200, /wails/runtime.js 404, outer Caddy 302 Authentik.
161 lines
6.6 KiB
Markdown
161 lines
6.6 KiB
Markdown
# Oikos
|
|
|
|
Agentic homelab operating system written in Go. Single binary (`cmd/oikos`),
|
|
Docker-deployed on mac-mini, with a standalone Nomos MCP agent gateway
|
|
(`cmd/nomos`). 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).
|
|
**For client machines:** see [CLIENTS.md](CLIENTS.md).
|
|
**For developers:** see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Dev stack (postgres + api + scheduler). The api/nomos
|
|
# services need a shared token — every route requires a real bearer
|
|
# credential, there's no dev-open bypass.
|
|
OIKOS_MCP_BEARER_TOKEN=dev-token docker compose --profile dev up -d
|
|
|
|
# Full stack (adds Nomos agent gateway)
|
|
OIKOS_MCP_BEARER_TOKEN=dev-token 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" \
|
|
OIKOS_API_TOKEN=dev-token \
|
|
go run ./cmd/oikos all
|
|
|
|
# Control-room SPA + desktop app: own repo — dtoro/oikos-web
|
|
# (~/Projects/oikos-web; cd web && OIKOS_API_TOKEN=dev-token npm run dev)
|
|
```
|
|
|
|
## Architecture
|
|
|
|
```
|
|
┌──────────────────────────────────┐
|
|
│ mac-mini (Docker) │
|
|
│ │
|
|
Workstation ─── │ nomos (8092) ──MCP── api (8090) │
|
|
(mesh) │ MCP gateway REST + MCP │
|
|
│ │
|
|
│ scheduler ─── postgres │
|
|
│ (observe) (Timescale) │
|
|
└──────────────────────────────────┘
|
|
```
|
|
|
|
| Component | Port | Role |
|
|
|-----------|------|------|
|
|
| `oikos api` | 8090 | REST API + MCP server (tool list in [AGENTS.md §3](AGENTS.md#3-the-mcp-server)) |
|
|
| `oikos scheduler` | — | Probe runner, signal lifecycle, metrics |
|
|
| `nomos 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 |
|
|
| 4 — Nomos 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/done/2026-07-06-consolidate-oikos-control-plane-onto-mac-mini.md](plans/done/2026-07-06-consolidate-oikos-control-plane-onto-mac-mini.md).
|
|
|
|
## Operations
|
|
|
|
### API endpoints
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer $OIKOS_API_TOKEN" \
|
|
http://localhost:8090/api/v1/entities?type=service # fleet
|
|
curl -H "Authorization: Bearer $OIKOS_API_TOKEN" \
|
|
http://localhost:8090/api/v1/health # fleet health
|
|
curl -H "Authorization: Bearer $OIKOS_API_TOKEN" \
|
|
http://localhost:8090/api/v1/agent-activity # agent log
|
|
```
|
|
|
|
### Nomos 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 all # all roles in one process
|
|
oikos secret list # enumerate SOPS secrets
|
|
oikos secret migrate # SOPS → Infisical
|
|
```
|
|
|
|
### Web UI
|
|
|
|
The control-room SPA and the Wails desktop wrapper live in their own repo,
|
|
[dtoro/oikos-web](https://git.hubris.network/dtoro/oikos-web) (local
|
|
checkout `~/Projects/oikos-web`) — extracted in Phase 1 of
|
|
[plans/2026-08-15-hexagonal-architecture.md](plans/2026-08-15-hexagonal-architecture.md).
|
|
The SPA talks to `api`/`nomos` over HTTP with a bearer token entered on
|
|
first launch. It deploys as its own compose project publishing `8091:80`;
|
|
the outer Caddy (LXC 121) targets that published port, so serving and auth
|
|
are unchanged from the pre-split stack.
|
|
|
|
## Repo layout
|
|
|
|
```
|
|
cmd/oikos/ Go entry point — single binary
|
|
cmd/nomos/ Nomos MCP client gateway
|
|
cmd/webhook/ Gitea deploy-webhook receiver (push-to-deploy on mac-mini)
|
|
internal/ Go packages (actuator, checkdefaults, config, core, db,
|
|
domain, httpapi, knowledge, learning, mcp, observability,
|
|
ontology, policy, safego, scheduler, secrets)
|
|
api/openapi.yaml API contract (OpenAPI 3.1)
|
|
migrations/ Forward-only SQL migrations (TimescaleDB)
|
|
seeds/ Bootstrap YAML (ontology, inventory, policy, knowledge)
|
|
compose/ Dockerfiles + Caddy config
|
|
scripts/ Deploy, watchdog, verification, rollback
|
|
checks/ Host health-check scripts run over SSH by the scheduler
|
|
tools/ Client auto-setup scripts (checks)
|
|
ssh/ Deploy keys + authorized_keys management
|
|
vps/ Caddy/TURN config templates for the netbird VPS
|
|
nomos/ Nomos config, persona, skills
|
|
.agents/ Agent instruction files, shared conventions, skills
|
|
archive/ Historical reference (legacy wiki, plans, SOPS backups)
|
|
plans/ Design documents (active + done)
|
|
docs/adr/ Architecture decision records
|
|
docs/operations/ Runbooks (rollback, etc.)
|
|
```
|
|
|
|
## For agents
|
|
|
|
See [AGENTS.md](AGENTS.md) for the full orientation. Quick reference:
|
|
|
|
- **Source of truth:** DB (runtime) then seeds (bootstrap). Old wiki is
|
|
archived at `archive/knowledge/` — use MCP `search_knowledge` instead.
|
|
- **Mutations:** classify against policy, request approval for
|
|
`destructive`/`config_mutation`
|
|
- **Secrets:** Infisical (primary) or SOPS (fallback) — never hardcode
|
|
|
|
## Related
|
|
|
|
- [OIKOS.md](.agents/OIKOS.md) — operating model, OODA loop, ontology
|
|
- [CLIENTS.md](CLIENTS.md) — client onboarding guide
|
|
- [CONTRIBUTING.md](CONTRIBUTING.md) — developer guide
|
|
- [plans/](plans/) — design documents and cutover checklist
|
|
- [docs/adr/](docs/adr/) — architecture decision records
|