This page is the short map for Spooky's operator-facing programmatic surfaces.
Use the linked reference pages for canonical endpoint behavior, status codes, metrics, and configuration semantics.
CLI Surface
Basic usage:
spooky --config /etc/spooky/config.yaml
Core options:
| Option | Meaning |
|---|---|
--config / -c |
Path to config file |
--version / -V |
Print version |
--help / -h |
Print usage |
Surface Map
| Surface | Protocol | Main use | Canonical page |
|---|---|---|---|
| metrics endpoint | HTTP GET |
scrape, dashboarding, alerting, trend analysis | Metrics Reference |
| Control API | HTTP/1.1 over TLS | runtime state, staged activation, rollback, cert reload, restart | Control API Reference |
| config file | YAML | runtime configuration input | Configuration Reference |
Common Entry Points
| Task | Start here |
|---|---|
| check process liveness and readiness | GET /health and GET /ready in Control API Reference |
| inspect active runtime state | GET /admin/runtime in Control API Reference |
| validate, preview, activate, or roll back runtime config | Control API Reference |
| understand metric names and labels | Metrics Reference |
| use dashboards, alerts, and SLO views | Observability Operator Bundle |
| understand reload, drain, and restart boundaries | Reload and Drain |
| understand exact config shape and examples | Configuration Reference and Configuration Examples |
Scope Note
The Control API is a file-reload control surface, not a granular per-object mutation API.
For the canonical behavior of:
validate,preview,activate,rollback,reload,reload-certs, andrestart- generation history and rollback eligibility
- authn, authz, and mTLS behavior
- response status and failure semantics
For runtime-managed versus restart-required configuration boundaries, use Reload and Drain.