The reference omitted public startup and runtime interfaces that are useful for selecting a chassis, inspecting EVPN state, and managing incremental processing. Keep the documented interface aligned with the commands registered by the controller.
Assisted-by: GPT-5.6-Luna, OpenCode Signed-off-by: Ales Musil <[email protected]> --- controller/ovn-controller.8.xml | 167 ++++++++++++++++++++++++++++++-- 1 file changed, 160 insertions(+), 7 deletions(-) diff --git a/controller/ovn-controller.8.xml b/controller/ovn-controller.8.xml index 8121f7045..8b3307050 100644 --- a/controller/ovn-controller.8.xml +++ b/controller/ovn-controller.8.xml @@ -48,6 +48,27 @@ <h2>Other Options</h2> <xi:include href="lib/unixctl.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/> + <dl> + <dt><code>-n</code> <var>chassis</var></dt> + <dt><code>--chassis</code>=<var>chassis</var></dt> + <dd> + <p> + Use <var>chassis</var> as the chassis name. This takes precedence + over the name in the <code>system-id-override</code> file and + <code>external_ids:system-id</code> in the local Open vSwitch + database. + </p> + </dd> + + <dt><code>--dump-inc-proc-graph</code>[<code>=<var>node</var></code>]</dt> + <dd> + <p> + Dump the incremental processing engine graph in DOT format to + stdout and then exit. If <var>node</var> is specified, only the + subgraph rooted at that engine node is printed. + </p> + </dd> + </dl> <h3></h3> <xi:include href="lib/common.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/> @@ -769,12 +790,17 @@ <h1>Runtime Management Commands</h1> <p> <code>ovn-appctl</code> can send commands to a running - <code>ovn-controller</code> process. The currently supported - commands are described below. + <code>ovn-controller</code> process. The following list describes + commands specific to <code>ovn-controller</code> and its incremental + processing engine. Shared OVS libraries can register additional + commands; use <code>ovn-appctl -t ovn-controller list-commands</code> + to list the commands available in a running process. <dl> - <dt><code>exit</code></dt> + <dt><code>exit</code> [<code>--restart</code>]</dt> <dd> - Causes <code>ovn-controller</code> to gracefully terminate. + Causes <code>ovn-controller</code> to gracefully terminate. With + <code>--restart</code>, it skips the database cleanup normally done + on exit. </dd> <dt><code>ct-zone-list</code></dt> @@ -782,6 +808,37 @@ Lists each local logical port and its connection tracking zone. </dd> + <dt><code>evpn/remote-vtep-list</code></dt> + <dd> + Lists the remote EVPN VTEPs learned from the host neighbor table, + including their IP addresses, UDP ports, and VNIs. This command is + registered in all builds, but when <code>ovn-controller</code> is built + without Linux Netlink support (<code>HAVE_NETLINK</code>), it does not + send a reply and <code>ovn-appctl</code> waits indefinitely by default. + </dd> + + <dt><code>evpn/vtep-arp-list</code></dt> + <dd> + Lists the EVPN ARP and IPv6 neighbor entries maintained by + <code>ovn-controller</code>. + </dd> + + <dt><code>evpn/vtep-binding-list</code></dt> + <dd> + Lists the bindings between remote EVPN VTEPs and OVN datapaths. + </dd> + + <dt><code>evpn/vtep-fdb-list</code></dt> + <dd> + Lists the EVPN forwarding database entries maintained by + <code>ovn-controller</code>. + </dd> + + <dt><code>evpn/vtep-multicast-group-list</code></dt> + <dd> + Lists the EVPN multicast groups and their remote VTEP bindings. + </dd> + <dt><code>meter-table-list</code></dt> <dd> Lists each meter table entry and its local meter id. @@ -822,6 +879,8 @@ <p> Trigger a full compute iteration in <code>ovn-controller</code> based on the contents of the Southbound database and local OVS database. + This command is deprecated; use <code>inc-engine/recompute</code> + instead. </p> <p> This command is intended to use only in the event of a bug in the @@ -856,6 +915,70 @@ <code>ovn-nbctl</code>(8) for more details. </dd> + <dt><code>debug/dump-lflow-conj-ids</code></dt> + <dd> + Dumps the logical flow conjunction IDs currently allocated by + <code>ovn-controller</code>. + </dd> + + <dt><code>debug/dump-local-bindings</code></dt> + <dd> + Dumps the local logical port binding data maintained by + <code>ovn-controller</code>. + </dd> + + <dt><code>debug/dump-local-datapaths</code></dt> + <dd> + Dumps the local datapaths maintained by + <code>ovn-controller</code>. + </dd> + + <dt><code>debug/dump-local-template-vars</code></dt> + <dd> + Dumps the chassis-local template variables maintained by + <code>ovn-controller</code>. + </dd> + + <dt><code>debug/dump-mac-bindings</code></dt> + <dd> + Dumps the local MAC bindings maintained by + <code>ovn-controller</code>. + </dd> + + <dt><code>debug/dump-peer-ports</code></dt> + <dd> + Dumps the peer ports associated with local datapaths. + </dd> + + <dt><code>debug/dump-related-ports</code></dt> + <dd> + Dumps the logical ports related to this chassis. + </dd> + + <dt><code>debug/enable-timewarp</code></dt> + <dd> + Enables the time-warp facility and registers the <code>time/stop</code> + and <code>time/warp</code> commands, which respectively stop and + advance the monotonic clock for debugging and testing time-based + behavior. + </dd> + + <dt><code>debug/pause</code></dt> + <dd> + Pauses the main <code>ovn-controller</code> processing loop for + debugging. + </dd> + + <dt><code>debug/resume</code></dt> + <dd> + Resumes a processing loop paused by <code>debug/pause</code>. + </dd> + + <dt><code>debug/status</code></dt> + <dd> + Reports whether the main processing loop is running or paused. + </dd> + <dt><code>lflow-cache/flush</code></dt> <dd> Flushes the <code>ovn-controller</code> logical flow cache. @@ -867,10 +990,16 @@ type entry counts. </dd> + <dt><code>flush-lflow-cache</code></dt> + <dd> + Flushes the logical flow cache. This command is deprecated; use + <code>lflow-cache/flush</code> instead. + </dd> + <dt><code>inc-engine/show-stats</code></dt> <dd> - Display <code>ovn-controller</code> engine counters. For each engine - node the following counters have been added: + Displays the following <code>ovn-controller</code> counters for each + engine node: <ul> <li> <code>recompute</code> @@ -884,7 +1013,8 @@ </ul> </dd> - <dt><code>inc-engine/show-stats <var>engine_node_name</var> <var>counter_name</var></code></dt> + <dt><code>inc-engine/show-stats</code> + <var>engine_node_name</var> [<var>counter_name</var>]</dt> <dd> <p> Display the <code>ovn-controller</code> engine counter(s) for the @@ -899,6 +1029,29 @@ Reset <code>ovn-controller</code> engine counters. </dd> + <dt><code>inc-engine/recompute</code></dt> + <dd> + Triggers a full recompute of the incremental processing engine on + the next iteration. + </dd> + + <dt><code>inc-engine/compute-log-timeout</code> <var>msecs</var></dt> + <dd> + Sets the threshold in milliseconds that determines the log severity + for engine recomputes and incremental change handlers. Events taking + more than <var>msecs</var> milliseconds are logged at + <code>INFO</code>, subject to rate limiting; shorter events and events + taking exactly <var>msecs</var> milliseconds are logged at + <code>DEBUG</code>. The default threshold is 500 milliseconds. + </dd> + + <dt><code>inc-engine/list-stopwatches</code> [<var>node</var>]</dt> + <dd> + Lists the engine nodes and their change handler names. If + <var>node</var> is specified, only the handlers for that engine node + are listed. + </dd> + <dt><code>inc-engine/enable-stopwatch</code> [<var>node</var>]</dt> <dd> Enables the per-node and per-handler stopwatches in the -- 2.55.0 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
