moving developers-guide to developer-guide for consistency
[docs.git] / manuals / developer-guide / src / main / asciidoc / vtn / VTN_Manager_Hacking.adoc
1 === Hacking VTN Manager
2 ==== Installing VTN Manager from source code
3 .Prior preparation
4
5 VTN Manager is a set of OSGi bundles running in OpenDaylight controller in Karaf platform, so prior preparation for installing VTN Manager is the same as OpenDaylight controller.
6
7 Please see https://wiki.opendaylight.org/view/OpenDaylight_Controller:Installation.
8
9 ===== Get VTN Source
10 The below procedure assumes, You are installing OpenDaylight Controller with VTN Manager on your local Linux machine.
11
12 * Download the code from the Git repository of VTN Project.
13 [source,perl]
14 ----
15  git clone ssh://<username>@git.opendaylight.org:29418/vtn.git
16 or
17  git clone https://git.opendaylight.org/gerrit/p/vtn.git
18 ----
19 The following instructions assume you put the code in directory ${VTN_DIR}.
20 [source,perl]
21 ----
22  ${VTN_DIR}=<Top of VTN source tree>
23 ----
24 * Build the code of VTN Manager.
25 [source,perl]
26 ----
27  cd ${VTN_DIR}/manager
28  mvn clean install
29 ----
30  NOTE: This command will build the local Karaf distribution in the folder manager/dist/karaf/target/assembly.
31
32 ==== Build and Run the Controller with VTN Manager
33 ===== Build
34 NOTE: You will need direct internet connection for this build to be successful.
35
36  cd ${VTN_DIR}/manager
37  mvn clean install -DskipTests
38
39 Note: SkipTests will not execute the Unit Tests and Integration Tests while compilation
40