docs: put MinIO first-class on ground, add executive overview
CI & Release / Verify simulator (push) Skipped
CI & Release / Trivy scan (push) Skipped
CI & Release / Semantic Release (push) Skipped
CI & Release / Verify simulator (push) Skipped
CI & Release / Trivy scan (push) Skipped
CI & Release / Semantic Release (push) Skipped
Treat MinIO as existing stack infrastructure (default T3 warehouse, not on the drone), add a one-page executive map, and record placement as an open team question rather than a rip-and-replace.
This commit is contained in:
@@ -6,6 +6,8 @@ A fleet of drones flies fully autonomously: no internet uplink, no external acce
|
||||
|
||||
This repository describes how to build, deliver, test, and operate that platform: the storage layout, the sync strategy, the network trust model, the CI/CD chain, and the simulation environment that makes it all testable without touching real hardware.
|
||||
|
||||
**New here?** Start with the one-pager: [00 — Executive overview](docs/00-executive.md) (includes how **MinIO** fits). Then the [design journey](docs/12-design-journey.md) if you want the narrative.
|
||||
|
||||
## Design principles
|
||||
|
||||
1. **Every drone is autonomous.** No cluster orchestrator spans the swarm; intermittent mesh connectivity makes that an anti-pattern. Coordination happens through data exchange, not through a control plane.
|
||||
@@ -30,7 +32,7 @@ Honest map so a reader knows what runs today versus what is design intent.
|
||||
| Peer query | Read-only SQL **gate** over HTTP explorer (keyword allow-list) | Same gate idea via **SSH forced command** + OS/engine hardening |
|
||||
| Bulk sync | Visualised opportunistic transfer volume | rsync/rclone over persistent SSH between peers |
|
||||
| Mesh trust | Ansible templates for WireGuard + ed25519 forced commands | Provisioned per-device keys; nothing joins at runtime |
|
||||
| Ground segment | k3d/Terraform sim: lake, Grafana, offload CronJob, optional MinIO | k3s warehouse, GitOps overlays, post-flight mirror |
|
||||
| Ground segment | k3d/Terraform sim: lake, Grafana, offload CronJob, **MinIO as T3** | k3s warehouse with MinIO, GitOps overlays, post-flight mirror |
|
||||
| CI / delivery | GitHub Actions: pytest, smoke flight, Trivy, semver release + fleet manifest artifact | Self-hosted GitLab + registry inside the air gap (same stages) |
|
||||
| Docs | Problem, architecture, ADRs, design journey, open questions | Living ADRs owned by the team |
|
||||
|
||||
@@ -40,6 +42,7 @@ Start from the [design journey](docs/12-design-journey.md) for the story; use th
|
||||
|
||||
| Document | Contents |
|
||||
| --- | --- |
|
||||
| [00 — Executive](docs/00-executive.md) | **Start here** — one-page goal, sync rule, MinIO stance |
|
||||
| [00 — Glossary](docs/00-glossary.md) | Terms and abbreviations used throughout |
|
||||
| [01 — Problem statement](docs/01-problem-statement.md) | Goal, constraints, knowns vs assumptions |
|
||||
| [02 — Architecture](docs/02-architecture.md) | On-board layers, service composition, communication planes |
|
||||
@@ -49,13 +52,13 @@ Start from the [design journey](docs/12-design-journey.md) for the story; use th
|
||||
| [06 — Environments](docs/06-environments.md) | Drone / ground warehouse / dev-simulation infrastructures |
|
||||
| [07 — Observability](docs/07-observability.md) | Logs, service metrics, hardware telemetry |
|
||||
| [08 — Roadmap](docs/08-roadmap.md) | Dependency graph, simple to complex |
|
||||
| [09 — Open questions](docs/09-open-questions.md) | Known unknowns and proposed answers |
|
||||
| [09 — Open questions](docs/09-open-questions.md) | Known unknowns and proposed answers (incl. MinIO placement) |
|
||||
| [10 — Domain context](docs/10-domain-context.md) | Swarm autonomy principles this design builds on |
|
||||
| [11 — CI/CD & delivery](docs/11-cicd-delivery.md) | Pipelines, registry, dev containers, fleet releases |
|
||||
| [12 — Design journey](docs/12-design-journey.md) | **Start here** — a narrative walk-through of how the design came together, linking into the code |
|
||||
| [12 — Design journey](docs/12-design-journey.md) | Narrative walk-through linking into the code |
|
||||
| [ADRs](docs/adr/) | Architecture Decision Records — the decisions behind the above, in the order they were made |
|
||||
|
||||
New here? Read the [design journey](docs/12-design-journey.md) first: it tells the story chronologically and links straight into the code and decisions. The design principles below are the *what*; the [ADRs](docs/adr/) are the *why and when* — each principle traces to a dated, immutable decision record.
|
||||
New here? Read the [executive overview](docs/00-executive.md) first, then the [design journey](docs/12-design-journey.md) if you want the story. The design principles above are the *what*; the [ADRs](docs/adr/) are the *why and when*.
|
||||
|
||||
## Runnable parts
|
||||
|
||||
|
||||
Reference in New Issue
Block a user