Setting

...

Up Your Development Environment

Start by following the page Setting Up Your Development Environment.

Downloading the Source Code

Creating Your Linux Foundation Account

If you already have a Linux Foundation account, you can skip this section.

You will need linux foundation account to submit code change to ONAP projects repos. If you only want to read the code, you can skip this step.

To create your linux foundation account, go to Linux Foundation Identity page, and select I need to create a Linux Foundation ID, the following page will be shown:

Image Removed

Filling the information and click on Create new account to proceed account creation.this covers items such as signing up for a linux foundation account, configuring git, installing gerrit and IDE recommendations.

Downloading the Source Code

Downloading SDN-C Projects

...

Project Name	Project Description	has code
ccsdk/dashboard	Opeations Manager Dashboard
ccsdk/distribution	CCSDK distribution packaging (e.g. docker containers)
ccsdk/parent	Parent POMs to be used by CCSDK clients
ccsdk/platform/blueprints	Blueprints. not in Amesterdam release
ccsdk/platform/nbapi	Northbound API
ccsdk/platform/plugins	Platform plugins
ccsdk/sli/adaptors	Common adaptors for use by directed graphs
ccsdk/sli/core	Core Service Logic Interpreter classes
ccsdk/sli/northbound	Common northbound APIS related to service logic interpreter
ccsdk/sli/plugins	Common plugins used by direcged graphs	python
ccsdk/storage/esaas	Elastic Storage as a Service.  not in Amesterdam release
ccsdk/storage/pgaas	PGAAS (PostgreSQL as a Service)	java, python, bash
ccsdk/utils	Utilities	bash, yaml

...

bash, yaml

Anchor
Get git clone command from ONAP gerrit Get git clone command from ONAP gerrit

Get git clone Command from ONAP gerrit

The below instructions explain how to clone a repository from gerrit with the commit message hook included and it will be configured to use HTTPS. SSH is still the recommended protocol, these instructions serve as a workaround for users behind restrictive networking rules.

If you have worked on other projects in gerrit and are already familiar with cloning from gerrit you can ignore these instructions!

...

Ensure your maven is installed / set up as per instruction from Maven section of Setting Up Your Development Environment page.

...

Following instruction from Maven Example settings.xml section of Setting Up Your Development Environment page to get your settingsettings.xml file.

Configure settings file in IntelliJ

If you are going to do compiling in your compile with intelliJ, follow steps in this section to configure settings.xml file in your interlliJintelliJ.

If you did not make your Maven Project by default shown, do the following:

In your interlliJintelliJ, Select View -> Tool Windows -> Maven Project

...

The maven project will shown on the right side of your the intelliJ window.

 Click the Maven Settings wrench to bring up the Settings window:

Select the Override of the User settings file, add the settings.xml file full path, the Apply button will be enabled. click on Apply to apply the change.

...

Projects Build Order

The SDN-C projects repos repositories should be built in the following order:

...

mvn clean install -s <the settings.xml file with full path>

Build Within

...

IntelliJ

From interlliJ intelliJ Maven Projects window, find the module marked with (root), expand it by clicking on the triange triangle on the left side or double clicking the text. It will then show two folders : Lifecycle and Plugins. Use the same way to expand the Lifecycle folder, the build options are now shown:

...

To run the build, double click the Install or select install and then click on the Run Maven Build triange  triangle icon.

To do clean, double click the clean or select clean and then click on the Run Maven Build triange  triangle icon.

Tips

Skip Maven Javadoc Build

...

When Create New Test... is selected, the Create Test window will be brough brought up:

The test Class name is automatically generated and shown in the window. Ensure the Testing library is selected with JUnit4.

...

If the Junit and mockito dependencies are not in the module and its parent pom file, add them to the module's pom.xml file as the following. A sample snippet is below:

<dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <version>${junit.version}</version>
 <scope>test</scope>
</dependency>
<dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <version>${mockito.version}</version>
 <scope>test</scope>
</dependency>

Mock Class Level Attributes

...

To commit code to ONAP, you must have git-review installed. The steps in this section only need to be done one time, except the Tips . This should have been done already during Setting Up Your Development Environment.

On Linux

run the following command to check if git-review is installed as part of your OS image.

...

• download the Git for Windows installer
• start installer and follow Git Setup wizard screen Next until Finish prompts to complete the installation.

must have python installed

...

Anchor
Create A Review Create A Review

Creating A Review

...

...

• • The ONAP Jobbuilder will be added automatically within one or two minutes after the review created, and a verfiy build will also be automatically triggered for your review in ONAP jenkins server.
  • The committer can be found from Software Defined Newtork Controller secion in Resources and Repositories (Deprecated) page.

By now, you will just wait and check your email for information of

...

...

Connecting to

...

your deployment

Basic Usage of Vagrant

Vagrant is commags commands are executed on the Base OS.    

...

From the Base OS use the following command to see the running Guess guest VM '  ID id and name.  

vagrant global-status

Port Forwarding

The Guess guest VM is running in its own private network and is using the NAT to get the the Base OS network.  To see the port forwarding run the following command.  

...

If you don't see any ports Oops.  Configuring port-forwarding should have been configured earlier when editing the [integration.git] / bootstrap / vagrant-onap / Vagrantfile.  Something must of went wrong.   Here is the example of a snipet snippet that can be added to teh the Vagrant file.  

 Vagrant.configure("2") do |config|
 
   if provider == :virtualbox && "sdnc".eql?(requested_machine)
     config.vm.network "forwarded_port", guest: 8282, host: 8282, protocol: "tcp", auto_correct: true
     config.vm.network "forwarded_port", guest: 8281, host: 8202, protocol: "tcp", auto_correct: true
   end

...

Port forwarding can also be configured in the Virtual Box Gui.    Here Here is an example

ssh to the

...

Guest OS

The follow command  will open a ssh terminal to the running guess vm.  The guess guest vm name or id can be used.   

...

Basic Usage of Docker

docker commands are excuted executed on the guess guest OS

Get Detail about the dockerCommands 

...

List the running docker containers

The follwing following command will list the running docker containers.  The containterscontainer's id, name and whihc which ports are forwarded to the Guess OS can be found in this list.  

...

Use the docker container id or name use the follwing following command to open a terminal to that container.  

...

OpenDaylight RestConf API Web GUI

To connect to the runing sdnc Port running sdnc port forwarding must be configured correctly.    The The port forwaded forwarded in the instruction above was 8282.  

...

[3] ONAP SDC setup: Using Vagrant-Onap for local deployment of SDC project - WIP!!!#OnapforlocaldeploymentofSDCproject-WIP!!!-InitialSetup

[4] Virtualbox Download link: https://www.virtualbox.org/wiki/Linux_Downloads

...