From patchwork Sun Oct 30 13:29:53 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 688940 X-Patchwork-Delegate: rbryant@redhat.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from archives.nicira.com (archives.nicira.com [96.126.127.54]) by ozlabs.org (Postfix) with ESMTP id 3t6JPc07Lhz9t1T for ; Mon, 31 Oct 2016 00:34:27 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b=r9LB8OGd; dkim-atps=neutral Received: from archives.nicira.com (localhost [127.0.0.1]) by archives.nicira.com (Postfix) with ESMTP id 9DBF4105AB; Sun, 30 Oct 2016 06:34:20 -0700 (PDT) X-Original-To: dev@openvswitch.org Delivered-To: dev@openvswitch.org Received: from mx3v3.cudamail.com (mx3.cudamail.com [64.34.241.5]) by archives.nicira.com (Postfix) with ESMTPS id 260C010582 for ; Sun, 30 Oct 2016 06:34:19 -0700 (PDT) Received: from bar6.cudamail.com (localhost [127.0.0.1]) by mx3v3.cudamail.com (Postfix) with ESMTPS id B35F5164068 for ; Sun, 30 Oct 2016 07:34:18 -0600 (MDT) X-ASG-Debug-ID: 1477834457-0b32372045228c60001-byXFYA Received: from mx3-pf2.cudamail.com ([192.168.14.1]) by bar6.cudamail.com with ESMTP id Q1Bhl2VUnVgBY2mF (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Sun, 30 Oct 2016 07:34:17 -0600 (MDT) X-Barracuda-Envelope-From: stephen@that.guru X-Barracuda-RBL-Trusted-Forwarder: 192.168.14.1 Received: from unknown (HELO butterfly.birch.relay.mailchannels.net) (23.83.209.27) by mx3-pf2.cudamail.com with ESMTPS (DHE-RSA-AES256-SHA encrypted); 30 Oct 2016 13:34:16 -0000 Received-SPF: none (mx3-pf2.cudamail.com: domain at that.guru does not designate permitted sender hosts) X-Barracuda-Apparent-Source-IP: 23.83.209.27 X-Barracuda-RBL-IP: 23.83.209.27 X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 559DAA0DBB for ; Sun, 30 Oct 2016 13:32:07 +0000 (UTC) Received: from one.mxroute.com (ip-10-229-10-199.us-west-2.compute.internal [10.229.10.199]) by relay.mailchannels.net (Postfix) with ESMTPA id DC685A1347 for ; Sun, 30 Oct 2016 13:32:06 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([UNAVAILABLE]. [10.107.128.240]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Sun, 30 Oct 2016 13:32:07 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1477834327129:3592127446 X-MC-Ingress-Time: 1477834327128 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=NsAklXrgXxDFJWYTKCftqRJp56SqkM+WI/XkiV666ys=; b=r9LB8OGdMMBUfcbOujv/nTWSlo K4fp8ahiWm4DIRlve3ITCpAxIIMq7PS7axzj2MfQrdf2httgz3WBmOJyndZngtGIhH+XOiuM8O2+t SmFAhig2YGUs50wdolylFOh4akiGoVRNfvqFINdoBJHNSRKpdogdAaz0tGs+HJJJFT5h3I5k+YMY1 VMi3JVwSHpQgja2sL+rYlFTP5088ErqKM7cDD4rUzoCmjBry3oWMGlMxgnx4WjUenetF9O+sz3Cbv GbJ5sdjUdtrumu+o0sW6zY8vIg0YDnQMw8e3jjGWEiFgatMw165f3f+9GAiF8RYRoxM2mb9yhwf79 Zmfsyu1A==; X-CudaMail-Envelope-Sender: stephen@that.guru From: Stephen Finucane To: dev@openvswitch.org X-CudaMail-MID: CM-V2-1029004448 X-CudaMail-DTE: 103016 X-CudaMail-Originating-IP: 23.83.209.27 Date: Sun, 30 Oct 2016 13:29:53 +0000 X-ASG-Orig-Subj: [##CM-V2-1029004448##][PATCH 07/23] doc: Convert third-party/README to rST Message-Id: <1477834209-11414-8-git-send-email-stephen@that.guru> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1477834209-11414-1-git-send-email-stephen@that.guru> References: <1477834209-11414-1-git-send-email-stephen@that.guru> X-OutGoing-Spam-Status: No, score=-9.2 X-AuthUser: stephen@that.guru X-GBUdb-Analysis: 0, 23.83.209.27, Ugly c=0 p=0 Source New X-MessageSniffer-Rules: 0-0-0-8548-c X-Barracuda-Connect: UNKNOWN[192.168.14.1] X-Barracuda-Start-Time: 1477834457 X-Barracuda-Encrypted: DHE-RSA-AES256-SHA X-Barracuda-URL: https://web.cudamail.com:443/cgi-mod/mark.cgi X-Virus-Scanned: by bsmtpd at cudamail.com X-Barracuda-BRTS-Status: 1 X-Barracuda-Spam-Score: 1.10 X-Barracuda-Spam-Status: No, SCORE=1.10 using global scores of TAG_LEVEL=3.5 QUARANTINE_LEVEL=1000.0 KILL_LEVEL=4.0 tests=BSF_SC0_MV0713, BSF_SC5_MJ1963, DKIM_SIGNED, RDNS_NONE X-Barracuda-Spam-Report: Code version 3.2, rules version 3.2.3.34168 Rule breakdown below pts rule name description ---- ---------------------- -------------------------------------------------- 0.00 DKIM_SIGNED Domain Keys Identified Mail: message has a signature 0.10 RDNS_NONE Delivered to trusted network by a host with no rDNS 0.50 BSF_SC0_MV0713 Custom rule MV0713 0.50 BSF_SC5_MJ1963 Custom Rule MJ1963 Subject: [ovs-dev] [PATCH 07/23] doc: Convert third-party/README to rST 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" Signed-off-by: Stephen Finucane --- third-party/README.md | 38 ---------------------------- third-party/README.rst | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ third-party/automake.mk | 2 +- 3 files changed, 67 insertions(+), 39 deletions(-) delete mode 100644 third-party/README.md create mode 100644 third-party/README.rst diff --git a/third-party/README.md b/third-party/README.md deleted file mode 100644 index d351d77..0000000 --- a/third-party/README.md +++ /dev/null @@ -1,38 +0,0 @@ -Third-party software integration -================================ - -This directory contains third-party software that may be useful for -debugging. - -tcpdump -------- -The "ofp-tcpdump.patch" patch adds the ability to parse OpenFlow -messages to tcpdump. These instructions assume that tcpdump 4.3.0 -is going to be used, but it should work with other versions that are not -substantially different. To begin, download tcpdump and apply the -patch: - - wget http://www.tcpdump.org/release/tcpdump-4.3.0.tar.gz - tar xzf tcpdump-4.3.0.tar.gz - ln -s tcpdump-4.3.0 tcpdump - patch -p0 < ofp-tcpdump.patch - -Then build the new version of tcpdump: - - cd tcpdump - ./configure - make - -Clearly, tcpdump can only parse unencrypted packets, so you will need to -connect the controller and datapath using plain TCP. To look at the -traffic, tcpdump will be started in a manner similar to the following: - - sudo ./tcpdump -s0 -i eth0 port 6653 - -The "-s0" flag indicates that tcpdump should capture the entire packet. -If the OpenFlow message is not received in its entirety, "[|openflow]" will -be printed instead of the OpenFlow message contents. - -The verbosity of the output may be increased by adding additional "-v" -flags. If "-vvv" is used, the raw OpenFlow data is also printed in -hex and ASCII. diff --git a/third-party/README.rst b/third-party/README.rst new file mode 100644 index 0000000..9d536c3 --- /dev/null +++ b/third-party/README.rst @@ -0,0 +1,66 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +================================ +Third-party software integration +================================ + +This directory contains third-party software that may be useful for debugging. + +tcpdump +------- + +The ``ofp-tcpdump.patch`` patch adds the ability to parse OpenFlow messages to +tcpdump. These instructions assume that tcpdump 4.3.0 is going to be used, but +it should work with other versions that are not substantially different. To +begin, download tcpdump and apply the patch: + +:: + + $ wget http://www.tcpdump.org/release/tcpdump-4.3.0.tar.gz + $ tar xzf tcpdump-4.3.0.tar.gz + $ ln -s tcpdump-4.3.0 tcpdump + $ patch -p0 < ofp-tcpdump.patch + +Then build the new version of tcpdump: + +:: + + $ cd tcpdump + $ ./configure + $ make + +Clearly, tcpdump can only parse unencrypted packets, so you will need to +connect the controller and datapath using plain TCP. To look at the traffic, +tcpdump will be started in a manner similar to the following: + +:: + + $ sudo ./tcpdump -s0 -i eth0 port 6653 + +The ``-s0`` flag indicates that tcpdump should capture the entire packet. If +the OpenFlow message is not received in its entirety, ``[|openflow]`` will be +printed instead of the OpenFlow message contents. + +The verbosity of the output may be increased by adding additional ``-v`` flags. +If ``-vvv`` is used, the raw OpenFlow data is also printed in hex and ASCII. diff --git a/third-party/automake.mk b/third-party/automake.mk index fea5ac7..9eaf02f 100644 --- a/third-party/automake.mk +++ b/third-party/automake.mk @@ -1,2 +1,2 @@ -docs += third-party/README.md +docs += third-party/README.rst EXTRA_DIST += third-party/ofp-tcpdump.patch