Revision 40beaabc

View differences:

INSTALL
2 2
Preliminary Mininet Installation/Configuration Notes
3 3

  
4 4
Pre-Beta version, August 2010
5

  
6 5
---
7 6

  
8 7
(Disclaimer: we're still pre-beta - things may be broken!)
9 8

  
9
The supported installation methods for Mininet Pre-Beta are 1) using
10
a pre-built VM image, and 2) native installation on Ubuntu or Debian.
11
(Other distributions may be supported in the future - if you would
12
like to contribute an installation script, we would welcome it!)
13

  
14
1. Easiest "install" - use our pre-built VM image!
15

  
10 16
The easiest way to get Mininet running is to start with one of our pre-built 
11 17
virtual machine images from:
12 18

  
13
http://openflow.org/foswiki/bin/view/OpenFlow/MininetGettingStarted
19
 http://openflow.org/foswiki/bin/view/OpenFlow/MininetGettingStarted
20

  
21
Boot up the VM image, log in, and follow the instructions on the wiki page.
22

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

  
26
2. Native installation for Ubuntu and Debian 5 (NEW for pre-beta!)
27

  
28
If you are running Ubuntu or Debian 5, you may be able to use our handy
29
install.sh script, which is in mininet/util. 
14 30

  
15
Once you have booted up the VM image, all you need to do to install
16
Mininet into it is:
31
WARNING: install.sh is a bit intrusive and may possibly damage your OS 
32
and/or home directory. Although we hope it won't do anything completely 
33
terrible, you may want to look at the script before you run it, and you
34
should make sure your system and home directory are backed up just in case!
35

  
36
To install ALL of the software which we use for OpenFlow tutorials, you may
37
use
38

  
39
$ mininet/util/install.sh
40

  
41
This takes about 20-30 minutes.
42

  
43
Alternately, you can install just the pieces you need.
44

  
45
We recommend the following steps, in order:
46

  
47
a) On Debian 5, first install a Mininet-compatible kernel:
48
    $ mininet/util/install.sh -k
49
   Reboot and run 'uname -r' to make sure you're running the new kernel.
50
   
51
b) Install OpenFlow 1.0 and associated useful software
52
    $ mininet/util/install.sh -f
17 53

  
18
 git clone git://openflow.org/mininet.git
19
 cd mininet
20
 sudo make install
54
c) Install Open vSwitch
55
    $ mininet/util/install.sh -f
21 56

  
22
At this point, it should be possible to run a simple Mininet configuration
23
from the command line:
57
d) If you wish to install the version of NOX we use in the tutorial:
58
    $ mininet/util/install.sh -x
24 59

  
25
 sudo mn
60
Good luck! Some additional installation notes are provided below, for
61
the brave and/or Linux-savvy, or those who are trying to understand what
62
is installed and why.
26 63

  
27
As an alternative, if you are Linux-savvy, do not wish to use the VM
28
image, and wish to take on the challenge of installing Mininet and its
29
dependencies from scratch, the requirements are described below.
64
p.s. Note that only one instance of Mininet is currently supported on a single
65
machine - that's one reason we recommend using a VM to run it.
30 66

  
31 67
---
32 68

  

Also available in: Unified diff