@@ -8,7 +8,82 @@
<h1>Description</h1>
<p>
- stub
+ <code>ovn-pinctrl</code> is a supplement to <code>ovn-controller></code>
+ whose main duty is to handle packets bound for the controller. It
+ handles a variety of application protocols on behalf of the logical
+ network. The list of supported protocols can be found below.
+ </p>
+
+ <h1>DHCP</h1>
+ <p>
+ If DHCP options have been configured for a logical switch, then
+ <code>ovn-pinctrl</code> will handle incoming DHCP packets and respond
+ to them with the configured address values. For more information on
+ possible DHCP settings, see <code>ovn-nb</code>(5).
+ </p>
+
+ <h1>DNS</h1>
+ <p>
+ If DNS records have been configured in the northbound database, then
+ <code>ovn-pinctrl</code> will respond to DNS queries that pertain to
+ the configured domains. For more information on DNS configuration, see
+ <code>ovn-nb</code>(5).
+ </p>
+
+ <h1>ARP(IPv4) and Neighbor Discovery(IPv6)</h1>
+ <p>
+ <code>ovn-pinctrl</code> can respond to incoming ARP and neighbor
+ solicitation requests based on learned MAC bindings.
+ </p>
+
+ <h1>IGMP</h1>
+ <p>
+ If IGMP has been configured in the northbound database, then
+ <code>ovn-pinctrl</code> will handle incoming IGMP membership
+ reports. It will use the data in the IGMP messages to set data
+ in the southbound database that will alter the destinations of
+ multicast traffic. For more information on IGMP settings, see
+ <code>ovn-nb</code>(5). For more information regarding the ways
+ that IGMP traffic affects the resulting flows, see
+ <code>ovn-architecture</code>(7).
+ </p>
+
+ <h1>Other pinctrl operations</h1>
+ <p>
+ In addition to the higher-level protocols listed above,
+ <code>ovn-pinctrl</code> also has other duties.
+ <ul>
+ <li>
+ <p>
+ It can send ICMP responses to certain incoming packet types.
+ </p>
+ </li>
+ <li>
+ <p>
+ It can send TCP resets based on <code>reject</code> ACLs.
+ </p>
+ </li>
+ <li>
+ <p>
+ It can send messages to the logs based on configured ACLs.
+ </p>
+ </li>
+ <li>
+ <p>
+ It can create Controller_Events in certain circumstances.
+ </p>
+ </li>
+ <li>
+ <p>
+ It can send periodic router advertisements if configured.
+ </p>
+ </li>
+ <li>
+ <p>
+ It can bind switch ports of type <code>virtual</code>.
+ </p>
+ </li>
+ </ul>
</p>
<h1>Options</h1>
Signed-off-by: Mark Michelson <mmichels@redhat.com> --- pinctrl/ovn-pinctrl.8.xml | 77 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 76 insertions(+), 1 deletion(-)