Follow the steps below to set up the development environment on your client machine, and to establish credentials with which you may access the repositories.

...

set JAVA_HOME in ~/.bashrc

yum install java-1.8.0-openjdk-devel

get it via alternatives --config javac

currently

export JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.131-3.b12.el7_3.x86_64

install git and development tools

yum install git

yum groupinstall 'Development Tools'

this will give you make and python

install npm
(will also be installed automatically by the ecomp build) - TODO: UPDATE as ecomp is locked

download and install Maven 3.6.3

create an ~/.m2 folder and copy our settings.xml there

add maven to your path - check it with mvn --version

http://maven.apache.org/download.cgi

tar -xvf apache-maven-3.6.3-bin.tar.gz

Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux

-Djava.net.preferIPv4Stack=true

enable IP4 forwarding to enable the RHEL VM to act as an edge router - without this docker containers cannot communicate

add to /etc/sysctl.conf
net.ipv4.ip_forward = 1

Install docker (required for some repos like dcae-inventory off dcae

~~sudo yum install -y yum-utils~~

~~sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo~~

~~sudo yum-config-manager --enable docker-ce-edge~~

~~sudo yum makecache fast~~

~~sudo yum install docker-ce~~

~~sudo systemctl start docker~~

20190130

Code Block

theme	Midnight

sudo curl https://releases.rancher.com/install-docker/17.03.sh | sh

sudo wget https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64 -O jq
sudo chmod 777 jq
# not +x or jq will not be runnable from your non-root user
sudo mv jq /usr/local/bin
jq --version

sudo usermod -aG docker ubuntu

to install kubernetes follow Cloud Native Deployment#Scriptedundercloud(Helm/Kubernetes/Docker)andONAPinstall-SingleVM

...

enable ubuntu desktop

apt-get update

apt-get install ubuntu-desktop

enable static IP

vi /etc/network/interfaces

add

iface enp0s25 inet static

address 192.168.15.101

netmask 255.255.255.0

network 192.168.15.0

broadcast 192.168.15.255

gateway 192.168.15.1

dns-nameservers 8.8.4.4

disable strict host checking (client and server)

in ~/.ssh/config

Host *
   StrictHostKeyChecking no
   UserKnownHostsFile=/dev/null

Enable non CD repositories so an apt-get update will work

comment out the CD first line in /etc/apt/sources.list

enable ssh if skipped during installation so we can remote ssh sudo apt-get install openssh-server

enable root login and gui (no sudo su -)

sudo passwd root

sudo usermod -U root

sudo reboot now

sudo vi /etc/lightdm/lightdm.conf

[SeatDefaults]

greeter-session=unity-greeter

user-session=ubuntu

greeter-show-manual-login=true

: enable root login

vi /etc/ssh/sshd_config

FROM:
PermitRootLogin prohibit-password
TO:
PermitRootLogin yes

systemctl restart sshd

The 131 version of Java 8 is installed by default - currently running 151

set JAVA_HOME in ~/.bashrc or /etc/environment

ubuntu@ubuntu:~$ echo $JAVA_HOME
/usr/lib/jvm/java-1.8.0-openjdk-amd64

if not

sudo apt install openjdk-8-jdk

install git and development tools

sudo apt-get install git

install npm
(will also be installed automatically by the ecomp build) sudo apt install npm

download and install Maven 3.5.0

create an ~/.m2 folder and copy our settings.xml there

add maven to your path - check it with mvn --version

http://maven.apache.org/download.cgi

tar -xvf apache-maven-3.5.0-bin.tar.gz

or

sudo apt install maven

Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux

in /etc/environment

-Djava.net.preferIPv4Stack=true

Install docker (required when building docker images)

use the current as of 20180621 17.03 version in the script

https://git.onap.org/logging-analytics/tree/deploy/rancher/oom_rancher_setup.sh

which is

Code Block

language	bash
theme	Midnight

curl https://releases.rancher.com/install-docker/17.03.sh | sh

...

Info
You should execute `puttygen.exe` as an Administrator, otherwise, the key files will be stored in `%localappdata%\VirtualStore\PuTTY`, typically `C:\Users\<user>\AppData\Local\VirtualStore\Program Files (x86)\PuTTY.`

To do this, right-click on C:\Program Files (x86)\PuTTY\puttygen.exe and select Run as Administrator:

...

Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux

-Djava.net.preferIPv4Stack=true

enable IP4 forwarding to enable the RHEL VM to act as an edge router - without this docker containers cannot communicate

add to /etc/sysctl.conf
net.ipv4.ip_forward = 1

Install docker (required for some repos like dcae-inventory off dcae

~~sudo yum install -y yum-utils~~
~~sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo~~
~~sudo yum-config-manager --enable docker-ce-edge~~
~~sudo yum makecache fast~~
~~sudo yum install docker-ce~~
~~sudo systemctl start docker~~
20190130

Code Block

theme	Midnight

sudo curl https://releases.rancher.com/install-docker/17.03.sh | sh

sudo wget https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64 -O jq
sudo chmod 777 jq
# not +x or jq will not be runnable from your non-root user
sudo mv jq /usr/local/bin
jq --version

sudo usermod -aG docker ubuntu

to install kubernetes follow Cloud Native Deployment#Scriptedundercloud(Helm/Kubernetes/Docker)andONAPinstall-SingleVM

...

enable ubuntu desktop

apt-get update

apt-get install ubuntu-desktop

enable static IP

vi /etc/network/interfaces

add

iface enp0s25 inet static

address 192.168.15.101

netmask 255.255.255.0

network 192.168.15.0

broadcast 192.168.15.255

gateway 192.168.15.1

dns-nameservers 8.8.4.4

disable strict host checking (client and server)

in ~/.ssh/config

Host *
   StrictHostKeyChecking no
   UserKnownHostsFile=/dev/null

Enable non CD repositories so an apt-get update will work

comment out the CD first line in /etc/apt/sources.list

enable ssh if skipped during installation so we can remote ssh sudo apt-get install openssh-server

enable root login and gui (no sudo su -)

sudo passwd root

sudo usermod -U root

sudo reboot now

sudo vi /etc/lightdm/lightdm.conf

[SeatDefaults]

greeter-session=unity-greeter

user-session=ubuntu

greeter-show-manual-login=true

: enable root login

vi /etc/ssh/sshd_config

FROM:
PermitRootLogin prohibit-password
TO:
PermitRootLogin yes

systemctl restart sshd

Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux

in /etc/environment

-Djava.net.preferIPv4Stack=true

Install docker (required when building docker images)

use the current as of 20180621 17.03 version in the script
https://git.onap.org/logging-analytics/tree/deploy/rancher/oom_rancher_setup.sh
which is

Code Block

language	bash
theme	Midnight

curl https://releases.rancher.com/install-docker/17.03.sh | sh

...

Expand

The first issue is that the current ONAP master tagged version of the checkstyle does not work with Eclipse Oxygen/Photon (and maybe other versions) because of the "curly bracket" issue. There is a fix on the way but it's not here yet. The current tagged version of oparent we are using in Policy is 1.2.1.

To get around this issue, check out oparent, checked out the 1.2.1 tag, fixed the "curly bracket" bug and built it on my local machine.

Check out oparent
git tag -l
git co tags/1.2.3 -b 1.2.3
If you want CheckStyle to ignore generated files, do the following:
1. Add the following tag to the above file:
  <module name="SuppressionFilter">
  <property name="file" value="<absolute path to the directory of the file>/suppressions.xml"/>
  </module>
2. Create a file called "suppressions.xml" in the folder given above, and put the following content in it:
  <?xml version="1.0"?>
  <!DOCTYPE suppressions PUBLIC
  "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
  "https://checkstyle.org/dtds/suppressions_1_2.dtd">
  <suppressions>
  <suppress files="[\\/]generated-sources[\\/]" checks="[a-zA-Z0-9]*"/>
  </suppressions>
The versions in the POMs in oparent are snapshot, so we need to change those to 1.2.1
mvn versions:set -DnewVersion=1.2.1
Now build locally:
mvn clean install

IntelliJ

Optional

Python

Info
Check which version of python your project is using before installing.

...

Installing Intellij Community Edition on Linux

Download

...

...

...

...

Add python binary to Path.

...

#section=windows

Installing IntelliJ Community Edition and the Java SDK on Windows

When you start your first IntelliJ project, you will need to specify the Java Software Development Kit (SDK) as the project's. If you do not have the Java SDK installed on your machine, you can download it from within IntelliJ by selecting Maven as the New Project type and clicking on "Download SDK": (Or, visit http://www.oracle.com/technetwork/java/javase/downloads/index.html).

Configure ONAP code formatting for IntelliJ

ONAP is using google java style as mentioned in ONAP java style. Import intellij-java-google-style.xml in intelliJ settings→code style→java and modify the following items,

Tabs and Indents→Indent ( from 2 to 4)

Wrapping and Braces → hard wrap at ( 120)

SO Project: Method above won't work, install plugin Eclipse Code Formatter and configure it with the corresponding xml file (so/project-configs/code-tools/onap-eclipse-format.xml)

Configure ONAP copyright for IntelliJ

You can create copyright profile to auto-generate the copyright text. e.g, add the following text to new profile,
Replace <organization name>

Expand

============LICENSE_START=======================================================
Copyright (C) $today.year <organization name>
================================================================================
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

SPDX-License-Identifier: Apache-2.0
============LICENSE_END=========================================================

Set up SonarLint towards ONAP for IntelliJ

PreRequisites

You need to be part of the onap organization in GitHub (see GitHub, click on your icon and select 'My Organizations')
If you are not a member of this organization email support.linuxfoundation.org and ask to be added to the onap organization in GitHub
Note. It is possible to enter a different organization if you at least member of 1 organization (you can create your own in GitHub).
The plugin wizard crashes if you are member of no organization at all, see this Bug: https://jira.sonarsource.com/browse/SLI-426

To use SonarLint with Onap projects you need to setup a connection with SonarCloud

Select, File, Settings, Tools, SonarLint.
Click on + beside the 'SonarCube / SonarClod connections' box to add a new connection
Set Configuration Name to something like 'ONAP'
Ensure sonarcloud is selected and click [Next]
Click [Create Token]
Select GitHub, logon and follow the GitHub wizard to create a Token
Copy Token into IntelliJ wizard
Click [Next] (might have to wait a little while your data is being downloaded)
Select 'Open Network Automation Platform (ONAP)' from 'Your Organizations' and click [Next]
Click [Finish] to close the wizard
Click [OK] to leave settings

Then you need to bind each project to the corresponding project in GitHub/SonarCloud:

Select, File, Settings, Tools, SonarLint, Project Settings
Enable (check) 'Binfd project to SonarQube / SonarCloud'
Select the connection created above using the [Configure the connection] button
Enter the project name (e.g. 'onap_ccsdk-sli-plugins') or select it using [Search in list..]
Start typing the name of your project, and it should appear in a list box where it should be selected.
Click [OK] to finish

Optional

Python

Info
Check which version of python your project is using before installing.

Download Python from https://www.python.org/downloads/

Add python binary to Path.

Install "pip3", if you plan to use git-review.

git-review

In a shell, type the following command (assumes you installed python above) :

...

Start the server by running:

Code Block

language	bash

$ docker run -d --name sonarqube -p 9000:9000 sonarqube:latest

Log in to http://localhost:9000 with System Administrator credentials (login=admin, password=admin).
Click the Create new project button to analyze your first project.

Other Tools

The component you are working on may require additional tool installations, see the relevant section under Development Guides.

Troubleshooting

Appendix

Building Entire ONAP

Versions Compared

Old Version 162

New Version 163

Key

IntelliJ

Optional

Python

Installing Intellij Community Edition on Linux

Installing IntelliJ Community Edition and the Java SDK on Windows

Configure ONAP code formatting for IntelliJ

Configure ONAP copyright for IntelliJ

Set up SonarLint towards ONAP for IntelliJ

Optional

Python

git-review

Other Tools

Troubleshooting

Appendix

Page Comparison

Versions Compared

Old Version 162

New Version 163

Key

IntelliJ

Optional

Python

Installing Intellij Community Edition on Linux

Installing IntelliJ Community Edition and the Java SDK on Windows

Configure ONAP code formatting for IntelliJ

Configure ONAP copyright for IntelliJ

Set up SonarLint towards ONAP for IntelliJ

Optional

Python

git-review

Other Tools

Troubleshooting

Appendix