ovn-sb.xml is missing three of the Port_Binding.types that have been
added: external, remote, and mirror. Document the ports types and what
they mean.

Fixes: b31c76000bef ("ovn: Support a new Logical_Switch_Port.type - 'external'")
Fixes: 74ada3273454 ("northd: Introduce the concept of transit routers.")
Fixes: 2a2fe266d09c ("northd: Added support for port mirroring in OVN overlay.")
Assisted-by: Claude Opus 4.6, Claude Code
Signed-off-by: Jacob Tanenbaum <[email protected]>

---
v2: - fixed format of xml that lead to compile issues

---
---
 ovn-sb.xml | 53 ++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 48 insertions(+), 5 deletions(-)

diff --git a/ovn-sb.xml b/ovn-sb.xml
index 013d498e3..4f6e7ccb8 100644
--- a/ovn-sb.xml
+++ b/ovn-sb.xml
@@ -3496,6 +3496,40 @@ tcp.flags = RST;
             This is populated by <code>ovn-controller</code> based on the value
             of the <code>options:l2gateway-chassis</code> column in this table.
           </dd>
+
+          <dt>external</dt>
+            <dd>
+              A logical port representing an externally connected entity.
+              An <code>external</code> port requires a
+              <ref column="ha_chassis_group"/> and a
+              <code>localnet</code> port on the same logical switch to be
+              functional. <code>ovn-northd</code> syncs the HA chassis group
+              from the corresponding
+              <ref table="Logical_Switch_Port" db="OVN_Northbound"/>
+              and generates logical flows that direct traffic through the
+              <code>localnet</code> port on the bound chassis. Without a
+              <ref column="ha_chassis_group"/>, no logical flows are
+              generated for the port.
+            </dd>
+
+            <dt>remote</dt>
+            <dd>
+              A logical router port whose peer resides on a remote chassis
+              (one whose <ref column="other_config"
+              table="Chassis"/>:<code>is-remote</code> is
+              <code>true</code>).  This type is set instead of
+              <code>patch</code> when <code>ovn-northd</code> determines
+              that the requested chassis is remote.
+            </dd>
+
+            <dt>mirror</dt>
+            <dd>
+              A synthetic port binding created for lport-level mirroring.
+              It acts similarly to a container port (without VLAN tagging)
+              and has its <ref column="mirror_port"
+              table="Port_Binding"/> column set to point to the mirror
+              target port.
+            </dd>
         </dl>
 
       </column>
@@ -3521,11 +3555,20 @@ tcp.flags = RST;
 
       <column name="ha_chassis_group">
         <p>
-          This should only be populated for ports with
-          <ref column="type"/> set to <code>chassisredirect</code>.
-          This column defines the HA chassis group with a list of
-          HA chassis used as gateways where traffic will be redirected
-          through.
+          A list of HA chassis for this port binding. It is populated
+          for ports with <ref column="type"/> set to
+          <code>chassisredirect</code> or <code>external</code>.
+        </p>
+
+        <p>
+          For <code>chassisredirect</code> ports, the HA chassis are used
+          as gateways where traffic will be redirected through.
+        </p>
+
+        <p>
+          For <code>external</code> ports, the HA chassis group determines
+          which chassis binds the port and handles its traffic through a
+          <code>localnet</code> port on the same logical switch.
         </p>
       </column>
 
-- 
2.55.0

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to