Statistics
| Branch: | Tag: | Revision:

mininet / INSTALL @ 92b51563

History | View | Annotate | Download (4.2 KB)

1

    
2
Mininet Installation/Configuration Notes
3
----------------------------------------
4

    
5
Mininet 2.1.0
6
---
7

    
8
The supported installation methods for Mininet are 1) using a
9
pre-built VM image, and 2) native installation on Ubuntu. You can also
10
easily create your own Mininet VM image (4).
11

    
12
(Other distributions may be supported in the future - if you would
13
like to contribute an installation script, we would welcome it!)
14

    
15
1. Easiest "installation" - use our pre-built VM image!
16

    
17
   The easiest way to get Mininet running is to start with one of our
18
   pre-built virtual machine images from <http://mininet.org/>
19

    
20
   Boot up the VM image, log in, and follow the instructions on the
21
   Mininet web site.
22

    
23
   One advantage of using the VM image is that it doesn't mess with
24
   your native OS installation or damage it in any way.
25

    
26
   Although a single Mininet instance can simulate multiple networks
27
   with multiple controllers, only one Mininet instance may currently
28
   be run at a time, and Mininet requires root access in the machine
29
   it's running on.  Therefore, if you have a multiuser system, you
30
   may wish to consider running Mininet in a VM.
31

    
32
2. Next-easiest option: use our Ubuntu package!
33

    
34
   To install Mininet itself (i.e. `mn` and the Python API) on Ubuntu
35
   12.10+:
36

    
37
        sudo apt-get install mininet
38

    
39
   Note: if you are upgrading from an older version of Mininet, make
40
   sure you remove the old OVS from `/usr/local`:
41

    
42
        sudo rm /usr/local/bin/ovs*
43
        sudo rm /usr/local/sbin/ovs*
44

    
45
3. Native installation from source on Ubuntu 12.04+
46

    
47
   If you're reading this, you've probably already done so, but the
48
   command to download the Mininet source code is:
49

    
50
        git clone git://github.com/mininet/mininet.git
51

    
52
   If you are running Ubuntu, you may be able to use our handy
53
   `install.sh` script, which is in `mininet/util`.
54

    
55
   *WARNING: USE AT YOUR OWN RISK!*
56

    
57
   `install.sh` is a bit intrusive and may possibly damage your OS
58
   and/or home directory, by creating/modifying several directories
59
   such as `mininet`, `openflow`, `oftest`, `pox`, etc..
60
   Although we hope it won't do anything completely terrible, you may
61
   want to look at the script before you run it, and you should make
62
   sure your system and home directory are backed up just in case!
63

    
64
   To install Mininet itself, the OpenFlow reference implementation, and
65
   Open vSwitch, you may use:
66

    
67
        mininet/util/install.sh -fnv
68

    
69
   This should be reasonably quick, and the following command should
70
   work after the installation:
71

    
72
        sudo mn --test pingall
73

    
74
   To install ALL of the software which we use for OpenFlow tutorials,
75
   including POX, the OpenFlow WireShark dissector, the `oftest`
76
   framework, and other potentially useful software (and to add some
77
   stuff to `/etc/sysctl.conf` which may or may not be useful) you may
78
   use:
79

    
80
        mininet/util/install.sh -a
81

    
82
   This takes about 4 minutes on our test system.
83

    
84
   You can change the directory where the dependencies are installed using
85
   the -s <directory> flag.
86

    
87
        mininet/util/install.sh -s <directory> -a
88

    
89
4. Creating your own Mininet/OpenFlow tutorial VM
90

    
91
   Creating your own Ubuntu Mininet VM for use with the OpenFlow tutorial
92
   is easy! First, create a new Ubuntu VM. Next, run two commands in it:
93

    
94
        wget https://raw.github.com/mininet/mininet/master/util/vm/install-mininet-vm.sh
95
        time install-mininet-vm.sh
96

    
97
   Finally, verify that Mininet is installed and working in the VM:
98

    
99
        sudo mn --test pingall
100

    
101
5. Installation on other Linux distributions
102

    
103
   Although we don't support other Linux distributions directly, it
104
   should be possible to install and run Mininet with some degree of
105
   manual effort.
106

    
107
   In general, you must have:
108

    
109
   * A Linux kernel compiled with network namespace support enabled
110

    
111
   * An OpenFlow implementation (either the reference user or kernel
112
     space implementations, or Open vSwitch.) Appropriate kernel
113
     modules (e.g. tun and ofdatapath for the reference kernel
114
     implementation) must be loaded.
115

    
116
   * Python, `bash`, `ping`, `iperf`, etc.
117

    
118
   * Root privileges (required for network device access)
119

    
120
   We encourage contribution of patches to the `install.sh` script to
121
   support other Linux distributions.
122

    
123

    
124
Good luck!
125

    
126
Mininet Team
127

    
128
---