X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=e24b0c3575ee6dfed4f364144ad43d2c3b6bb243;hb=refs%2Fheads%2Fhonolulu;hp=98b67fb079a1d92ed5f0134a34d552e18c733e3e;hpb=324ee36fe31763e507b422ab0a88e4230045e205;p=sdnc%2Foam.git diff --git a/README.md b/README.md index 98b67fb0..e24b0c35 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,36 @@ -This source repository contains the code for SDN Controller operations, administration and maintenance utilities. This code depends on the following, which should be downloaded and compiled first: +This source repository contains the directed graphs to support the +SDNC controller, as well as the code to create the SDNC docker containers. -1. org.openecomp.sdnc/sdnc-core -2. org.openecomp.sdnc/sdnc-adaptors -3. org.openecomp.sdnc/sdnc-northbound -4. org.openecomp.sdnc/sdnc-plugins +# Local compilation -To compile this code: +The following command will do a local build and create all SDNC +docker containers: -1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the OpenECOMP repositories and OpenDaylight repositories. See example-settings.xml for an example. +```bash +mvn clean install -P docker -Ddocker.pull.registry=nexus3.onap.org:10001 +``` -2. To compile, run "mvn clean install". +To do a local build of only the SDNC controller docker image: +```bash +cd installation/sdnc +mvn clean install -P docker -Ddocker.pull.registry=nexus3.onap.org:10001 +``` + +# Local CSIT testing + +To perform local CSIT testing, first create a local docker build +of the SDNC controller images following the steps above. + +Important note: CSIT testing is still based on Python2. So, before +running the CSIT locally, be sure that your local environment is +using the python2 version of 'python' and 'pip' + +Once you have a local SDNC image build and python2 is installed, +you can run a local CSIT test by running the following commands: + +```bash +cd csit +./run-project-csit.sh +```