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.

Table of Contents

Create a Linux Foundation Account

Follow the instructions on the identity portal to create a Linux Foundation account and get access to the ONAP Gerrit instance. Then verify that you can log in at https://gerrit.onap.org/ and that you can see the ONAP list of repositories.

Mac/OSX

get your MBP 2016 ready for development

generate keys - either ssh-add the key or rename it as id_rsa and put it into your ~/.ssh dir

Install the JDK (as dmg) - http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

Install homebrew package manager -

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

python should already be installed. - do a --version check

install pip - sudo easy_install pip

install openstack tools

install docker (dmg) - https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac

install maven - apache-maven-3.6.3-bin.tar, create ~/.m2 and place settings.xml there

git comes with Xcode or Homebrew - do a --version check

install git-review via homebrew: brew install git-review

Unix Setup

Redhat/CentOS

20190130 - re-validating for RHEL 7.6 subscription

...

install java

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

...

yum install git

yum groupinstall 'Development Tools'

this will give you make and python

...

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

...

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

...

~~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

...

theme	Midnight

...

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.

Table of Contents

Create a Linux Foundation Account

Follow the instructions on the identity portal to create a Linux Foundation account and get access to the ONAP Gerrit instance. Then verify that you can log in at https://gerrit.onap.org/ and that you can see the ONAP list of repositories.

Mac/OSX

get your MBP 2016 ready for development

generate keys - either ssh-add the key or rename it as id_rsa and put it into your ~/.ssh dir

Install the JDK (as dmg) - http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

Install homebrew package manager -

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

python should already be installed. - do a --version check

install pip - sudo easy_install pip

install openstack tools

install docker (dmg) - https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac

install maven - apache-maven-3.6.3-bin.tar, create ~/.m2 and place settings.xml there

git comes with Xcode or Homebrew - do a --version check

install git-review via homebrew: brew install git-review

Unix Setup

Redhat/CentOS

20190130 - re-validating for RHEL 7.6 subscription

install java

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:

...

Code Block

language	xml

	<proxies>
        <proxy>
            <id>evil-corp-http</id>
            <active>true</active>
            <protocol>http</protocol>
            <host>proxy.evil-corp.com</host>
            <port>599</port>
            <nonProxyHosts>localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com</nonProxyHosts>
        </proxy>
        <proxy>
            <id>evil-corp-https</id>
            <active>true</active>
            <protocol>https</protocol>
            <host>proxy.evil-corp.com</host>
            <port>599</port>
            <nonProxyHosts>localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com</nonProxyHosts>
        </proxy>
	</proxies>

Local SonarQube Setup

It can be useful to have SonarQube running locally rather than pushing through CI for feedback.

This can be done using docker:

Images of the Community, Developer, and Enterprise Editions are available on Docker Hub.

Start the server by running:

Code Block

language	bash

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

...

Warning

title	Update in Progress below

This page is due some major revision, below section is a placeholder for new/updated layout

ONAP Developer Set-Up (revised)

Create a Linux Foundation Account

OS Specific Instructions

MAC/OSX

Redhat/CentOS

Ubuntu

Windows

GitBash

Java

...

<active>true</active>
            <protocol>https</protocol>
            <host>proxy.evil-corp.com</host>
            <port>599</port>
            <nonProxyHosts>localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com</nonProxyHosts>
        </proxy>
	</proxies>

Local SonarQube Setup

It can be useful to have SonarQube running locally rather than pushing through CI for feedback.

This can be done using docker:

Images of the Community, Developer, and Enterprise Editions are available on Docker Hub.

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.

Warning

title	Update in Progress below

This page is due some major revision, below section is a placeholder / WIP for new/updated layout

ONAP Developer Set-Up (revised)

Create a Linux Foundation Account

Follow the instructions on the identity portal to create a Linux Foundation account and get access to the ONAP Gerrit instance.

Verify that you can log in at https://gerrit.onap.org/ and that you can see the ONAP list of repositories.

OS Specific Instructions

MAC/OSX ( to be reviewed by a MAC user )

get your MBP 2016 ready for development

generate keys - either ssh-add the key or rename it as id_rsa and put it into your ~/.ssh dir

Install the JDK (as dmg) - http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

Install homebrew package manager -

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

python should already be installed. - do a --version check

install pip - sudo easy_install pip

install openstack tools

install docker (dmg) - https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac

install maven - apache-maven-3.6.3-bin.tar, create ~/.m2 and place settings.xml there

git comes with Xcode or Homebrew - do a --version check

install git-review via homebrew: brew install git-review

Redhat/CentOS ( to be reviewed by a Redhat/CentOS user )

20190130 - re-validating for RHEL 7.6 subscription

install java

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 latest Maven

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

Ubuntu ( to be reviewed by a Ubuntu user )

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

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 latest Maven

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-<version>-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

Windows

Note: The DCAE and SDC repo will not fully clone in a windows environment (even git-bash) until some file paths are reduced below 255 chars -

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	DCAE-24

and

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	SDC-21

- you may use Linux or OSX native or VMs as an alternative for now.

Enabling long paths in windows

Code Block
git config --system core.longpaths true

GitBash

Install git-bash in accordance with https://www.atlassian.com/git/tutorials/install-git#windows

Java

ONAP is moving to Java 11 but many projects still use Java 8.

Download and install the appropriate openjdk version in accordance with the component you are using and set JAVA_HOME.

Maven

Download the latest Maven using installer from https://maven.apache.org/download.cgi

Versions Compared

Old Version 145

New Version 146

Key

Create a Linux Foundation Account

Mac/OSX

Unix Setup

Redhat/CentOS

Create a Linux Foundation Account

Mac/OSX

Unix Setup

Redhat/CentOS

Local SonarQube Setup

ONAP Developer Set-Up (revised)

Create a Linux Foundation Account

OS Specific Instructions

MAC/OSX

Redhat/CentOS

Ubuntu

Windows

GitBash

Java

Local SonarQube Setup

ONAP Developer Set-Up (revised)

Create a Linux Foundation Account

OS Specific Instructions

MAC/OSX ( to be reviewed by a MAC user )

Redhat/CentOS ( to be reviewed by a Redhat/CentOS user )

Ubuntu ( to be reviewed by a Ubuntu user )

Windows

GitBash

Install git-bash in accordance with https://www.atlassian.com/git/tutorials/install-git#windows

Java

Maven

Connecting to ONAP Gerrit

Local SonarQube Setup

Troubleshooting

Appendix

Page Comparison

Versions Compared

Old Version 145

New Version 146

Key

Create a Linux Foundation Account

Mac/OSX

Unix Setup

Redhat/CentOS

Create a Linux Foundation Account

Mac/OSX

Unix Setup

Redhat/CentOS

Local SonarQube Setup

ONAP Developer Set-Up (revised)

Create a Linux Foundation Account

OS Specific Instructions

MAC/OSX

Redhat/CentOS

Ubuntu

Windows

GitBash

Java

Local SonarQube Setup

ONAP Developer Set-Up (revised)

Create a Linux Foundation Account

OS Specific Instructions

MAC/OSX ( to be reviewed by a MAC user )

Redhat/CentOS ( to be reviewed by a Redhat/CentOS user )

Ubuntu ( to be reviewed by a Ubuntu user )

Windows

GitBash

Install git-bash in accordance with https://www.atlassian.com/git/tutorials/install-git#windows

Java

Maven

Connecting to ONAP Gerrit

Local SonarQube Setup

Troubleshooting

Appendix