Statistics
| Branch: | Tag: | Revision:

mininet / README.md @ 21b2c2c4

History | View | Annotate | Download (4.29 KB)

1

    
2
    Mininet: Rapid Prototyping for Software Defined Networks
3
                            or
4
    The best way to emulate almost any network on your laptop!
5

    
6
Mininet 2.0.0rc1
7

    
8
---
9
** Welcome to Mininet! **
10

    
11
Mininet creates virtual SDN/OpenFlow test networks by using process-based
12
virtualization and network namespaces.
13

    
14
Simulated hosts (as well as switches and controllers with the user
15
datapath) are created as processes in separate network namespaces. This
16
allows a complete OpenFlow network to be simulated on top of a single
17
Linux kernel.
18

    
19
Mininet's support for OpenFlow and Linux allows you to create a custom
20
network with customized routing, and to run almost any existing Linux
21
networking application on top of it without modification. OpenFlow-based
22
designs that work in Mininet can usually be transferred to hardware with
23
minimal change for full line-rate execution.
24

    
25
Mininet may be invoked directly from the command line, and also provides a
26
handy Python API for creating networks of varying sizes and topologies.
27

    
28
** Mininet 2.0.0rc1 **
29

    
30
Mininet 2.0.0rc1 is a major upgrade to the Mininet system and provides
31
a number of enhancements and new features, including:
32

    
33
* First-class Interface (`Intf`) and Link (`Link`) classes
34

    
35
* An upgraded Topology (`Topo`) class which supports node and link
36
  customization
37

    
38
* Link bandwidth limits using `tc` (`TCIntf` and `TCLink` classes)
39

    
40
* CPU isolation and bandwidth limits (`CPULimitedHost` class)
41

    
42
* Support for the Open vSwitch 1.4+ (including Ubuntu OVS packages)
43

    
44
* Man pages for the `mn` and `mnexec` utilities.
45

    
46
[Since the API (most notably the topology) has changed, existing code that
47
runs in Mininet 1.0 will need to be changed to run with Mininet 2.0. This
48
is the primary reason for the major version number change.]
49

    
50
Mininet also includes:
51

    
52
- A simple node infrastructure (`Host`, `Switch`, `Controller` classes) for
53
  creating virtual OpenFlow networks
54
	
55
- A simple network infrastructure (`Mininet` class) supporting parametrized
56
  topologies (`Topo` subclasses.) For example, a tree network may be created
57
  with the command
58
  
59
  `# mn --topo tree,depth=2,fanout=3`
60
  
61
- Basic tests, including connectivity (`ping`) and bandwidth (`iperf`)
62

    
63
- A command-line interface (CLI class) which provides useful 
64
  diagnostic commands, as well as the ability to send a command to a
65
  node. For example,
66
  
67
  `mininet> h11 ifconfig -a`
68
  
69
  tells host h11 to run the command `ifconfig -a`
70

    
71
- A 'cleanup' command to get rid of junk (interfaces, processes, files in
72
  /tmp, etc.) which might be left around by Mininet or Linux. Try this if 
73
  things stop working!
74
  
75
  `# mn -c`
76
  
77
- Examples (in the examples/ directory) to help you get started.
78

    
79
- Full API documentation via Python `help()` docstrings, as well as
80
  the ability to generate PDF/HTML documentation with "make doc."
81

    
82
In order to run Mininet, you must have:
83

    
84
* A Linux kernel compiled with network namespace support
85
  enabled (see `INSTALL` for additional information.)
86

    
87
* An OpenFlow implementation (either the reference user or kernel
88
  space implementations, or Open vSwitch.) Appropriate kernel modules
89
  (e.g. tun and ofdatapath for the reference kernel implementation) must
90
  be loaded.
91

    
92
* Python, `bash`, `ping`, `iperf`, etc.
93

    
94
* Root privileges (required for network device access)
95

    
96
Installation instructions are available in INSTALL
97

    
98
*** Mininet Documentation ***
99

    
100
In addition to the API documentation (`make doc`) much useful information,
101
including a Mininet walkthrough and an introduction to the Python API is
102
available on the [Mininet Web Site](http://openflow.org/mininet). There is
103
also a wiki which you are encouraged to read and to contribute to,
104
particularly the Frequently Asked Questions (FAQ.)
105

    
106
*** Mininet Support ***
107

    
108
Mininet is supported by the friendly Mininet community. We encourage you to
109
join the Mininet mailing list, `mininet-discuss` at:
110

    
111
<https://mailman.stanford.edu/mailman/listinfo/mininet-discuss>
112

    
113
*** Contributing to Mininet ***
114

    
115
Mininet is an open-source project and is currently hosted at
116
<https://github.com/mininet>. You are encouraged to download the code,
117
examine it, modify it, and submit bug reports, bug fixes, feature
118
requests, and enhancements!
119

    
120
Best wishes, and we look forward to seeing what you can do with Mininet
121
to change the networking world!
122

    
123
---
124

    
125
Bob Lantz
126
Brandon Heller
127
Nikhil Handigol
128
Vimal Jeyakumar
129

    
130
Mininet Project
131