README

   1 DIRECTORY ORGANIZATION
   2 ======================
   3
   4 - commons
   5   +-- parent : Contains Parent pom.xml for all the ovsdb modules.
   6
   7 - hwvtepsouthbound : Contains the hw_vtep southbound plugin.
   8
   9 - library : Contains Schema-independent library that is a reference implementation for RFC 7047.
  10             This module doesn't depend on any of the Opendaylight components.
  11             This library module can also be used independently in a non-OSGi environment.
  12
  13 - resources : Contains some useful resources such as scripts, testing utilities and tools used for deployment
  14               or testing the binaries generated from the OVSDB project.
  15
  16 - schemas :
  17   +-- openvswitch : Schema wrapper that represents http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf
  18   +-- hardwarevtep: Schema wrapper that represents http://openvswitch.org/docs/vtep.5.pdf
  19
  20 - southbound : contains the plugin for converting from the OVSDB protocol to mdsal and vice-versa.
  21
  22 - utils : OVSDB common utilities.
  23
  24 HOW TO BUILD & RUN
  25 ==================
  26
  27 Pre-requisites : JDK 1.7+, Maven 3+
  28
  29 1. Building a Karaf Feature and deploying it in an Opendaylight Karaf distribution :
  30    1. From the root ovsdb/ directory, execute "mvn clean install"
  31
  32    2. Unzip the karaf-<VERSION_NUMBER>-SNAPSHOT.zip file created from step 1 in the directory ovsdb/karaf/target/:
  33       "unzip karaf-<VERSION_NUMBER>-SNAPSHOT.zip"
  34
  35    3. Once karaf has started and you see the Opendaylight ascii art in the console, the last step
  36       is to start the OVSDB plugin framework with the following command in the karaf console:
  37       "feature:install odl-ovsdb-openstack" (without quotation marks).
  38
  39    Sample output from Karaf console :
  40
  41   opendaylight-user@root>feature:list -i | grep ovsdb
  42    odl-ovsdb-southbound-api          | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: api
  43    odl-ovsdb-southbound-impl         | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: impl
  44    odl-ovsdb-southbound-impl-rest    | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: impl :: REST
  45    odl-ovsdb-southbound-impl-ui      | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: impl :: UI
  46    odl-ovsdb-library                 | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-library-1.2.1-SNAPSHOT        | OpenDaylight :: library
  47    odl-ovsdb-openstack               | 1.2.1-SNAPSHOT   | x         | ovsdb-1.2.1-SNAPSHOT                    | OpenDaylight :: OVSDB :: OpenStack Network Virtual
  48
  49 2. Building a bundle and deploying it in an Opendaylight Karaf distribution :
  50    This method can be used to update and test new code in a bundle. If the bundle of interest is rebuilt as a
  51    snapshot with the same version as what it already defined in a feature repo then that new bundle will be used
  52    when the feature is loaded in karaf. If karaf is already running with the feature loaded then follow the steps
  53    below to load the new bundle:
  54
  55    1. Find the bundle id of the bundle you are going to rebuild:
  56       - bundle:list -s | grep <bundlename>, i.e. bundle:list -s | grep odl-ovsdb-plugin
  57
  58    2. Instruct karaf to watch the new bundle and reload it if it changes:
  59       - bundle:watch <id>
  60       - The id is the value returned in 1 above.
  61       - You can also watch the bundle URL itself:
  62         - bundle:watch mvn:org.opendaylight.ovsdb/plugin/1.0.2-SNAPSHOT
  63
  64    3. Rebuild bundle.
  65       - cd bundle dir, i.e. cd ovsdb/plugin
  66       - mvn clean install. This will install the new bundle into the local mvn repo.
  67
  68    4. karaf will see the changed bundle and reload it.
  69
  70 Running The Integration Tests
  71 =============================
  72
  73 To run the integration tests locally the following components are required:
  74
  75  - Docker
  76  - Docker Compose
  77
  78 To install docker, follow the installation guide for your platform:
  79    http://docs.docker.com/installation/
  80
  81 To install Docker Compose:
  82    http://docs.docker.com/compose/install/
  83
  84 To run the integration tests:
  85
  86     mvn clean install
  87     # The first time you need to set everything up
  88     docker-compose up -d
  89     # Later runs only need the containers to be started
  90     docker-compose start
  91     # OSX
  92     mvn verify -Pintegrationtest -Dovsdbserver.ipaddress=$(boot2docker ip 2>/dev/null) -Dovsdbserver.port=6640
  93     # Linux
  94     mvn verify -Pintegrationtest -Dovsdbserver.ipaddress=127.0.0.1 -Dovsdbserver.port=6640 -Dovsdb.controller.address=<addr of docker interface> -Dovsdb.userspace.enabled=yes
  95     docker-compose stop
  96
  97 On Linux you'll generally need to run fig as root (sudo fig ...).
  98
  99 Running the docker image manually:
 100     sudo docker run -itd --cap-add NET_ADMIN -p 6640:6640 jhershbe/centos7-ovs:latest
 101
 102 Skipping unit tests and karaf tests
 103 ====================
 104
 105 mvn clean install -Dmaven.test.skip=true -Dskip.karaf=true