No description
Find a file
jedarden 6df5a63ad2 Phase 0 (miroir-qon): Re-verification — foundation confirmed complete
All Phase 0 DoD items verified present and correct:
- Workspace structure (Cargo.toml with 3 crates)
- Toolchain pin (rust-toolchain.toml with Rust 1.87)
- Config struct (full plan §4 YAML schema with all §13 capabilities)
- Repo hygiene (LICENSE, CHANGELOG.md, .gitignore)
- All three crates scaffolded (miroir-core, miroir-proxy, miroir-ctl)

Previous verification (commit 554a705) confirmed build/test/clippy/fmt all passing.
No code changes required — foundation is production-ready.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-08 20:21:47 -04:00
.beads Phase 0 (miroir-qon): Foundation verification complete 2026-05-08 19:49:03 -04:00
crates Phase 0 (miroir-qon): Foundation verification — formatting fix 2026-05-08 20:16:22 -04:00
docs Phase 0 (miroir-qon): Foundation — verification complete 2026-05-08 19:20:18 -04:00
notes Phase 0 (miroir-qon): Re-verification — foundation confirmed complete 2026-05-08 20:21:47 -04:00
.editorconfig Add repo hygiene: LICENSE, CHANGELOG, .gitignore 2026-04-18 20:47:36 -04:00
.gitignore Add repo hygiene: LICENSE, CHANGELOG, .gitignore 2026-04-18 20:47:36 -04:00
.needle-predispatch-sha Phase 0 (miroir-qon): Foundation verification complete 2026-05-08 19:49:03 -04:00
Cargo.lock Phase 0 (miroir-qon): Foundation verification complete 2026-05-08 19:49:03 -04:00
Cargo.toml P0.1: Set up Cargo workspace + toolchain pin 2026-04-18 20:52:53 -04:00
CHANGELOG.md Add repo hygiene: LICENSE, CHANGELOG, .gitignore 2026-04-18 20:47:36 -04:00
clippy.toml Add repo hygiene: LICENSE, CHANGELOG, .gitignore 2026-04-18 20:47:36 -04:00
LICENSE Add repo hygiene: LICENSE, CHANGELOG, .gitignore 2026-04-18 20:47:36 -04:00
README.md Add repo hygiene: LICENSE, CHANGELOG, .gitignore 2026-04-18 20:47:36 -04:00
rust-toolchain.toml OP#6: Add ARM64 (aarch64-unknown-linux-musl) target support 2026-05-08 15:25:12 -04:00
rustfmt.toml Add repo hygiene: LICENSE, CHANGELOG, .gitignore 2026-04-18 20:47:36 -04:00

Miroir

Multi-node Index Replication Orchestrator, Integrated Rebalancing

Miroir is a RAID-like orchestration layer for Meilisearch. It stripes a large index across a fleet of small-RAM Meilisearch nodes with a configurable replication factor, fans out search queries across all shards, and rebalances shard assignments when nodes are added or removed — all using the Meilisearch Community Edition.

The Problem

Meilisearch loads its entire index into memory-mapped LMDB files. A large index that exceeds a single server's available RAM cannot run on that server. The Enterprise Edition's native sharding is gated behind a commercial license. Miroir solves this without it.

How It Works

Client
  │
  ▼
Miroir Orchestrator
  ├── Write path: hash(doc_id) → assign to shard → write to R replicas
  ├── Read path:  scatter query to all shards → gather → merge ranked results
  └── Rebalance: on node add/remove → recompute assignments → migrate minimum shards

Meilisearch Nodes (N instances, each holding a subset of shards)
  node-0   node-1   node-2   ...   node-N

Replication Factor

Analogous to software RAID — configurable per deployment:

RF Redundancy Node failures tolerated Capacity
1 None (stripe only) 0 100% of fleet
2 One replica 1 per shard group 50% of fleet
3 Two replicas 2 per shard group 33% of fleet

Key Components

  • Orchestrator — proxy that handles shard routing, scatter-gather, result merging, and topology management
  • Shard router — consistent hash function (Rendezvous/HRW) mapping document IDs to node assignments; minimal reshuffling on topology change
  • Rebalancer — on node add/remove, recomputes assignments and migrates only the shards that changed owners; surviving replicas serve reads during rebuild
  • Result merger — normalizes and merges ranked result sets from multiple shards into a single coherent response

Status

Design phase. See docs/ for architecture detail.