From d8ef79dff74146c1a48e946c42f0cf9720af3e3a Mon Sep 17 00:00:00 2001
From: Bob Lantz <rlantz@cs.stanford.edu>
Date: Fri, 11 Dec 2009 03:31:45 -0800
Subject: [PATCH] Tweaks for install and readme files.
---
INSTALL | 12 ++++++++----
README | 38 ++++++--------------------------------
2 files changed, 14 insertions(+), 36 deletions(-)
diff --git a/INSTALL b/INSTALL
index 2c1959ef..426c61d1 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,11 +1,15 @@
-Preliminary Installation Notes
+Preliminary Mininet Installation/Configuration Notes
+- Mininet is not currently 'installed.' If you want to install it,
+ so that you can 'import mininet', place it somewhere in your
+ python path.
+
- A functional netns binary is required to run mininet, but currently you
have to compile it and install it yourself from the included .c file:
to make it: make netns (or cc -o netns netns.c)
- to test it: ./netns /bin/echo
- to 'install' a link to it:
+ to test it: ./netns /sbin/ifconfig -a
+ to 'install' a link to it, you could do something like:
sudo ln -s /home/openflow/mininet/netns /usr/local/bin/netns
Installation is simplest with a distribution that includes a kernel
@@ -17,7 +21,7 @@ Preliminary Installation Notes
sudo aptitude/yum install iperf
- We assume you already have ping installed.
+ We assume you already have ping installed. ;-)
- You may need other packages to run the examples, e.g.
diff --git a/README b/README
index 6e9754a4..028ac473 100644
--- a/README
+++ b/README
@@ -24,12 +24,12 @@ In order to run Mininet, you must have:
datapath may be used, and the tun or ofdatapath kernel modules must be
loaded, respectively)
-* Python, Bash, etc.
+* Python, Bash, Ping, iPerf, etc.
-* Root privilieges (required for network device access)
+* Root privileges (required for network device access)
-* The netns program or equivalent (included as netns.c) installed
- in an appropriate path location.
+* The netns program (included as netns.c), or an equivalent program called
+ 'netns', installed in an appropriate path location.
* mininet.py installed in an appropriate Python path location.
@@ -41,41 +41,15 @@ Currently mininet includes:
- A simple network infrastructure (class Network and its descendants
TreeNet, GridNet and LinearNet) for creating scalable topologies and
running experiments (using someNetwork.run( test ) )
-
+
- Some simple tests which can be run using someNetwork.run( test )
- A simple command-line interface which may be invoked on a network using
.run( Cli )
- Examples (in examples/ directory) to help you get started.
-
-Notes and Advice:
-
-For scalable configurations, you may need to increase some of your kernel
-limits. For example, you could add something like the following to
-/etc/sysctl.conf:
-
-# OpenFlow: get rid of ipv6
-net.ipv6.conf.all.disable_ipv6 = 1
-net.ipv6.conf.default.disable_ipv6 = 1
-
-# Mininet: Increase open file limit
-fs.file-max = 100000
-
-# Mininet: increase network buffer space
-net.core.wmem_max = 16777216
-net.core.rmem_max = 16777216
-net.ipv4.tcp_rmem = 10240 87380 16777216
-net.ipv4.tcp_rmem = 10240 87380 16777216
-net.core.netdev_max_backlog = 5000
-
-# Mininet: increase arp cache size
-net.ipv4.neigh.default.gc_thresh1 = 4096
-net.ipv4.neigh.default.gc_thresh2 = 8192
-net.ipv4.neigh.default.gc_thresh3 = 16384
-# Mininet .... and increase routing table size
-net.ipv4.route.max_size=32768
+Some preliminary installation notes are included in the INSTALL file.
---
Bob Lantz
--
GitLab