diff --git a/ovn/ovn-sb.xml b/ovn/ovn-sb.xml index 2664cd4ca0e..f9e21c6f672 100644 --- a/ovn/ovn-sb.xml +++ b/ovn/ovn-sb.xml @@ -957,152 +957,160 @@ 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. +

+
+ + + 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. + +
+ +

- 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. Specifically, + they are used when is empty and identifies the interface of a container spawned + inside 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. + + + +

+ Identifies the VLAN tag in the network traffic associated with that + container's network interface. +

+ +

+ This column is used for a different purpose when + is localnet (see Localnet Options, above). +

+
+