SDC Build Instructions
Before starting to make sure you have a working development environment.
You can follow the Setting Up Your Development Environment Page.
Table Of Contents:
Required Tools
The computer must have the following software packages installed:
- Latest node version, currently 6.9.5 or higher (Installs the needed version of npm as well) you can download from here: https://nodejs.org/
- Latest maven vesrion, currently 3.3.9
- JDK 8, you can download from here: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
Clone Repositories
Create a sdc folder and run the following command
git clone http://gerrit.onap.org/r/sdc
Building SDC
Maven settings.xml
Ensure Maven settings.xml contains ONAP and OpenDaylight nexus repositories. See Setting Up Your Development Environment#MavenExamplesettings.xml
Now all you need to is to build the project:
cd c:\dvlp\sdc mvn clean install
Installing SDC
1 Overview
SDC is deployed using a HEAT template that bootstraps a VM machine on the Rackspace cloud. Assuming that the deployment runs as expected then the following System setup, prerequisites and requirements should automatically be put in place.
This document describes the manual processes required to perform any one of the automated steps, if the deployment did not run to completion as expected.
The document deals with several key topics:
- System setup and prerequisites
- Manual system setup
- SDC application setup
- SDCconsumers setup
2 System setup and prerequisites
Operating system requirements
- Ubuntu v16.04
- Volume allocated and named /data
- Docker service installed, up and running
- Docker is connected to the Docker hub repository
SDC application requirements
- <environment>.json located under: /data/ASDC/environments
- docker_health.sh script located under: /data/scripts
- docker_run.sh script located under: /data/scripts
3 Manual system setup
The manual system setup consists of :
- Installing the Docker service
- Updating Ubuntu to the latest version available on the Rackspace repository
- Allocating volume for /data
- Setting the connection to the Docker hub repository
Installing the Docker service
- Start the Rackspace machine
A. Login to Rackspace console
B. Start the Rackspace VM
C. Login to the Rackspace server with the credentials given by Rackspace Check Ubuntu uname:
uname -r
The output needs to be grater then 3.13.0-91-generic:For example: root@vm1-asdc:/data# uname -r 4.4.0-51-generic
Install the Docker service:
A. Login to the new machine as root and run:apt-get update apt-get install apt-transport-https ca-certificates (Press Y) apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D echo "deb https://apt.dockerproject.org/repo ubuntu-trusty main" | tee /etc/apt/sources.list.d/docker.list apt-get update apt-cache policy docker-engine apt-get -y install linux-image-extra-$(uname -r) linux-image-extra-virtual apt-get -y install docker-engine service docker start
B. Verify that Java is installed:
java -version
C. If Java is not installed then run:apt-get install default-jre apt-get update
A system restart is required; reboot the server.
Updating Ubuntu to the latest version available on the Rackspace repository
Login to the Rackspace server:
The output for a successful login will be displayed; check the version, for example:Welcome to Ubuntu 16.04.1 LTS (GNU/Linux 4.4.0-51-generic x86_64)
Upgrade UBUNTU (only if version is below 16.04.1 LTS):
Run: do-release-upgrade (press y, press enter twice, y, select “install the package maintainer's version”, y, y - for reboot)this will update Ubuntu from 14.04.1 LTS to 16.04.1 LTS
Allocating a volume for data
vi /etc/fstab, add this line:
/dev/xvdb1 /data ext4 errors=remount-ro,noatime,barrier=0 0 1
Check that the volume is mounted:
df -h | grep data
The expected result should be in the form:
/dev/xvdb1 99G 528M 93G 1% /data
Set connection to Docker hub repository
This section deals with connecting to the OpenECOMP SDC Docker repository and checking that the Docker Service is up and running.
To set the connection to the Docker hub repository:
- add to /etc/hosts "10.208.197.75 ecomp-nexus"
- Connect to OpenEcomp SDC docker-repo (only if needed):
- keytool -printcert -sslserver ecomp-nexus:8443 -rfc > nexus.crt
- cp nexus.crt /usr/local/share/ca-certificates/
- update-ca-certificates
- service docker restart
- docker stop/waiting
- docker start/running, process 6518
- Check that the Docker service is up and running by running the command:
- service docker status
4 SDC application setup
This section runs a script to start the Dockers and boot the system. The script takes the latest Dockers from the Docker repository. The boot process takes approximately 1 minute.
Starting the SDC application
The SDC application is executed using several Dockers
To start the dockers:
Run the script in the format usage as described:
Usage: /data/scripts/docker_run.sh -e <environment name> -r <release> -p <docker-hub-port>