Statistics
| Branch: | Tag: | Revision:

mininet / INSTALL @ 0d58b93a

History | View | Annotate | Download (5.09 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
46

    
47
3.1. Native installation from source on Ubuntu 12.04+
48

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

    
52
        git clone git://github.com/mininet/mininet.git
53

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

    
57
   *WARNING: USE AT YOUR OWN RISK!*
58

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

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

    
69
        mininet/util/install.sh -fnv
70

    
71
   This should be reasonably quick, and the following command should
72
   work after the installation:
73

    
74
        sudo mn --test pingall
75

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

    
82
        mininet/util/install.sh -a
83

    
84
   This takes about 4 minutes on our test system.
85

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

    
89
        mininet/util/install.sh -s <directory> -a
90

    
91
3.2. Native installation from source on Fedora 18+.
92

    
93
   As root execute the following operations:
94

    
95
    * install git
96

    
97
        yum install git
98

    
99
    * create an user account (e.g. mininet) and add it to the wheel group
100

    
101
        useradd [...] mininet
102
        usermod -a -G wheel mininet
103

    
104
    * change the SElinux setting to permissive. It can be done
105
      temporarily with:
106

    
107
        setenforce 0
108

    
109
   then login with the new account (e.g. mininet) and do the following:
110

    
111
    * clone the Mininet repository
112

    
113
        git clone git://github.com/mininet/mininet.git
114

    
115
    * install Mininet, the OpenFlow reference implementation, and
116
      Open vSwitch
117

    
118
        mininet/util/install.sh -fnv
119

    
120
    * enable and start openvswitch
121

    
122
        sudo systemctl enable openvswitch
123
        sudo systemctl start openvswitch
124

    
125
    * test the mininet installation
126

    
127
        sudo mn --test pingall
128

    
129
4. Creating your own Mininet/OpenFlow tutorial VM
130

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

    
134
        wget https://raw.github.com/mininet/mininet/master/util/vm/install-mininet-vm.sh
135
        time install-mininet-vm.sh
136

    
137
   Finally, verify that Mininet is installed and working in the VM:
138

    
139
        sudo mn --test pingall
140

    
141
5. Installation on other Linux distributions
142

    
143
   Although we don't support other Linux distributions directly, it
144
   should be possible to install and run Mininet with some degree of
145
   manual effort.
146

    
147
   In general, you must have:
148

    
149
   * A Linux kernel compiled with network namespace support enabled
150

    
151
   * An OpenFlow implementation (either the reference user or kernel
152
     space implementations, or Open vSwitch.) Appropriate kernel
153
     modules (e.g. tun and ofdatapath for the reference kernel
154
     implementation) must be loaded.
155

    
156
   * Python, `bash`, `ping`, `iperf`, etc.
157

    
158
   * Root privileges (required for network device access)
159

    
160
   We encourage contribution of patches to the `install.sh` script to
161
   support other Linux distributions.
162

    
163

    
164
Good luck!
165

    
166
Mininet Team
167

    
168
---