util/dockerTestOfOverlay/README.md

   1 GroupBasedPolicy Proof Of Concept Scripts
   2
   3 1. Introduction
   4
   5 This instance of GroupBasedPolicy "Proof of Concept" or Demo utilizes:
   6 - Two Ubuntu 14.04 LTS VMs on a host-net (using VirtualBox)
   7 - Docker 1.0.1 (for guests)
   8 - OpenVSwitch 2.3.0 (running natively on Ubuntu 14.04LTS)
   9
  10 It mimics the same policy as the mininet example, that is:
  11 - Two EndPointGroups (EPG)
  12   1. Clients
  13   2. WebServers
  14 - 4 guests per EPG
  15 - Contract allowing HTTP Client -> WebServers and PING Client <-> WebServers but
  16   HTTP WebServers -//-> Client (ie disallowed)
  17
  18   2. Files
  19   - infrastructure_config:
  20       Contains configuration of OVS and docker guests. There is a default image, but this can be over-ridden.
  21   - policy_config:
  22       The policy is set here. It is important to note that this file needs to be on both VMs
  23   - infrastructure_launch:
  24       Launches the docker containers and configures switches
  25   - odl_gbp:
  26       Library of functions for performing operations on GBP policy entities
  27   - testOfOverlay:
  28       Processes policy and guests. It is important that one of the VMs launches this script with "--policy" much like the mininet POC
  29   - start-poc.sh:
  30       Cleans up any existing docker and OVS instances (using "mn -c" for quick OVS clean up. If this is not an option on your VM then pursue stopping OVS, removing conf.db, starting OVS)
  31
  32   3. Usage
  33   - Always run from root. ie sudo bash
  34   - Edit infrastructure_config.py with the IP address of the VM for each switch, edit start-poc.sh with your ODL controller IP.
  35
  36