From patchwork Fri Oct 18 20:42:59 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mark Michelson X-Patchwork-Id: 1179685 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=140.211.169.12; helo=mail.linuxfoundation.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=redhat.com Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 46vyj13RH2z9sNx for ; Sat, 19 Oct 2019 07:45:25 +1100 (AEDT) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 97A38D3D; Fri, 18 Oct 2019 20:43:08 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 679E5CD1 for ; Fri, 18 Oct 2019 20:43:06 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id ED67E70D for ; Fri, 18 Oct 2019 20:43:05 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 8DD6118CB91C for ; Fri, 18 Oct 2019 20:43:05 +0000 (UTC) Received: from monae.redhat.com (ovpn-122-41.rdu2.redhat.com [10.10.122.41]) by smtp.corp.redhat.com (Postfix) with ESMTP id E29ED79B4 for ; Fri, 18 Oct 2019 20:43:04 +0000 (UTC) From: Mark Michelson To: dev@openvswitch.org Date: Fri, 18 Oct 2019 16:42:59 -0400 Message-Id: <20191018204259.1113-6-mmichels@redhat.com> In-Reply-To: <20191018204259.1113-1-mmichels@redhat.com> References: <20191018204259.1113-1-mmichels@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.63]); Fri, 18 Oct 2019 20:43:05 +0000 (UTC) X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [RFC ovn PATCH 5/5] Flesh out manpage with more details about ovn-pinctrl X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org Signed-off-by: Mark Michelson --- pinctrl/ovn-pinctrl.8.xml | 77 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 76 insertions(+), 1 deletion(-) diff --git a/pinctrl/ovn-pinctrl.8.xml b/pinctrl/ovn-pinctrl.8.xml index c0322cd4b..df8e717ca 100644 --- a/pinctrl/ovn-pinctrl.8.xml +++ b/pinctrl/ovn-pinctrl.8.xml @@ -8,7 +8,82 @@

Description

- stub + ovn-pinctrl is a supplement to ovn-controller> + 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. +

+ +

DHCP

+

+ If DHCP options have been configured for a logical switch, then + ovn-pinctrl will handle incoming DHCP packets and respond + to them with the configured address values. For more information on + possible DHCP settings, see ovn-nb(5). +

+ +

DNS

+

+ If DNS records have been configured in the northbound database, then + ovn-pinctrl will respond to DNS queries that pertain to + the configured domains. For more information on DNS configuration, see + ovn-nb(5). +

+ +

ARP(IPv4) and Neighbor Discovery(IPv6)

+

+ ovn-pinctrl can respond to incoming ARP and neighbor + solicitation requests based on learned MAC bindings. +

+ +

IGMP

+

+ If IGMP has been configured in the northbound database, then + ovn-pinctrl 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 + ovn-nb(5). For more information regarding the ways + that IGMP traffic affects the resulting flows, see + ovn-architecture(7). +

+ +

Other pinctrl operations

+

+ In addition to the higher-level protocols listed above, + ovn-pinctrl also has other duties. +

    +
  • +

    + It can send ICMP responses to certain incoming packet types. +

    +
    • +
  • +

    + It can send TCP resets based on reject ACLs. +

    +
    • +
  • +

    + It can send messages to the logs based on configured ACLs. +

    +
    • +
  • +

    + It can create Controller_Events in certain circumstances. +

    +
    • +
  • +

    + It can send periodic router advertisements if configured. +

    +
    • +
  • +

    + It can bind switch ports of type virtual. +

    +
    • +

Options