From patchwork Thu Dec 8 12:55:27 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 704065 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org 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 3tZFqz2rymz9sBv for ; Fri, 9 Dec 2016 00:01:51 +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="MmY1Irey"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id CF948BF0; Thu, 8 Dec 2016 12:56:07 +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 465FAB77 for ; Thu, 8 Dec 2016 12:56:06 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from nov-007-i609.relay.mailchannels.net (nov-007-i609.relay.mailchannels.net [46.232.183.163]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id C8744140 for ; Thu, 8 Dec 2016 12:55:58 +0000 (UTC) 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 65369228B0 for ; Thu, 8 Dec 2016 12:55:54 +0000 (UTC) Received: from one.mxroute.com (ip-10-229-2-62.us-west-2.compute.internal [10.229.2.62]) by relay.mailchannels.net (Postfix) with ESMTPA id BC27020663 for ; Thu, 8 Dec 2016 12:55:53 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([TEMPUNAVAIL]. [10.107.128.240]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Thu, 08 Dec 2016 12:55:54 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1481201753997:3610766135 X-MC-Ingress-Time: 1481201753997 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=eS4HD/nQOG3RpOqBNfvDPTG2qEAtA+owgowJmPqr/HQ=; b=MmY1IreyJlpZd/L1dXgfcX0tcV LKgNgQvd7we5Bu88CFH1HOrGvEdfYdbSmjAYXItd8CbVyOLx7CHRTTxu1N/p3FyIZE5YNxya7CbbO vd9y47oGNinK4cCU4lL1p+H8JAGZl9EXYV8zKzWusnKaorCntb5XmorI4M+i7GiuHP/J6TgznD3X3 gRAxtQHiP0cXC2abRZXp/30jynCwrTPmKafKMbfw9MSxqsaEYLgCpENVuMUg/W0Aw0RI6NcUQaAKC xDok2KgER98EY70v559GNIfnQ6gCizd9GNO92Eo28Oe2wsoo//LAohNQuBy/wn6/USvXZCEJdVMV0 CRXu5ZWg==; From: Stephen Finucane To: dev@openvswitch.org Date: Thu, 8 Dec 2016 12:55:27 +0000 Message-Id: <20161208125530.17283-9-stephen@that.guru> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20161208125530.17283-1-stephen@that.guru> References: <20161208125530.17283-1-stephen@that.guru> X-AuthUser: stephen@that.guru X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH v2 08/11] doc: Populate 'tutorials' section 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 Rename 'tutorial' to 'ovs-advanced' and 'ovn-tutorial' to 'ovn-basics'. Signed-off-by: Stephen Finucane --- Documentation/automake.mk | 2 ++ Documentation/index.rst | 3 ++- Documentation/tutorials/index.rst | 9 +++++++++ .../tutorials/ovn-basics.rst | 10 ++++------ .../tutorials/ovs-advanced.rst | 16 +++++++--------- FAQ.rst | 2 +- README.rst | 2 +- tutorial/automake.mk | 3 --- tutorial/ovn/env1/setup.sh | 2 +- tutorial/ovn/env6/setup.sh | 2 +- 10 files changed, 28 insertions(+), 23 deletions(-) rename tutorial/ovn-tutorial.rst => Documentation/tutorials/ovn-basics.rst (99%) rename tutorial/tutorial.rst => Documentation/tutorials/ovs-advanced.rst (98%) diff --git a/Documentation/automake.mk b/Documentation/automake.mk index 5fc67b0..1f9800f 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -20,6 +20,8 @@ EXTRA_DIST += \ Documentation/intro/install/windows.rst \ Documentation/intro/install/xenserver.rst \ Documentation/tutorials/index.rst \ + Documentation/tutorials/ovn-basics.rst \ + Documentation/tutorials/ovs-advanced.rst \ Documentation/topics/index.rst \ Documentation/topics/bonding.rst \ Documentation/topics/datapath.rst \ diff --git a/Documentation/index.rst b/Documentation/index.rst index be794f1..f15993f 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -55,7 +55,8 @@ vSwitch? Start here. :doc:`intro/install/xenserver` | :doc:`intro/install/dpdk` -- **Tutorials:** **TODO** +- **Tutorials:** :doc:`tutorials/ovs-advanced` | + :doc:`tutorials/ovn-basics` Deeper Dive ----------- diff --git a/Documentation/tutorials/index.rst b/Documentation/tutorials/index.rst index eebd242..477cadb 100644 --- a/Documentation/tutorials/index.rst +++ b/Documentation/tutorials/index.rst @@ -30,5 +30,14 @@ Tutorials Getting started with Open vSwitch (OVS) and Open Virtual Network (OVN) for Open vSwitch. +.. TODO(stephenfin): We could really do with a few basic tutorials, along with + some more specialized ones (DPDK, XenServer, Windows). The latter could + probably be formed from the install guides, but the former will need to be + produced from scratch or reproduced from blogs (with permission of the + author) + .. toctree:: :maxdepth: 2 + + ovs-advanced + ovn-basics diff --git a/tutorial/ovn-tutorial.rst b/Documentation/tutorials/ovn-basics.rst similarity index 99% rename from tutorial/ovn-tutorial.rst rename to Documentation/tutorials/ovn-basics.rst index bb5f620..8115edd 100644 --- a/tutorial/ovn-tutorial.rst +++ b/Documentation/tutorials/ovn-basics.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -============ -OVN Tutorial -============ +========== +OVN Basics +========== This tutorial is intended to give you a tour of the basic OVN features using ``ovs-sandbox`` as a simulated test environment. It's assumed that you have an @@ -873,12 +873,10 @@ of what the resulting OpenFlow flows look like. Container Ports --------------- -.. TODO(stephenfin): Update Docker link when this is moved. - OVN supports containers running directly on the hypervisors and running containers inside VMs. This example shows how OVN supports network virtualization to containers when run inside VMs. Details about how to use -docker containers in OVS can be found in the `Docker installlation guide`. +docker containers in OVS can be found in :doc:`/howto/docker`. To support container traffic created inside a VM and to distinguish network traffic coming from different container vifs, for each container a logical port diff --git a/tutorial/tutorial.rst b/Documentation/tutorials/ovs-advanced.rst similarity index 98% rename from tutorial/tutorial.rst rename to Documentation/tutorials/ovs-advanced.rst index 422bc0d..4ae27ce 100644 --- a/tutorial/tutorial.rst +++ b/Documentation/tutorials/ovs-advanced.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -======================================= -Open vSwitch Advanced Features Tutorial -======================================= +============================== +Open vSwitch Advanced Features +============================== Many tutorials cover the basics of OpenFlow. This is not such a tutorial. Rather, a knowledge of the basics of OpenFlow is a prerequisite. If you do not @@ -54,18 +54,16 @@ hardware or even supervisor privilege on your system. Instead, we will use a script called ``ovs-sandbox``, which accompanies the tutorial, that constructs a software simulated network environment based on Open vSwitch. -.. TODO(stephenfin): Update installation guide link when this is moved. - You can use ``ovs-sandbox`` three ways: * If you have already installed Open vSwitch on your system, then you should be able to just run ``ovs-sandbox`` from this directory without any options. * If you have not installed Open vSwitch (and you do not want to install it), - then you can build Open vSwitch according to the instructions in the - `installation guide`, without installing it. Then run ``./ovs-sandbox -b - DIRECTORY`` from this directory, substituting the Open vSwitch build - directory for ``DIRECTORY``. + then you can build Open vSwitch according to the instructions in + :doc:`/intro/install/general`, without installing it. Then run + ``./ovs-sandbox -b DIRECTORY`` from this directory, substituting the Open + vSwitch build directory for ``DIRECTORY``. * As a slight variant on the latter, you can run ``make sandbox`` from an Open vSwitch build directory. diff --git a/FAQ.rst b/FAQ.rst index c072d10..aa21d91 100644 --- a/FAQ.rst +++ b/FAQ.rst @@ -2034,7 +2034,7 @@ Q: The "learn" action can't learn the action I want, can you improve it? http://openvswitch.org/pipermail/discuss/2016-June/021694.html - MAC learning in the middle of a pipeline, as described in `the tutorial - `__. + `__. - TCP state based firewalling, by learning outgoing connections based on SYN packets and matching them up with incoming packets. diff --git a/README.rst b/README.rst index c8227f8..dd4405a 100644 --- a/README.rst +++ b/README.rst @@ -84,7 +84,7 @@ installation guides `__ For answers to common questions, refer to the `FAQ `__. To learn about some advanced features of the Open vSwitch software switch, read -the `tutorial `__. +the `tutorial `__. Each Open vSwitch userspace program is accompanied by a manpage. Many of the manpages are customized to your configuration as part of the build process, so diff --git a/tutorial/automake.mk b/tutorial/automake.mk index 79f9b68..5509062 100644 --- a/tutorial/automake.mk +++ b/tutorial/automake.mk @@ -1,6 +1,3 @@ -docs += \ - tutorial/tutorial.rst \ - tutorial/ovn-tutorial.rst EXTRA_DIST += \ tutorial/ovs-sandbox \ tutorial/t-setup \ diff --git a/tutorial/ovn/env1/setup.sh b/tutorial/ovn/env1/setup.sh index 80a5d0d..a9c6f39 100755 --- a/tutorial/ovn/env1/setup.sh +++ b/tutorial/ovn/env1/setup.sh @@ -14,7 +14,7 @@ # # -# See "Simple two-port setup" in tutorial/ovn-tutorial.rst. +# See "Simple two-port setup" in Documentation/tutorial/ovn-basics.rst. # set -o xtrace diff --git a/tutorial/ovn/env6/setup.sh b/tutorial/ovn/env6/setup.sh index 80a5d0d..a9c6f39 100755 --- a/tutorial/ovn/env6/setup.sh +++ b/tutorial/ovn/env6/setup.sh @@ -14,7 +14,7 @@ # # -# See "Simple two-port setup" in tutorial/ovn-tutorial.rst. +# See "Simple two-port setup" in Documentation/tutorial/ovn-basics.rst. # set -o xtrace