#SETUP

This is a demonstration/development environment for show-casing OpenDaylight GroupBasedPolicy (GBP) with ServiceFunctionChaining (SFC)

This version is using a vagrant box: alagalah/gbpsfc-trusty64 v1.0.1

It is important to ./cleandemo.sh before using. A demo.lock file will be added to repo so that first run will fail unless you ./cleandemo.sh

This is to ensure that each OVS gets a unique UUID as the Box file will re-use the same UUID for each OVS.

After the first time it is very quick.

1. Set up Vagrant. 
  * Edit env.sh for NUM_NODES. (Keep all other vars the same for this version)
  * Each VM takes approximately 1G RAM, 2GB used HDD (40GB)
  * demo-gbp1: 3 VMs.
  * demo-symmetric-chain: 6 VMs.
  * demo-asymmetric-chain: 6 VMs.
2. From the directory you cloned into:
```
source ./env.sh
vagrant up
```
  * If the starting process fail with '/sbin/mount.vboxsf: mounting failed with the error: No such device' line
    (usually occur after first halt) run 'vagrant plugin install vagrant-vbguest' command on host. It should solve the problem.

3. Start controller.
  * Currently it is expected that that controller runs on the host hosting the VMs.
  * Tested using groupbasedpolicy beryllium
		If you are building and get 'illegal unicode escape' error, 
		you have to rename two yang files in 'groupbasedpolicy\ui-backend\src\main\yang'. 
		These files have to start with a character other than 'u'. 
		E.g. rename 'ui-backend.yang' to 'aui-backend.yang' and 'ui-backend-impl.yang' to 'aui-backend-impl.yang'.
  * Start controller by running bin/karaf and install following features in karaf:

```
 feature:install odl-groupbasedpolicy-ofoverlay odl-groupbasedpolicy-ui odl-restconf
```

  * Run `log:tail | grep renderer` and wait until the following message appears in the log:
```
INFO - OFOverlayRenderer - org.opendaylight.groupbasedpolicy.ofoverlay-renderer - Initialized OFOverlay renderer
```
  * Now you can ^C the log:tail if you wish

#Demos:
* demo-gbp1: 
  * 8 docker containers in 2 x EPGs (web, client)
  * contract with ICMP and HTTP
* demo-symmetry:
  * 2 docker containers in 2 x EPGs (web, client)
  * contract with ICMP (ALLOW) and HTTP (CHAIN, where Client request is chained, Web reverse path is reverse path of chain)
* demo-asymmetry:
  * 2 docker containers in 2 x EPGs (web, client)
  * contract with ICMP (ALLOW) and HTTP (CHAIN, where Client request is chained, Web reverse path is ALLOW)

##demo-gbp1

###Setup

VMs:
* gbpsfc1: gbp
* gbpsfc2: gbp
* gbpsfc3: gbp

Containers:
* h35_{x} are in EPG:client
* h36_{x} are in EPG:web

To run, from host folder where Vagrantfile located do:

` ./startdemo.sh demo-gbp1`

After this, `infrastructure_config.py` will be copied from `/demo-gbp1`, and you are ready to start testing.
 
###To test:

SSH to test VM (may take some seconds):
```bash
vagrant ssh gbpsfc1
```

Get root rights:
```bash
sudo -E bash
```

Check docker containers running on your VM:
```bash
docker ps
```

Notice there are containers from two different endpoint groups, "h35" and "h36".
Enter into the shell on one of "h36" (web) container (on `gbpsfc1` it will be `h36_4`, its IP is `10.0.36.4`, 
you will need it later).
*(You need double ENTER after `docker attach`)*
```bash
docker attach h36_4
```

Start a HTTP server:
```bash
python -m SimpleHTTPServer 80
```

Press `Ctrl-P-Q` to return to your root shell on `gbpsfc1`

Enter into one of "h35" (client) container, 
ping the container where HTTP server runs, 
and connect to index page:

*We use eternal loop here to imitate web activity. 
After finishing your test, you might want to stop the loop with `Ctrl-C`*
```
docker attach h35_{x}
ping 10.0.36.4
while true; do curl 10.0.36.4; done
```

You may `ping` and `curl` to the web-server from any test VM.

`Ctrl-P-Q` to leave back to root shell on VM.

Now watch the packets flow:
```
ovs-dpctl dump-flows
```

Leave to main shell:
```bash
exit #leave root shell
exit #close ssh session
```
Repeat `vagrant ssh` etc. for each of gbpsfc2, gbpsfc3.

###After testing

When finished from host folder where Vagrantfile located do:

`./cleandemo.sh`

If you like `vagrant destroy` will remove all VMs.

##demo-symmetric-chain / demo-asymmetric-chain

VMs:
* gbpsfc1: gbp (client initiates transactions from here)
* gbpsfc2: sff
* gbpsfc3: "sf"
* gbpsfc4: sff
* gbpsfc5: "sf"
* gbpsfc6: gbp (run a server here)

Containers:
* h35_2 is in EPG:client on gbpsfc1
* h36_4 is in EPG:web on gbpsfc6

To run, from host folder where Vagrantfile located do:

` ./startdemo.sh demo-symmetric-chain` | `demo-asymmetric-chain`

### To test by sending traffic:
Start a test HTTP server on h36_4 in VM 6.

*(don't) forget double ENTER after `docker attach`*
```bash
vagrant ssh gbpsfc6
sudo -E docker ps
sudo -E docker attach h36_4
python -m SimpleHTTPServer 80
```

Ctrl-P-Q to detach from docker without stopping the SimpleHTTPServer, and logoff gbpsfc6.

Now start client traffic, either ping or make HTTP requests to the server on h36_4.

```bash
vagrant ssh gbpsfc1
sudo -E docker ps
sudo -E docker attach h35_2
ping 10.0.36.4
curl 10.0.36.4
while true; do curl 10.0.36.4; sleep 1; done
```

Ctrl-P-Q to detach from docker, leaving the client making HTTP requests, and logoff gbpsfc1.


Look around: use "vagrant ssh" to the various machines 
 * take packet captures on eth1.
 * sudo ovs-dpctl dump-flows`

### When finished from host folder where Vagrantfile located do:

`./cleandemo.sh`

If you like `vagrant destroy` will remove all VMs

##Preparing to run another demo
1. In the vagrant directory, run cleandemo.sh
2. stop controller (logout of karaf)
3. Remove journal and snapshot directories from controller directory.
4. Restart the controller, install features, wait, as above.


# Useful vagrant plugins

You can install plugins using

```bash
vagrant plugin install <plugin>
```

Useful ones are:
vagrant-cachier - faster build times as APT repos cached
vagrant-vbguest - updates VirtualBox Guest Additions versions (if possible)