Table of Contents

Installation

Installation Prerequisites

• Java 8
• node.js v0.10.x
• graphviz v2.36.0 or later (only needed if you want to view the directed graph image in the dgbuilder).
• Maven

Installation Instructions

If node.js isn't installed run the below commands

sudo apt-get install -y nodejs
sudo ln -s /usr/bin/nodejs /usr/bin/node

Clone the project from gerrit move into the git repository folder. Then create a release and start it.

#clone from gerrit
git clone https://gerrit.onap.org/r/ccsdk/distribution && (cd oam && curl -kLo `git rev-parse --git-dir`/hooks/commit-msg http://gerrit.onap.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg)
cd oam
cd dgbuilder
./createReleaseDir.sh "releaseName" "username" "emailId" "gitLocalRepositoryFullPath"
./start.sh releaseName

gitLocalRepositoryFullPath should point to a directory containing your directed graphs. 
Below is an example of what a user might actually run.

#clone from gerrit
git clone http://username@gerrit.onap.org/r/a/ccsdk/distribution
cd dgbuilder
./createReleaseDir.sh 15.10 username username@foo.com /home/users/username/sdnc/1510/service-logic
./start.sh 15.10

Configuration

Updating gitLocalRepository 

Note: you can also update the gitLocalRepository later from within the dgbuilder application by choosing "Configuration" from the "Menu" and updating the "Git local Repository Path" as shown in the picture below.

Working On Multiple Releases

(Optional) If working on multiple releases you can create additional release directories.

Example: If working on December 2015 release:

./createReleaseDir.sh 1512 username username@foo.com /home/users/userdirectory/sdnc/1512/service-logic

Below are samples of how a release is started and checking the status of the running release

#format of the command
./start.sh releaseName
#example 1
./start.sh 1510
#example 2
./start.sh 1512
#check which release is running
./show_status.sh

Using the application

Accessing the application

Access the application by typing the corresponding URL for the release you are working on in the browser based on the output from the show_status command.

Example: for 1510 release use http://localhost:3100 and for 1512 release use http://localhost:3101.

If your browser prompts you for a username and password use the username provided to the createReleaseDir script as your username.

test123 is the default password.

Note: many users are running a windows host machine and an ubuntu virtual machine.

If you are running a browser on your windows machine such as firefox and want to connect to the ubuntu guest machine running dg builder you will need to set up port forwarding in virtual box.

The port number you need to forward is the same one in the url you are trying to connect to.

Stopping the application

./stop.sh releaseName

Example: ./stop 1510

Additional Notes

Logs

The dgbuilder application related nohup.out gets written to dgbuilder/releases/releaseName/logs directory.

Downloaded XML and JSON files directory

From within the application when the buttons "Download XML" and "Download Json" are used the files get saved on the server in the dgbuilder/releases/releaseName/xml and dgbuilder/releases/releaseName/json directories respectively. 

The json flow file can be used to import the flow in the DG Builder application.

Importing from local git repository

If the local git repository is set, you can import the flows from that directory.

Project information

This page describes how to install and run DG Builder.

To learn how to use DG builder check the page at Service Logic Interpreter Directed Graph Guide

A good page to start with is  Your First Graph

The code for dg builder is hosted on codecloud at https://gerrit.onap.org/r/gitweb?p=sdnc/oam.git;a=tree;f=dgbuilder;hb=refs/heads/master

Authored By: Sheshashailavas Chinthakayala (edited for ONAP by Brian Freeman)