diff mbox series

[ovs-dev,2/8] ovn-nb, ovn-sb: Document that LSPs and LRPs must not share names.

Message ID 20201022035415.33541-2-blp@ovn.org
State Accepted
Headers show
Series [ovs-dev,1/8] ovn-nb: Better document dynamic addresses. | expand

Commit Message

Ben Pfaff Oct. 22, 2020, 3:54 a.m. UTC
Signed-off-by: Ben Pfaff <blp@ovn.org>
---
 ovn-nb.xml | 10 ++++++++++
 ovn-sb.xml | 13 +++++++++----
 2 files changed, 19 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/ovn-nb.xml b/ovn-nb.xml
index 38724f3851b1..5a8ac4a0d0e0 100644
--- a/ovn-nb.xml
+++ b/ovn-nb.xml
@@ -545,6 +545,11 @@ 
           unique identifier.  See <code>Containers</code>, below, for more
           information.
         </p>
+
+        <p>
+          A logical switch port may not have the same name as a logical router
+          port, but the database schema cannot enforce this.
+        </p>
       </column>
 
       <column name="type">
@@ -2093,6 +2098,11 @@ 
         in <ref table="Logical_Switch_Port"/> or another logical router port in
         <ref table="Logical_Router_Port"/>.
       </p>
+
+        <p>
+          A logical router port may not have the same name as a logical switch
+          port, but the database schema cannot enforce this.
+        </p>
     </column>
 
     <column name="networks">
diff --git a/ovn-sb.xml b/ovn-sb.xml
index 182ff0a8a282..15d47ef039cc 100644
--- a/ovn-sb.xml
+++ b/ovn-sb.xml
@@ -2610,10 +2610,15 @@  tcp.flags = RST;
       </column>
 
       <column name="logical_port">
-        A logical port, taken from <ref table="Logical_Switch_Port"
-        column="name" db="OVN_Northbound"/> in the OVN_Northbound
-        database's <ref table="Logical_Switch_Port" db="OVN_Northbound"/>
-        table.  OVN does not prescribe a particular format for the
+        A logical port.  For a logical switch port, this is taken from <ref
+        table="Logical_Switch_Port" column="name" db="OVN_Northbound"/> in the
+        OVN_Northbound database's <ref table="Logical_Switch_Port"
+        db="OVN_Northbound"/> table.  For a logical router port, this is taken
+        from <ref table="Logical_Router_Port" column="name"
+        db="OVN_Northbound"/> in the OVN_Northbound database's <ref
+        table="Logical_Router_port" db="OVN_Northbound"/> table.  (This means
+        that logical switch ports and router port names must share names in an
+        OVN deployment.) OVN does not prescribe a particular format for the
         logical port ID.
       </column>