From patchwork Tue Oct 6 20:32:16 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Pfaff X-Patchwork-Id: 526973 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from archives.nicira.com (unknown [IPv6:2600:3c00::f03c:91ff:fe6e:bdf7]) by ozlabs.org (Postfix) with ESMTP id C5DED140D95 for ; Wed, 7 Oct 2015 07:32:21 +1100 (AEDT) Received: from archives.nicira.com (localhost [127.0.0.1]) by archives.nicira.com (Postfix) with ESMTP id 5952D1063A; Tue, 6 Oct 2015 13:32:20 -0700 (PDT) X-Original-To: dev@openvswitch.org Delivered-To: dev@openvswitch.org Received: from mx1e4.cudamail.com (mx1.cudamail.com [69.90.118.67]) by archives.nicira.com (Postfix) with ESMTPS id 03FF710607 for ; Tue, 6 Oct 2015 13:32:19 -0700 (PDT) Received: from bar5.cudamail.com (unknown [192.168.21.12]) by mx1e4.cudamail.com (Postfix) with ESMTPS id 7DDE61E00E2 for ; Tue, 6 Oct 2015 14:32:18 -0600 (MDT) X-ASG-Debug-ID: 1444163537-09eadd141636e8a0001-byXFYA Received: from mx1-pf2.cudamail.com ([192.168.24.2]) by bar5.cudamail.com with ESMTP id 55KYPxS234YX4ER4 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 06 Oct 2015 14:32:17 -0600 (MDT) X-Barracuda-Envelope-From: blp@nicira.com X-Barracuda-RBL-Trusted-Forwarder: 192.168.24.2 Received: from unknown (HELO mail-pa0-f49.google.com) (209.85.220.49) by mx1-pf2.cudamail.com with ESMTPS (RC4-SHA encrypted); 6 Oct 2015 20:32:17 -0000 Received-SPF: unknown (mx1-pf2.cudamail.com: Multiple SPF records returned) X-Barracuda-RBL-Trusted-Forwarder: 209.85.220.49 Received: by pablk4 with SMTP id lk4so219084020pab.3 for ; Tue, 06 Oct 2015 13:32:17 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=xGcFElV8Vpx0LPKn4wRsm2zJD86+04ZSg4N8YMyFd9k=; b=MGpvrFsIcGClkAKQF7XxZ/HNwyNk5MEMfE84dYtvLq2uJTn8p+WZnTWoN0s3fWQCKb mMX2MSmsE5Fcx1Sas8SWisdZYZTuFWz6j5Q1A3fI3rtzHw6mO1UxGxneraOU7h49eEUC 1SrwVJLY7XCW4h2p+xf1xrVYkEuvZPyEiYISupny1+/Q61glwHoc0thmbLiXwIDQIRwI prX9IvGygASmT+v5c2xYY9kroTqe/eyKdIi1UM7UCuTdSSfSc978no89t0kr6A6/R+Wd B+C04PsgzS/Y3/Pxvw+0I7LMtW40MZj3JQbwQ2LFTfAH8xD3YP9WXFWKmpEUvzJL/HYM xX0w== X-Gm-Message-State: ALoCoQlrS2pDzje6nx91+J4BqBlW1mbPOLgKriapLmFmXIW3IOXfhdOuiUTYEbJctRoUCyXOMVxv X-Received: by 10.68.219.169 with SMTP id pp9mr49996148pbc.115.1444163537079; Tue, 06 Oct 2015 13:32:17 -0700 (PDT) Received: from sigabrt.gateway.sonic.net (173-228-112-165.dsl.dynamic.fusionbroadband.com. [173.228.112.165]) by smtp.gmail.com with ESMTPSA id sv9sm35122536pbc.44.2015.10.06.13.32.15 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 06 Oct 2015 13:32:15 -0700 (PDT) X-CudaMail-Envelope-Sender: blp@nicira.com X-Barracuda-Apparent-Source-IP: 173.228.112.165 From: Ben Pfaff To: dev@openvswitch.org X-CudaMail-Whitelist-To: dev@openvswitch.org X-CudaMail-MID: CM-E2-1005089820 X-CudaMail-DTE: 100615 X-CudaMail-Originating-IP: 209.85.220.49 Date: Tue, 6 Oct 2015 13:32:16 -0700 X-ASG-Orig-Subj: [##CM-E2-1005089820##][PATCH] ovn-sb.xml: Reorganize Port_Binding documentation. Message-Id: <1444163536-26626-1-git-send-email-blp@nicira.com> X-Mailer: git-send-email 2.1.3 X-Barracuda-Connect: UNKNOWN[192.168.24.2] X-Barracuda-Start-Time: 1444163537 X-Barracuda-Encrypted: DHE-RSA-AES256-SHA X-Barracuda-URL: https://web.cudamail.com:443/cgi-mod/mark.cgi X-ASG-Whitelist: Header =?UTF-8?B?eFwtY3VkYW1haWxcLXdoaXRlbGlzdFwtdG8=?= X-Virus-Scanned: by bsmtpd at cudamail.com X-Barracuda-BRTS-Status: 1 Cc: Ben Pfaff Subject: [ovs-dev] [PATCH] ovn-sb.xml: Reorganize Port_Binding documentation. X-BeenThere: dev@openvswitch.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: dev-bounces@openvswitch.org Sender: "dev" This takes advantage of column grouping and the ability to document a key within a column. Signed-off-by: Ben Pfaff --- ovn/ovn-sb.xml | 263 +++++++++++++++++++++++++++++---------------------------- 1 file changed, 134 insertions(+), 129 deletions(-) diff --git a/ovn/ovn-sb.xml b/ovn/ovn-sb.xml index 2664cd4..d1b37f0 100644 --- a/ovn/ovn-sb.xml +++ b/ovn/ovn-sb.xml @@ -957,152 +957,157 @@ overwrite the chassis column with new information.

- - The logical datapath to which the logical port belongs. - - - - A logical port, taken from in the OVN_Northbound database's - table. OVN does not - prescribe a particular format for the logical port ID. - - - -

- A type for this logical port. Logical ports can be used to model - other types of connectivity into an OVN logical switch. Leaving this - column blank maintains the default logical port behavior, which - is for a VM (or VIF) interface. The following other types are defined: -

- -
-
localnet
-
A connection to a locally accessible network from each - ovn-controller instance. A logical switch can only - have a single localnet port attached and at most one - regular logical port. This is used to model direct connectivity - to an existing network.
-
- -
-
vtep
-
A port to a logical switch on a VTEP gateway chassis. In order - to get this port correctly recognized by the OVN controller, the - :vtep-physical-switch - and :vtep-logical-switch - must also be defined.
-
- + + + The logical datapath to which the logical port belongs. + - -

- This column provides key/value settings specific to the logical port - . The following options are defined: -

+ + A logical port, taken from in the OVN_Northbound database's table. OVN does not + prescribe a particular format for the logical port ID. + -
-
network_name
-
- Must be set when is localnet. - ovn-controller uses the configuration entry - ovn-bridge-mappings to determine how to connect to - this network. ovn-bridge-mappings is a list of - network names mapped to a local OVS bridge that provides access - to that network. An example of configuring - ovn-bridge-mappings would be: + + The physical location of the logical port. To successfully identify a + chassis, this column must be a record. This is + populated by + ovn-controller/ovn-controller-vtep. + -

- $ ovs-vsctl set open - . external-ids:ovn-bridge-mappings=physnet1:br-eth0,physnet2:br-eth1 -

+ +

+ A number that represents the logical port in the key (e.g. STT key or + Geneve TLV) field carried within tunnel protocol packets. +

-

- Also note that when a logical switch has a localnet - port attached, every chassis that may have a local vif attached - to that logical switch must have a bridge mapping configured to - reach that localnet. Traffic that arrives on a - localnet port is never forwarded over a tunnel to - another chassis. -

-
-
+

+ The tunnel ID must be unique within the scope of a logical datapath. +

+ -
-
vtep-physical-switch
-
- The name of the VTEP gateway. Must be set when - is vtep. -
-
+ +

+ The Ethernet address or addresses used as a source address on the + logical port, each in the form + xx:xx:xx:xx:xx:xx. + The string unknown is also allowed to indicate that the + logical port has an unknown set of (additional) source addresses. +

+ +

+ A VM interface would ordinarily have a single Ethernet address. A + gateway port might initially only have unknown, and then + add MAC addresses to the set as it learns new source addresses. +

+ -
-
vtep-logical-switch
-
- A logical switch name connected by the VTEP gateway. Must be - set when is vtep. -
-
- + +

+ A type for this logical port. Logical ports can be used to model other + types of connectivity into an OVN logical switch. The following types + are defined: +

+ +
+
(empty string)
+
VM (or VIF) interface.
+
localnet
+
+ A connection to a locally accessible network from each + ovn-controller instance. A logical switch can only + have a single localnet port attached and at most one + regular logical port. This is used to model direct connectivity to + an existing network. +
+ +
vtep
+
+ A port to a logical switch on a VTEP gateway chassis. In order to + get this port correctly recognized by the OVN controller, the :vtep-physical-switch and :vtep-logical-switch must also + be defined. +
+
+ + - +

- A number that represents the logical port in the key (e.g. STT key or - Geneve TLV) field carried within tunnel protocol packets. + These options apply to logical ports with of + localnet.

+ + Required. ovn-controller uses the configuration entry + ovn-bridge-mappings to determine how to connect to this + network. ovn-bridge-mappings is a list of network names + mapped to a local OVS bridge that provides access to that network. An + example of configuring ovn-bridge-mappings would be: + + 
$ ovs-vsctl set open . external-ids:ovn-bridge-mappings=physnet1:br-eth0,physnet2:br-eth1
+ +

+ When a logical switch has a localnet port attached, + every chassis that may have a local vif attached to that logical + switch must have a bridge mapping configured to reach that + localnet. Traffic that arrives on a + localnet port is never forwarded over a tunnel to + another chassis. +

+ + + +

- The tunnel ID must be unique within the scope of a logical datapath. + These options apply to logical ports with of + vtep.

- - - - For containers created inside a VM, this is taken from - - in the OVN_Northbound database's table. It is left empty if - belongs to a VM or a container created - in the hypervisor. - - -

- When is empty and - identifies the interface of a container spawned inside a VM, this column - identifies the VLAN tag in the network traffic associated with that - container's network interface. It is left empty if - belongs to a VM or a container created in the - hypervisor. -

- -

- When is set to localnet, this can be - set to indicate 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. -

- + + Required. The name of the VTEP gateway. + - - The physical location of the logical port. To successfully identify a - chassis, this column must be a record. This is - populated by ovn-controller/ovn-controller-vtep. - + + Required. A logical switch name connected by the VTEP gateway. Must + be set when is vtep. + + - +

- The Ethernet address or addresses used as a source address on the - logical port, each in the form - xx:xx:xx:xx:xx:xx. - The string unknown is also allowed to indicate that the - logical port has an unknown set of (additional) source addresses. + These columns support containers nested within a VM. They are empty + for containers or VMs that run directly on a hypervisor.

-

- A VM interface would ordinarily have a single Ethernet address. A - gateway port might initially only have unknown, and then - add MAC addresses to the set as it learns new source addresses. -

- + + This is taken from + + in the OVN_Northbound database's table. + + + +

+ When is empty and + identifies the interface of a container spawned inside a VM, this + column identifies the VLAN tag in the network traffic associated with + that container's network interface. It is left empty if belongs to a VM or a container created in the + hypervisor. +

+ +

+ When is set to localnet, this can + be set to indicate 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. +

+ +