DIRECTORY ORGANIZATION
======================

- commons
  +-- parent : Contains Parent pom.xml for all the ovsdb modules.

- hwvtepsouthbound : Contains the hw_vtep southbound plugin.

- library : Contains Schema-independent library that is a reference implementation for RFC 7047.
            This module doesn't depend on any of the Opendaylight components.
            This library module can also be used independently in a non-OSGi environment.

- resources : Contains some useful resources such as scripts, testing utilities and tools used for deployment
              or testing the binaries generated from the OVSDB project.

- schemas :
  +-- openvswitch : Schema wrapper that represents http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf
  +-- hardwarevtep: Schema wrapper that represents http://openvswitch.org/docs/vtep.5.pdf

- southbound : contains the plugin for converting from the OVSDB protocol to mdsal and vice-versa.

- utils : OVSDB common utilities.

HOW TO BUILD & RUN
==================

Pre-requisites : JDK 1.7+, Maven 3+

1. Building a Karaf Feature and deploying it in an Opendaylight Karaf distribution :
   1. From the root ovsdb/ directory, execute "mvn clean install"

   2. Unzip the karaf-<VERSION_NUMBER>-SNAPSHOT.zip file created from step 1 in the directory ovsdb/karaf/target/:
      "unzip karaf-<VERSION_NUMBER>-SNAPSHOT.zip"

   3. Once karaf has started and you see the Opendaylight ascii art in the console, the last step
      is to start the OVSDB plugin framework with the following command in the karaf console:
      "feature:install odl-ovsdb-southbound-impl odl-ovsdb-hwvtepsouthbound" (without quotation marks).

   Sample output from Karaf console :

  opendaylight-user@root>feature:list -i | grep ovsdb
   odl-ovsdb-southbound-impl                                       x 1.9.0.SNAPSHOT   x x        x Started x odl-ovsdb-southbound-impl-1.9.0-SNAPSHOT                        x ODL :: ovsdb :: odl-ovsdb-southbound-impl
   odl-ovsdb-hwvtepsouthbound-api                                  x 1.9.0.SNAPSHOT   x          x Started x odl-ovsdb-hwvtepsouthbound-api                                  x ODL :: ovsdb :: odl-ovsdb-hwvtepsouthbound-api
   odl-ovsdb-utils                                                 x 1.9.0.SNAPSHOT   x          x Started x odl-ovsdb-utils                                                 x ODL :: ovsdb :: odl-ovsdb-utils
   odl-ovsdb-hwvtepsouthbound                                      x 1.9.0.SNAPSHOT   x x        x Started x odl-ovsdb-hwvtepsouthbound                                      x ODL :: ovsdb :: odl-ovsdb-hwvtepsouthbound
   odl-ovsdb-library                                               x 1.9.0.SNAPSHOT   x          x Started x odl-ovsdb-library-1.9.0-SNAPSHOT                                x ODL :: ovsdb :: odl-ovsdb-library
   odl-ovsdb-southbound-api                                        x 1.9.0.SNAPSHOT   x          x Started x odl-ovsdb-southbound-api                                        x ODL :: ovsdb :: odl-ovsdb-southbound-api
  opendaylight-user@root>

2. Building a bundle and deploying it in an Opendaylight Karaf distribution :
   This method can be used to update and test new code in a bundle. If the bundle of interest is rebuilt as a
   snapshot with the same version as what it already defined in a feature repo then that new bundle will be used
   when the feature is loaded in karaf. If karaf is already running with the feature loaded then follow the steps
   below to load the new bundle:

   1. Find the bundle id of the bundle you are going to rebuild:
      - bundle:list -s | grep <bundlename>, i.e. bundle:list -s | grep odl-ovsdb-plugin

   2. Instruct karaf to watch the new bundle and reload it if it changes:
      - bundle:watch <id>
      - The id is the value returned in 1 above.
      - You can also watch the bundle URL itself:
        - bundle:watch mvn:org.opendaylight.ovsdb/plugin/1.0.2-SNAPSHOT

   3. Rebuild bundle.
      - cd bundle dir, i.e. cd ovsdb/plugin
      - mvn clean install. This will install the new bundle into the local mvn repo.

   4. karaf will see the changed bundle and reload it.

Running The Integration Tests
=============================

To run the integration tests locally the following components are required:

 - Docker
 - Docker Compose

To install docker, follow the installation guide for your platform:
   http://docs.docker.com/installation/

To install Docker Compose:
   http://docs.docker.com/compose/install/

To run the integration tests:

    mvn clean install
    # The first time you need to set everything up
    docker-compose up -d
    # Later runs only need the containers to be started
    docker-compose start
    # OSX
    mvn verify -Pintegrationtest -Dovsdbserver.ipaddress=$(boot2docker ip 2>/dev/null) -Dovsdbserver.port=6640
    # Linux
    mvn verify -Pintegrationtest -Dovsdbserver.ipaddress=127.0.0.1 -Dovsdbserver.port=6640 -Dovsdb.controller.address=<addr of docker interface> -Dovsdb.userspace.enabled=yes
    docker-compose stop

On Linux you'll generally need to run fig as root (sudo fig ...).

Running the docker image manually:
    sudo docker run -itd --cap-add NET_ADMIN -p 6640:6640 jhershbe/centos7-ovs:latest

Skipping unit tests and karaf tests
====================

mvn clean install -Dmaven.test.skip=true -Dskip.karaf=true