NorthwatchSee your OVN deployment whole

A single service that connects to the OVN Northbound and Southbound OVSDB databases and gives you a live, searchable, correlated view — browse, visualize, debug, trace, and monitor from one web UI and REST API.

Get started

CLI reference

View on GitHub

Tutorials

Learning-oriented, guided paths. Bring up a throwaway OVN lab, point Northwatch at it, and walk through your first investigation end to end.

How-to guides

Task-oriented recipes. Connect to a Raft cluster, enrich with OpenStack, trace a packet, diagnose a port binding, capture a snapshot, enable writes, and more.

Reference

Information-oriented lookup. Every CLI flag and environment variable, the config-file schema, the HTTP API surface, capabilities, and the Prometheus metrics.

Explanation

Understanding-oriented background. The architecture, the NB↔SB correlation model, the capability model, enrichment, snapshots, and the reasoning behind initial-load tuning.

This documentation follows the Diátaxis framework, which separates documentation into four modes by reader need: Tutorials (learning), How-to guides (tasks), Reference (lookup), and Explanation (understanding). Use the cards above to jump to the mode that matches what you need right now.