Updates Faucet tutorial to work with newer versions than 1.6.7.

Tutorial now shows how to check out latest tag from Faucet's git.

Tutorial now sets minimum_ip_size_check flag to False so that the
payloadless packets generated by ofproto/trace aren't dropped by Faucet.

Signed-off-by: Brad Cowie <[email protected]>
---
 Documentation/tutorials/faucet.rst | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/Documentation/tutorials/faucet.rst 
b/Documentation/tutorials/faucet.rst
index 2777924..5d229eb 100644
--- a/Documentation/tutorials/faucet.rst
+++ b/Documentation/tutorials/faucet.rst
@@ -28,9 +28,9 @@ OVS Faucet Tutorial
 This tutorial demonstrates how Open vSwitch works with a general-purpose
 OpenFlow controller, using the Faucet controller as a simple way to get
 started.  It was tested with the "master" branch of Open vSwitch and version
-1.6.7 of Faucet in October 2017.  It does not use advanced or recently added
-features in OVS or Faucet, so other versions of both pieces of software are
-likely to work equally well.
+1.6.15 of Faucet.  It does not use advanced or recently added features in OVS
+or Faucet, so other versions of both pieces of software are likely to work
+equally well.
 
 The goal of the tutorial is to demonstrate Open vSwitch and Faucet in an
 end-to-end way, that is, to show how it works from the Faucet controller
@@ -125,7 +125,8 @@ between one and the other.
 
    At this point I checked out the latest tag::
 
-     $ git checkout v1.6.7
+     $ latest_tag=$(git describe --tags $(git rev-list --tags --max-count=1))
+     $ git checkout $latest_tag
 
 2. Build a docker container image::
 
@@ -920,8 +921,11 @@ Now let's start over, adding L3 routing into the picture.
 
 It's remarkably easy to enable routing.  We just change our ``vlans``
 section in ``inst/faucet.yaml`` to specify a router IP address for
-each VLAN and define a router between them.  The ``dps`` section is
-unchanged::
+each VLAN and define a router between them. For our example we need to
+set ``minimum_ip_size_check`` to ``False``, this will disable a sanity
+check in Faucet that will allow it to accept packets generated by
+``ofproto/trace``, normally in production you would not turn this off.
+The ``dps`` section is unchanged::
 
   dps:
       switch-1:
@@ -942,8 +946,10 @@ unchanged::
   vlans:
       100:
           faucet_vips: ["10.100.0.254/24"]
+          minimum_ip_size_check: False
       200:
           faucet_vips: ["10.200.0.254/24"]
+          minimum_ip_size_check: False
   routers:
       router-1:
           vlans: [100, 200]
@@ -1336,8 +1342,10 @@ the ways that OVS tries to optimize megaflows.  Update
   vlans:
       100:
          faucet_vips: ["10.100.0.254/24"]
+         minimum_ip_size_check: False
       200:
          faucet_vips: ["10.200.0.254/24"]
+         minimum_ip_size_check: False
   routers:
       router-1:
          vlans: [100, 200]
-- 
2.7.4

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to