Skip to content

Reference

Information-oriented, exhaustive lookup. These pages describe Northwatch's surface as precisely as possible — they are for confirming a flag, a route, or a value, not for learning.

  • CLI flags & env vars — every flag, its environment-variable equivalent and default, plus the snapshot subcommand.
  • Configuration file — the JSON multi-cluster config-file schema and how it relates to the flat flags.
  • HTTP API — the route groups, the JSON response shape, and where to find the machine-readable OpenAPI spec.
  • Capabilities — the capability list the server advertises and what enables each one.
  • Prometheus metrics — every metric exported at /metrics.
  • Make targets — build, test, lint and lab targets.
  • Project structure — repository layout and what each package does.

For task-oriented instructions see the How-to guides; for background and rationale see the Explanation section.