X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=README;h=a3a45ae871640ac0a3ec207b374edf3efdb146dd;hb=6b94e3a6ec6250dc27597fe70e8676a392c2d59f;hp=dbd624950385ff532a85f60f012eae2a8db09e6d;hpb=2fd8e9fb3bb89aa9d25398076b5e1473caf9227f;p=netvirt.git diff --git a/README b/README index dbd6249503..a3a45ae871 100644 --- a/README +++ b/README @@ -3,7 +3,6 @@ DIRECTORY ORGANIZATION - commons +-- parent : Contains Parent pom.xml for all the ovsdb modules. - +-- integrationtest : Contains the parent pom.xml for all the integrationtest needs. - distribution : Builds a working controller distribution based on the controller + ovsdb modules and other dependant modules such as openflowplugin @@ -12,16 +11,10 @@ DIRECTORY ORGANIZATION - features : This folder contains all the Karaf related files. -- integrationtest : Contains all the PAX-Exam based integrationTests that covers IT for all the modules. - - 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. -- northbound : Provides AD-SAL style Northbound REST APIs. - 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. - - openstack +-- net-virt : Handles the Openstack Neutron ML2 and Network Service calls and performs all the logic required for Network Virtualization. @@ -67,7 +60,7 @@ Pre-requisites : JDK 1.7+, Maven 3+ 4. 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 odl-ovsdb-northbound" (without quotation marks). + "feature:install odl-ovsdb-openstack" (without quotation marks). Sample output from Karaf console : @@ -76,8 +69,6 @@ Pre-requisites : JDK 1.7+, Maven 3+ odl-ovsdb-library | 1.0.0-SNAPSHOT | x | ovsdb-1.0.0-SNAPSHOT | OVSDB :: Library odl-ovsdb-schema-openvswitch | 1.0.0-SNAPSHOT | x | ovsdb-1.0.0-SNAPSHOT | OVSDB :: Schema :: Open_vSwitch odl-ovsdb-schema-hardwarevtep | 1.0.0-SNAPSHOT | x | ovsdb-1.0.0-SNAPSHOT | OVSDB :: Schema :: hardware_vtep - odl-ovsdb-plugin | 1.0.0-SNAPSHOT | x | ovsdb-1.0.0-SNAPSHOT | OpenDaylight :: OVSDB :: Plugin - 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 @@ -126,7 +117,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/ @@ -143,14 +134,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 @@ -164,7 +155,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/ @@ -172,6 +163,9 @@ 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 @@ -187,6 +181,8 @@ To run the integration tests: 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 ====================