diff mbox

[ovs-dev,2/6] Add physical endpts and binding to logical ports to SB schema doc

Message ID 1458159951-21345-3-git-send-email-dball@vmware.com
State Deferred
Headers show

Commit Message

Darrell Ball March 16, 2016, 8:25 p.m. UTC
Signed-off-by: Darrell Ball <dball@vmware.com>
---
 ovn/ovn-sb.xml | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
diff mbox

Patch

diff --git a/ovn/ovn-sb.xml b/ovn/ovn-sb.xml
index d62f1e4..fce7123 100644
--- a/ovn/ovn-sb.xml
+++ b/ovn/ovn-sb.xml
@@ -1168,6 +1168,66 @@  tcp.flags = RST;
     </group>
   </table>
 
+  <table name="Physical_Endpoint" title="Endpoints on physical networks ">
+   <p>
+      Each row in this table identifies an endpoint on a physical access
+      network.  The <ref table="Port_Binding"/> table references physical
+      endpoints for localnet and gateways. A physical endpoint comprises
+      both a location on a chassis port and encapsulation for access.
+      A given chassis port location can have several encapsulations
+      and therefore physical endpoints.
+    </p>
+
+    <p>
+      For localnet physical endpoints, chassis name and chassis port
+      can be supplied as dummy arguments or omitted. If chassis and
+      port are omitted, the same encapsulation on all HVs part of a
+      given localnet is implied and a single logical port could be used.
+      Then, the physical endpoint is bound to the localnet logical port.
+      If multiple encapsulations are needed, multiple physical endpoints
+      would be defined and bound to separate localnet logical ports.
+      If no physical endpt is bound to a localnet, encap is assumed empty.
+    </p>
+
+    <p>
+      For gateways, a single physical endpoint must be bound to each
+      logical port. The chassis name of the physical endpoint must
+      match the chassis system-id.
+    </p>
+
+    <column name="name">
+      Unique name to reference the physical endpoint.
+    </column>
+
+    <column name="chassis">
+      The transport node the physical endpoint resides on.
+    </column>
+
+    <column name="chassis_port">
+      The port on the transport node the physical endpoint resides on.
+      Context is the associated transport node.
+    </column>
+
+    <column name="type">
+      The encapsulation type of the physical endpoint. Types include
+      single vlan for now, but later support for mpls label stack,
+      IP tunnel outer header and dual vlan. Note that encapsulations
+      are often directionally different, meaning the encapsulation
+      expected on ingress is different from the encapsulation
+      for egressing packets; mpls labels and IP tunnels being
+      two examples.
+    </column>
+
+    <column name="ingress_encap">
+      The ingress encapsulation type of the physical endpoint.
+    </column>
+
+    <column name="egress_encap">
+      The egress encapsulation type of the physical endpoint.
+    </column>
+
+  </table>
+
   <table name="Port_Binding" title="Physical-Logical Port Bindings">
     <p>
       Most rows in this table identify the physical location of a logical port.
@@ -1222,6 +1282,13 @@  tcp.flags = RST;
         <code>ovn-controller</code>/<code>ovn-controller-vtep</code>.
       </column>
 
+      <column name="phys_endpts">
+        The physical endpoints that the logical port resides on.
+        To successfully identify phys_endpts, this column must be
+        <ref table="Physical_Endpoint"/> records.  This is populated by a
+        <code>CMS</code> physical management component.
+      </column>
+
       <column name="tunnel_key">
         <p>
           A number that represents the logical port in the key (e.g. STT key or
@@ -1331,6 +1398,7 @@  tcp.flags = RST;
       </column>
 
       <column name="tag">
+        This column will be deprecated.
         If set, indicates that the port represents a connection to a specific
         VLAN on a locally accessible network. The VLAN ID is used to match
         incoming traffic and is also added to outgoing traffic.