This directory contains active design documents and architectural research for the Gearbox platform.
-
- Final gear system design
- Architecture for both gearbox-agent and gearbox dashboard
- Core requirements and principles
-
gear-system-analysis.md (27 KB)
- Detailed feasibility study for gear architecture
- Comparison of architectural approaches
- Implementation recommendations and trade-offs
-
haproxy-dashboard-stack-layout.md
- Redesign proposal for the HAProxy dashboard's stack-with-multiple-containers layout (#79)
- Best-practice survey (Portainer, Lens, ArgoCD, Datadog, HAProxy stats, Grafana, NN/g)
- Three layout options with ASCII mockups, recommendation, and implementation outline
-
- Plan to evolve the Metrics gear from "HAProxy with extras" to a source-agnostic dashboard with per-source attribution (#87)
- Surveys the existing capability/probe + discovery infrastructure on the agent side
- 9-phase rollout, each independently shippable, starting from a capability manifest endpoint and ending at multi-source (HAProxy + nginx + Apache + Caddy + Docker) drill-down
These documents serve as:
- Architectural Reference - Core design decisions for the gear system
- Implementation Guide - Reference when building new gears
- Design Rationale - Understanding why the gear architecture was chosen
- Knowledge Base - Onboarding developers to Gearbox's architecture
- Completed work and migrations - See ../reports/
- Active development tasks - See TASKS.md
- Gear documentation - See ../gears.md