Bump mdsal to 4.0.6
[ovsdb.git] / README
diff --git a/README b/README
index 9bd5064abda15f6ecc6da6f14ffa2cd39c2146ef..658413e9eb574db6bab8b5796ba7ac731e49b612 100644 (file)
--- a/README
+++ b/README
@@ -4,26 +4,12 @@ DIRECTORY ORGANIZATION
 - commons
   +-- parent : Contains Parent pom.xml for all the ovsdb modules.
 
-- features : This folder contains all the Karaf related files.
-
 - hwvtepsouthbound : Contains the hw_vtep southbound plugin.
 
-- karaf : Builds a working controller distribution based on the controller + ovsdb modules and other
-          dependant modules such as openflowplugin
-
 - 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.
 
-- openstack
-  +-- net-virt : Handles the Openstack Neutron ML2 and Network Service calls and performs all the logic required
-                 for Network Virtualization.
-  +-- net-virt-providers : Mostly contains data-path programming functionality via OpenFlow or potentially
-                           other protocols.
-  +-- net-virt-sfc : SFC implementation using the OVSDB project.
-
-- ovsdb-ui : Contains the DLUX implementation for displaying network virtualization
-
 - resources : Contains some useful resources such as scripts, testing utilities and tools used for deployment
               or testing the binaries generated from the OVSDB project.
 
@@ -33,7 +19,7 @@ DIRECTORY ORGANIZATION
 
 - southbound : contains the plugin for converting from the OVSDB protocol to mdsal and vice-versa.
 
-- utils : MD-SAL OpenFlow and OVSDB common utilities.
+- utils : OVSDB common utilities.
 
 HOW TO BUILD & RUN
 ==================
@@ -48,17 +34,18 @@ Pre-requisites : JDK 1.7+, Maven 3+
 
    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-openstack" (without quotation marks).
+      "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-api          | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: api
-   odl-ovsdb-southbound-impl         | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: impl
-   odl-ovsdb-southbound-impl-rest    | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: impl :: REST
-   odl-ovsdb-southbound-impl-ui      | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-southbound-1.2.1-SNAPSHOT     | OpenDaylight :: southbound :: impl :: UI
-   odl-ovsdb-library                 | 1.2.1-SNAPSHOT   | x         | odl-ovsdb-library-1.2.1-SNAPSHOT        | OpenDaylight :: library
-   odl-ovsdb-openstack               | 1.2.1-SNAPSHOT   | x         | ovsdb-1.2.1-SNAPSHOT                    | OpenDaylight :: OVSDB :: OpenStack Network Virtual
+   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
@@ -87,14 +74,11 @@ Running The Integration Tests
 To run the integration tests locally the following components are required:
 
  - Docker
- - Fig or Docker Compose
+ - Docker Compose
 
 To install docker, follow the installation guide for your platform:
    http://docs.docker.com/installation/
 
-To install fig:
-   http://www.fig.sh/install.html
-
 To install Docker Compose:
    http://docs.docker.com/compose/install/
 
@@ -102,18 +86,19 @@ To run the integration tests:
 
     mvn clean install
     # The first time you need to set everything up
-    fig up -d
+    docker-compose up -d
     # Later runs only need the containers to be started
-    fig start
+    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
-    fig stop
+    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 ...).
 
-If you're using Docker Compose, replace "fig" above with "docker-compose" and ignore the warnings.
+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
 ====================