miroir/docs/ctl/shadow.md
jedarden adab169bed docs(miroir-ctl): add subcommand runbooks and help text (P11.4, miroir-uyx.4)
- Created docs/ctl/*.md runbooks for all 16 miroir-ctl subcommands
- Each runbook includes: purpose, preconditions, examples, gotchas, see also
- Added runbook location to --help output
- All runbooks under 50 lines for easy reading

Closes: miroir-uyx.4
2026-05-24 11:47:36 -04:00

1.1 KiB

miroir-ctl shadow

Purpose

Manage shadow indexing for A/B testing and validation without affecting production traffic.

Preconditions

  • Source index exists and is healthy
  • Sufficient capacity for shadow writes (2x write amplification)

Examples

# Create a shadow index for testing
miroir-ctl shadow create --source prod --shadow test --sync-writes

# Enable query shadowing (mirror queries to both, compare results)
miroir-ctl shadow query --source prod --shadow test --compare

# Check shadow index lag
miroir-ctl shadow status --source prod

# Stop shadowing and delete shadow index
miroir-ctl shadow delete --source prod

Gotchas

  • Not yet implemented — see tracking bead for details
  • Shadow writes are synchronous — adds latency to production writes
  • Query shadowing is asynchronous — doesn't affect production latency
  • Use shadow indexing for schema validation, not load testing (write amplification)
  • Delete shadow indexes after testing to free storage

See also

  • Plan §13.16 — shadow indexing architecture
  • miroir-ctl verify — compare shadow and source results