Bug 3989 -- Fix the original patch. Original patch can break

[netvirt.git] / README

diff --git a/README b/README
index d32d665efc9d922106a0a3b8ea9c27919dce835f..b4072ea9d92e92991991a88fa7ae8f8a1e397f73 100644 (file)
--- a/README
+++ b/README
@@ -22,8 +22,6 @@ DIRECTORY ORGANIZATION
                Supports the legacy v2 APIs to provide backward compatibility for Hydrogen Release
                Also supports the newer v3 APIs to provide schema-independent access to the OVSDB protocol.
 
-- of-extension : Adds OpenFlow Nicera extensions.
-
 - openstack
   +-- net-virt : Handles the Openstack Neutron ML2 and Network Service calls and performs all the logic required
                  for Network Virtualization.
@@ -82,7 +80,6 @@ Pre-requisites : JDK 1.7+, Maven 3+
    odl-ovsdb-northbound             | 0.6.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT                  | OpenDaylight :: OVSDB :: Northbound
    odl-ovsdb-openstack              | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT                  | OpenDaylight :: OVSDB :: OpenStack Network Virtual
    odl-ovsdb-ovssfc                 | 0.0.1-SNAPSHOT      |           | ovsdb-0.0.1-SNAPSHOT                  | OpenDaylight :: OVSDB :: OVS Service Function Chai
-   odl-openflow-nxm-extensions      | 0.0.3-SNAPSHOT      | x         | ovsdb-0.0.3-SNAPSHOT                  | OpenDaylight :: Openflow :: Nicira Extensions
 
 
 2. Building a bundle and deploying it in an Opendaylight Karaf distribution :
@@ -129,7 +126,7 @@ Pre-requisites : JDK 1.7+, Maven 3+
       deployment needs.
 
    2. From the features/ directory, execute "mvn clean install"
-      This will generate a kar file such as "features/target/ovsdb-features-1.2.0-SNAPSHOT.kar"
+      This will generate a kar file such as "features/target/ovsdb-features-1.2.1-SNAPSHOT.kar"
 
    3. Download (or build from controller project) the Karaf distribution :
       http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/org/opendaylight/controller/distribution.opendaylight-karaf/
@@ -146,14 +143,14 @@ Pre-requisites : JDK 1.7+, Maven 3+
    opendaylight-user@root>kar:list
    KAR Name
    -----------------------------
-   ovsdb-features-1.2.0-SNAPSHOT
+   ovsdb-features-1.2.1-SNAPSHOT
 
    opendaylight-user@root>feature:list | grep ovsdb
-   odl-ovsdb-all | 1.2.0-SNAPSHOT | x | ovsdb-1.2.0-SNAPSHOT | OpenDaylight :: OVSDB :: all
-   odl-ovsdb-library | 1.0.0-SNAPSHOT | x | ovsdb-1.2.0-SNAPSHOT | OVSDB :: Library
-   odl-ovsdb-schema-openvswitch | 1.0.0-SNAPSHOT | x | ovsdb-1.2.0-SNAPSHOT | OVSDB :: Schema :: Open_vSwitch
-   odl-ovsdb-schema-hardwarevtep | 1.0.0-SNAPSHOT | x | ovsdb-1.2.0-SNAPSHOT | OVSDB :: Schema :: hardware_vtep
-   odl-ovsdb-plugin | 1.0.0-SNAPSHOT | x | ovsdb-1.2.0-SNAPSHOT | OpenDaylight :: OVSDB :: Plugin
+   odl-ovsdb-all | 1.2.1-SNAPSHOT | x | ovsdb-1.2.1-SNAPSHOT | OpenDaylight :: OVSDB :: all
+   odl-ovsdb-library | 1.0.0-SNAPSHOT | x | ovsdb-1.2.1-SNAPSHOT | OVSDB :: Library
+   odl-ovsdb-schema-openvswitch | 1.0.0-SNAPSHOT | x | ovsdb-1.2.1-SNAPSHOT | OVSDB :: Schema :: Open_vSwitch
+   odl-ovsdb-schema-hardwarevtep | 1.0.0-SNAPSHOT | x | ovsdb-1.2.1-SNAPSHOT | OVSDB :: Schema :: hardware_vtep
+   odl-ovsdb-plugin | 1.0.0-SNAPSHOT | x | ovsdb-1.2.1-SNAPSHOT | OpenDaylight :: OVSDB :: Plugin
 
    opendaylight-user@root>bundle:list | grep OVSDB
    186 | Active | 80 | 1.0.0.SNAPSHOT | OVSDB Library
@@ -167,7 +164,7 @@ Running The Integration Tests
 To run the integration tests locally the following components are required:
 
  - Docker
- - Fig
+ - Fig or Docker Compose
 
 To install docker, follow the installation guide for your platform:
    http://docs.docker.com/installation/
@@ -175,9 +172,15 @@ To install docker, follow the installation guide for your platform:
 To install fig:
    http://www.fig.sh/install.html
 
+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
+    fig up -d
+    # Later runs only need the containers to be started
     fig start
     # OSX
     mvn verify -Pintegrationtest -Dovsdbserver.ipaddress=$(boot2docker ip 2>/dev/null) -Dovsdbserver.port=6640
@@ -185,6 +188,10 @@ To run the integration tests:
     mvn verify -Pintegrationtest -Dovsdbserver.ipaddress=127.0.0.1 -Dovsdbserver.port=6640
     fig 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.
+
 Skipping unit tests and karaf tests
 ====================