<p>
This database is the interface between OVN and the cloud management system
(CMS), such as OpenStack, running above it. The CMS produces almost all of
- the contents of the database. The <code>ovn-nbd</code> program monitors
- the database contents, transforms it, and stores it into the <ref
+ the contents of the database. The <code>ovn-northd</code> program
+ monitors the database contents, transforms it, and stores it into the <ref
db="OVN_Southbound"/> database.
</p>
<table name="Logical_Switch" title="L2 logical switch">
<p>
- Each row represents one L2 logical switch. A given switch's ports are
- the <ref table="Logical_Port"/> rows whose <ref table="Logical_Port"
- column="lswitch"/> column points to its row.
+ Each row represents one L2 logical switch.
</p>
<column name="name">
</p>
</column>
+ <column name="ports">
+ <p>
+ The logical ports connected to the logical switch.
+ </p>
+
+ <p>
+ It is an error for multiple logical switches to include the same
+ logical port.
+ </p>
+ </column>
+
<column name="router_port">
<p>
The router port to which this logical switch is connected, or empty if
restriction because logical routers may be connected into arbitrary
topologies.
</p>
+
+ <p>
+ It is an error for multiple logical switches to refer to the same
+ router port.
+ </p>
+ </column>
+
+ <column name="acls">
+ Access control rules that apply to packets within the logical switch.
</column>
<group title="Common Columns">
A port within an L2 logical switch.
</p>
- <column name="lswitch">
- The logical switch to which the logical port is connected.
- </column>
-
<column name="name">
<p>
The logical port name.
</p>
</column>
+ <column name="type">
+ <p>
+ Specify 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.
+ </p>
+
+ <p>
+ There are no other logical port types implemented yet.
+ </p>
+ </column>
+
+ <column name="options">
+ This column provides key/value settings specific to the logical port
+ <ref column="type"/>.
+ </column>
+
<column name="parent_name">
When <ref column="name"/> identifies the interface of a container
spawned inside a tenant VM, this column represents the VM interface
</column>
<column name="up">
- This column is populated by <code>ovn-nbd</code>, rather than by the CMS
- plugin as is most of this database. When a logical port is bound
+ This column is populated by <code>ovn-northd</code>, rather than by
+ the CMS plugin as is most of this database. When a logical port is bound
to a physical location in the OVN Southbound database <ref
- db="OVN_Southbound" table="Bindings"/> table, <code>ovn-nbd</code>
+ db="OVN_Southbound" table="Binding"/> table, <code>ovn-northd</code>
sets this column to <code>true</code>; otherwise, or if the port
becomes unbound later, it sets it to <code>false</code>. This
allows the CMS to wait for a VM's (or container's) networking to
become active before it allows the VM (or container) to start.
</column>
+ <column name="enabled">
+ This column is used to administratively set port state. If this column is
+ empty or is set to <code>true</code>, the port is enabled. If this column
+ is set to <code>false</code>, the port is disabled. A disabled port has all
+ ingress and egress traffic dropped.
+ </column>
+
<column name="macs">
The logical port's own Ethernet address or addresses, each in the form
<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
<column name="port_security">
<p>
- A set of L2 (Ethernet) or L3 (IPv4 or IPv6) addresses or L2+L3 pairs
+ A set of L2 (Ethernet) addresses
from which the logical port is allowed to send packets and to which it
is allowed to receive packets. If this column is empty, all addresses
- are permitted.
+ are permitted. Logical ports are always allowed to receive packets
+ addressed to multicast and broadcast addresses.
</p>
<p>
- Exact syntax is TBD. One could simply use comma- or
- space-separated L2 and L3 addresses in each set member, or
- replace this by a subset of the general-purpose expression
- language used for the <ref column="match" table="Pipeline"
- db="OVN_Southbound"/> column in the OVN Southbound database's
- <ref table="Pipeline" db="OVN_Southbound"/> table.
+ Each member of the set is an Ethernet address in the form
+ <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
+ </p>
+
+ <p>
+ This specification will be extended to support L3 port security.
</p>
</column>
<table name="ACL" title="Access Control List (ACL) rule">
<p>
- Each row in this table represents one ACL rule for the logical switch in
- its <ref column="lswitch"/> column. The <ref column="action"/> column for
- the highest-<ref column="priority"/> matching row in this table
- determines a packet's treatment. If no row matches, packets are allowed
- by default. (Default-deny treatment is possible: add a rule with <ref
- column="priority"/> 0, <code>true</code> as <ref column="match"/>, and
- <code>deny</code> as <ref column="action"/>.)
+ Each row in this table represents one ACL rule for a logical switch
+ that points to it through its <ref column="acls"/> column. The <ref
+ column="action"/> column for the highest-<ref column="priority"/>
+ matching row in this table determines a packet's treatment. If no row
+ matches, packets are allowed by default. (Default-deny treatment is
+ possible: add a rule with <ref column="priority"/> 1, <code>1</code> as
+ <ref column="match"/>, and <code>deny</code> as <ref column="action"/>.)
</p>
- <column name="lswitch">
- The switch to which the ACL rule applies. The expression in the
- <ref column="match"/> column may match against logical ports
- within this switch.
- </column>
-
<column name="priority">
The ACL rule's priority. Rules with numerically higher priority take
precedence over those with lower. If two ACL rules with the same
</column>
<column name="match">
- The packets that the ACL should match, in the same expression
- language used for the <ref column="match" table="Pipeline"
+ The packets that the ACL should match, in the same expression language
+ used for the <ref column="match" table="Logical_Flow"
db="OVN_Southbound"/> column in the OVN Southbound database's <ref
- table="Pipeline" db="OVN_Southbound"/> table. Match
- <code>inport</code> and <code>outport</code> against names of
- logical ports within <ref column="lswitch"/> to implement ingress
- and egress ACLs, respectively. In logical switches connected to
- logical routers, the special port name <code>ROUTER</code> refers
- to the logical router port.
+ table="Logical_Flow" db="OVN_Southbound"/> table. Match
+ <code>inport</code> and <code>outport</code> against names of logical
+ ports within <ref column="lswitch"/> to implement ingress and egress
+ ACLs, respectively. In logical switches connected to logical routers,
+ the special port name <code>ROUTER</code> refers to the logical router
+ port.
</column>
<column name="action">
<p>The action to take when the ACL rule matches:</p>
<ul>
- <li>
- <code>allow</code>: Forward the packet.
- </li>
-
- <li>
- <code>allow-related</code>: Forward the packet and related traffic
- (e.g. inbound replies to an outbound connection).
- </li>
-
- <li>
- <code>drop</code>: Silently drop the packet.
- </li>
-
- <li>
- <code>reject</code>: Drop the packet, replying with a RST for TCP or
- ICMP unreachable message for other IP-based protocols.
- </li>
+ <li>
+ <code>allow</code>: Forward the packet.
+ </li>
+
+ <li>
+ <code>allow-related</code>: Forward the packet and related traffic
+ (e.g. inbound replies to an outbound connection).
+ </li>
+
+ <li>
+ <code>drop</code>: Silently drop the packet.
+ </li>
+
+ <li>
+ <code>reject</code>: Drop the packet, replying with a RST for TCP or
+ ICMP unreachable message for other IP-based protocols.
+ </li>
</ul>
+
+ <p>
+ Only <code>allow</code> and <code>drop</code> are implemented:
+ <code>allow-related</code> is currently treated as <code>allow</code>,
+ and <code>reject</code> as <code>drop</code>.
+ </p>
</column>
<column name="log">
- If set to <code>true</code>, packets that match the ACL will trigger a
- log message on the transport node or nodes that perform ACL processing.
- Logging may be combined with any <ref column="action"/>.
+ <p>
+ If set to <code>true</code>, packets that match the ACL will trigger a
+ log message on the transport node or nodes that perform ACL processing.
+ Logging may be combined with any <ref column="action"/>.
+ </p>
+
+ <p>
+ Logging is not yet implemented.
+ </p>
</column>
<group title="Common Columns">
<table name="Logical_Router" title="L3 logical router">
<p>
- Each row represents one L3 logical router. A given router's ports are
- the <ref table="Logical_Router_Port"/> rows whose <ref
- table="Logical_Router_Port" column="router"/> column points to its row.
+ Each row represents one L3 logical router.
</p>
- <column name="ip">
- The logical router's own IP address. The logical router uses this
- address for ICMP replies (e.g. network unreachable messages) and other
- traffic that it originates and responds to traffic destined to this
- address (e.g. ICMP echo requests).
+ <column name="name">
+ <p>
+ A name for the logical router. 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's UUID should be used as the unique identifier.
+ </p>
+ </column>
+
+ <column name="ports">
+ The router's ports. This is a set of weak references, so a <ref
+ table="Logical_Switch"/> must also refer to any given <ref
+ table="Logical_Router_Port"/> or it will automatically be deleted.
</column>
<column name="default_gw">
</p>
<p>
- A router port is always attached to a switch port. The connection can be
- identified by following the <ref column="router_port"
- table="Logical_Port"/> column from an appropriate <ref
- table="Logical_Port"/> row.
+ A router port is always attached to a logical switch and to a logical
+ router. The former attachment, which is enforced by the database schema,
+ can be identified by finding the <ref table="Logical_Switch"/> row whose
+ <ref column="router_port" table="Logical_Switch"/> column points to the
+ router port. The latter attachment, which the database schema does not
+ enforce, can be identified by finding the <ref table="Logical_Router"/>
+ row whose <ref column="ports" table="Logical_Router"/> column includes
+ the router port.
</p>
- <column name="router">
- The router to which the port belongs.
+ <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.
+ </p>
</column>
<column name="network">
- The IP network and netmask of the network on the router port. Used for
- routing.
+ The IP address of the router and the netmask. For example,
+ <code>192.168.0.1/24</code> indicates that the router's IP address is
+ 192.168.0.1 and that packets destined to 192.168.0.<var>x</var> should be
+ routed to this port.
</column>
<column name="mac">
projects / cascardo / ovs.git / blobdiff