miroir/docs/ctl/verify.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

31 lines
802 B
Markdown

# `miroir-ctl verify`
## Purpose
Check data integrity across replica groups and detect drift.
## Preconditions
- Admin API key configured
- Cluster healthy (degraded nodes can cause false positives)
## Examples
```bash
# Verify all indexes
miroir-ctl verify
# Verify specific index
miroir-ctl verify --index myindex
# Verbose output (shows per-shard details)
miroir-ctl verify --verbose
```
## Gotchas
- Verification is read-only — it won't fix drift, only report it
- Large indexes take time to verify — progress is not streamed
- Use `miroir-ctl task status` to check async verification jobs
- Drift is automatically repaired by anti-entropy workers — see `miroir-ctl task status`
## See also
- Plan §13.8 — anti-entropy and drift detection
- Plan §10 — observability and metrics