Convert SouthboundProvider into a component
[ovsdb.git] / README.Vagrant
1 ODL OVSDB Vagrant
2 =================
3
4 # Installation
5
6 You can download an install for your system from [here](http://www.vagrantup.com/downloads.html)
7
8 # Usage
9
10 Vagrant is a tool for creating development/test environments.
11 The environment created for this project is as follows:
12
13 1 x DevStack Control/Compute VM
14 1-3 x DevStack Compute VM
15 1 x Mininet VM
16
17 It's assumed you already have an OVSDB development environment set up.
18
19 1. Run `mvn clean install`
20 2. Run `vagrant up`
21 3. Start the controller (in distirbution/target/opendaylight/...)
22
23 > Note: It's assumed that the subnet 192.168.50.x/24 is not in use
24 > Your PC is 192.168.50.1. If you would like to change the addressing,
25 > you will need to edit the Vagrantfile and hosts.json
26
27 Follow the instructions below for Devstack and Mininet
28
29 ## DevStack VMs
30
31 There are two DevStack VMs. One combined control/compute node and a variable number of dedicated compute nodes.
32 The following steps are performed when the VM is created or when `vagrant provision` is run.
33
34 - Check dependencies are installed
35 - Clone the devstack repository to `devstack`
36 - Generate a `local.conf` file
37
38 To start DevStack
39
40     vagrant ssh devstack-control
41     # or vagrant ssh devstack-compute
42     cd devstack
43     ./stack.sh
44
45 > Note: To start more than one compute node
46 >       export DEVSTACK_NUM_COMPUTE_NODES=3
47 >       vagrant up
48
49 ## Mininet
50
51 There is a single VM provided for running mininet.
52 This is for testing that does not require OpenStack Neutron.
53
54 The following steps are performed when the VM is created or when `vagrant provision` is run.
55 - Check dependencies are installed
56 - Clone the mininet repository
57 - Install mininet and Open vSwitch
58
59 To start Mininet
60
61     vagrant ssh mininet
62     sudo mn
63
64 # Port Forwarding
65
66 The following ports are forwarded:
67
68 localhost:8080 -> opendaylight:8080
69 localhost:8000 -> opendaylight:8000
70 localhost:8081 -> devstack-control:8080