lab/mininet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adjust README slightly to be markdown-compatible.

Browse Source
This commit is contained in:
Bob Lantz
2012-08-23 18:27:48 -07:00
parent 4f33cad025
commit 62499d96df
1 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README
+10 -11
View File
@@ -1,12 +1,12 @@
Mininet: A Simple Virtual Testbed for OpenFlow/SDN Mininet: A Simple Virtual Testbed for OpenFlow/SDN
or or
How to Squeeze an OpenFlow Network onto your Laptop How to Squeeze an OpenFlow Network onto your Laptop
Mininet 2.0.0d2 Mininet 2.0.0d2
--- ---
Welcome to Mininet! **Welcome to Mininet!**
Mininet creates OpenFlow test networks by using process-based Mininet creates OpenFlow test networks by using process-based
virtualization and network namespaces. virtualization and network namespaces.
@@ -22,14 +22,14 @@ handy Python API for creating networks of varying sizes and topologies.
In order to run Mininet, you must have: In order to run Mininet, you must have:
* A Linux kernel compiled with network namespace support * A Linux kernel compiled with network namespace support
enabled (see INSTALL for additional information.) enabled (see `INSTALL` for additional information.)
* An OpenFlow implementation (either the reference user or kernel * An OpenFlow implementation (either the reference user or kernel
space implementations, or Open vSwitch.) Appropriate kernel modules space implementations, or Open vSwitch.) Appropriate kernel modules
(e.g. tun and ofdatapath for the reference kernel implementation) must (e.g. tun and ofdatapath for the reference kernel implementation) must
be loaded. be loaded.
* Python, bash, ping, iperf, etc. * Python, `bash`, `ping`, `iperf`, etc.
* Root privileges (required for network device access) * Root privileges (required for network device access)
@@ -42,7 +42,7 @@ Currently Mininet includes:
topologies (Topo subclasses.) For example, a tree network may be created topologies (Topo subclasses.) For example, a tree network may be created
with the command with the command
# mn --topo tree,depth=2,fanout=3 `# mn --topo tree,depth=2,fanout=3`
- Basic tests, including connectivity (ping) and bandwidth (iperf) - Basic tests, including connectivity (ping) and bandwidth (iperf)
@@ -50,15 +50,15 @@ Currently Mininet includes:
diagnostic commands, as well as the ability to send a command to a diagnostic commands, as well as the ability to send a command to a
node. For example, node. For example,
mininet> h11 ifconfig -a `mininet> h11 ifconfig -a`
tells host h11 to run the command 'ifconfig -a' tells host h11 to run the command `ifconfig -a`
- A 'cleanup' command to get rid of junk (interfaces, processes, files in - A 'cleanup' command to get rid of junk (interfaces, processes, files in
/tmp, etc.) which might be left around by Mininet or Linux. Try this if /tmp, etc.) which might be left around by Mininet or Linux. Try this if
things stop working! things stop working!
# mn -c `# mn -c`
- Examples (in the examples/ directory) to help you get started. - Examples (in the examples/ directory) to help you get started.
@@ -68,12 +68,11 @@ However, some preliminary installation notes are included in the INSTALL
file. file.
Additionally, much useful information, including a Mininet tutorial, Additionally, much useful information, including a Mininet tutorial,
is available on the Mininet wiki: is available on the [Mininet Wiki](http://openflow.org/mininet).
http://openflow.org/mininet
Enjoy, and good luck! Enjoy, and good luck!
--- ---
Bob Lantz Bob Lantz
rlantz@cs.stanford.edu rlantz@cs.stanford.edu