Revision ead9f830 README.md

View differences:

README.md
1

  
2
Mininet: Rapid Prototyping for Software Defined Networks
3
========================================================
1
=========================================================
2
 Mininet: Rapid Prototyping for Software Defined Networks
3
=========================================================
4 4

  
5 5
The best way to emulate almost any network on your laptop!
6 6

  
......
8 8

  
9 9
### What is Mininet?
10 10

  
11
Mininet emulates a complete network of hosts, links, and switches on a single
12
machine.  To create a sample two-host, one-switch network, just run:
11
Mininet emulates a complete network of hosts, links, and switches
12
on a single machine.  To create a sample two-host, one-switch network,
13
just run:
13 14

  
14 15
    sudo mn
15 16

  
16
Mininet is useful for interactive development, testing, and demos, especially
17
those using OpenFlow and SDN.  OpenFlow-based network controllers prototyped in
18
Mininet can usually be transferred to hardware with minimal changes for full
19
line-rate execution.
17
Mininet is useful for interactive development, testing, and demos,
18
especially those using OpenFlow and SDN.  OpenFlow-based network
19
controllers prototyped in Mininet can usually be transferred to
20
hardware with minimal changes for full line-rate execution.
20 21

  
21 22
### How does it work?
22 23

  
23
Mininet creates virtual networks using process-based virtualization and network
24
namespaces - features that are available in recent Linux kernels.  In Mininet,
25
hosts are emulated as bash processes running in a network namespace, so any
26
code that would normally run on a Linux server (like a web server or client
27
program) should run just fine within a Mininet "Host".  The Mininet "Host" will
28
have its own private network interface and can only see its own processes.
29
Switches in Mininet are software-based switches like Open vSwitch or the
30
OpenFlow reference switch.  Links are virtual ethernet pairs, which live in the
31
Linux kernel and connect our emulated switches to emulated hosts (processes).
24
Mininet creates virtual networks using process-based virtualization
25
and network namespaces - features that are available in recent Linux
26
kernels.  In Mininet, hosts are emulated as bash processes running in
27
a network namespace, so any code that would normally run on a Linux
28
server (like a web server or client program) should run just fine
29
within a Mininet "Host".  The Mininet "Host" will have its own private
30
network interface and can only see its own processes.  Switches in
31
Mininet are software-based switches like Open vSwitch or the OpenFlow
32
reference switch.  Links are virtual ethernet pairs, which live in the
33
Linux kernel and connect our emulated switches to emulated hosts
34
(processes).
32 35

  
33 36
### Features
34 37

  
......
36 39

  
37 40
* A command-line launcher (`mn`) to instantiate networks.
38 41

  
39
* A handy Python API for creating networks of varying sizes and topologies.
42
* A handy Python API for creating networks of varying sizes and
43
  topologies.
40 44

  
41 45
* Examples (in the `examples/` directory) to help you get started.
42 46

  
43
* Full API documentation via Python `help()` docstrings, as well as the ability
44
  to generate PDF/HTML documentation with `make doc`.
47
* Full API documentation via Python `help()` docstrings, as well as
48
  the ability to generate PDF/HTML documentation with `make doc`.
49

  
50
* Parametrized topologies (`Topo` subclasses) using the Mininet
51
  object.  For example, a tree network may be created with the
52
  command:
45 53

  
46
* Parametrized topologies (`Topo` subclasses) using the Mininet object.  For
47
  example, a tree network may be created with the command:
48
  
49 54
  `mn --topo tree,depth=2,fanout=3`
50 55

  
51
* A command-line interface (`CLI` class) which provides useful diagnostic
52
  commands (like `iperf` and `ping`), as well as the ability to run a command
53
  to a node. For example,
54
  
56
* A command-line interface (`CLI` class) which provides useful
57
  diagnostic commands (like `iperf` and `ping`), as well as the
58
  ability to run a command to a node. For example,
59

  
55 60
  `mininet> h11 ifconfig -a`
56
  
61

  
57 62
  tells host h11 to run the command `ifconfig -a`
58 63

  
59
* A 'cleanup' command to get rid of junk (interfaces, processes, files in
60
  /tmp, etc.) which might be left around by Mininet or Linux. Try this if 
61
  things stop working!
62
  
64
* A 'cleanup' command to get rid of junk (interfaces, processes, files
65
  in /tmp, etc.) which might be left around by Mininet or Linux. Try
66
  this if things stop working!
67

  
63 68
  `mn -c`
64 69

  
65 70
### New features in 2.0.0
......
83 88

  
84 89
* Man pages for the `mn` and `mnexec` utilities.
85 90

  
86
[Since the API (most notably the topology) has changed, existing code that
87
runs in Mininet 1.0 will need to be changed to run with Mininet 2.0. This
88
is the primary reason for the major version number change.]
91
[Since the API (most notably the topology) has changed, existing code
92
that runs in Mininet 1.0 will need to be changed to run with Mininet
93
2.0. This is the primary reason for the major version number change.]
89 94

  
90 95
### Installation
91 96

  
......
93 98

  
94 99
### Documentation
95 100

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

  
102 108
### Support
103 109

  
104
Mininet community-supported. We encourage you to
105
join the Mininet mailing list, `mininet-discuss` at:
110
Mininet is community-supported. We encourage you to join the
111
Mininet mailing list, `mininet-discuss` at:
106 112

  
107 113
<https://mailman.stanford.edu/mailman/listinfo/mininet-discuss>
108 114

  
......
113 119
examine it, modify it, and submit bug reports, bug fixes, feature
114 120
requests, and enhancements!
115 121

  
116
Best wishes, and we look forward to seeing what you can do with Mininet
117
to change the networking world!
122
Best wishes, and we look forward to seeing what you can do with
123
Mininet to change the networking world!
118 124

  
119 125
### Credits
120 126

  
......
124 130
* Brandon Heller
125 131
* Nikhil Handigol
126 132
* Vimal Jeyakumar
127

  

Also available in: Unified diff