flow: add miniflow_pad_from_64

[cascardo/ovs.git] / ovn / ovn-nb.xml

diff --git a/ovn/ovn-nb.xml b/ovn/ovn-nb.xml
index b6eef03..c3b4934 100644 (file)
--- a/ovn/ovn-nb.xml
+++ b/ovn/ovn-nb.xml
@@ -148,9 +148,10 @@
           subnets).
         </p>
 
-        <column name="options" key="router-port" type='{"type": "uuid"}'>
-          Required.  The UUID of the <ref table="Logical_Router_Port"/> to
-          which this logical switch port is connected.
+        <column name="options" key="router-port">
+          Required.  The <ref column="name"/> of the <ref
+          table="Logical_Router_Port"/> to which this logical switch port is
+          connected.
         </column>
       </group>
 
@@ -181,6 +182,23 @@
           Required.  A logical switch name connected by the VTEP gateway.
         </column>
       </group>
+
+      <group title="VMI (or VIF) Options">
+        <p>
+          These options apply to logical ports with <ref column="type"/> having
+          (empty string)
+        </p>
+
+        <column name="options" key="policing_rate">
+          If set, indicates the maximum rate for data sent from this interface,
+          in kbps. Data exceeding this rate is dropped.
+        </column>
+
+        <column name="options" key="policing_burst">
+          If set, indicates the maximum burst size for data sent from this
+          interface, in kb.
+        </column>
+      </group>
     </group>
 
     <group title="Containers">
@@ -284,6 +302,11 @@
               if any, uses this information to avoid issuing ARP requests for
               logical switch ports.
             </p>
+
+            <p>
+              Note that the order here is important. The Ethernet address must
+              be listed before the IP address.
+            </p>
           </dd>
 
           <dt><code>unknown</code></dt>
@@ -382,6 +405,11 @@
         restrictive policy, it is important to remember to allow flows
         such as ARP and IPv6 neighbor discovery packets.
       </p>
+
+      <p>
+        Note that you can not create an ACL matching on a port with
+        type=router.
+      </p>
     </column>
 
     <column name="action">
@@ -468,10 +496,14 @@
 
     <column name="name">
       <p>
-        A name for the logical router port.  This name has no special meaning or purpose
-        other than to provide convenience for human interaction with the ovn-nb
-        database.  There is no requirement for the name to be unique.  The
-        logical router port's UUID should be used as the unique identifier.
+        A name for the logical router port.
+      </p>
+
+      <p>
+        In addition to provide convenience for human interaction with the
+        ovn-nb database, this column is used as reference by its patch port in
+        <ref table="Logical_Port"/> or another logical router port in <ref
+        table="Logical_Router_Port"/>.
       </p>
     </column>
 
@@ -502,8 +534,10 @@
         <li>
           To attach a logical switch to a logical router.  A logical router
           port of this type is referenced by exactly one <ref
-          table="Logical_Port"/> of type <code>router</code>.  The <ref
-          column="peer"/> column is empty.
+          table="Logical_Port"/> of type <code>router</code>.  The value of
+          <ref column="name"/> is set as <code>router-port</code> in column
+          <ref column="options"/> of <ref table="Logical_Port"/>.
+          In this case <ref column="peer"/> column is empty.
         </li>
 
         <li>
@@ -518,7 +552,7 @@
       <column name="peer">
         <p>
           For a router port used to connect two logical routers, this
-          identifies the other router port in the pair.
+          identifies the other router port in the pair by <ref column="name"/>.
         </p>
 
         <p>