X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=README;h=e23b25851711113e8c25e9047aeabdac5cfa2520;hb=409c5c4c408998ff3df61ca6e38faa159fd29863;hp=5a18d8e945f32ebf5c8b22a3c617e4811d539ee2;hpb=888e5d817c3ec7b37b336c9c6695dc3353c6ed5a;p=ovsdb.git diff --git a/README b/README index 5a18d8e94..e23b25851 100644 --- 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 ================== @@ -87,14 +73,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,19 +85,17 @@ 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 -Dovsdb.controller.address= -Dovsdb.userspace.enabled=yes - fig stop + 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