Before starting to make sure you have a working development environment.
You can follow the Setting Up Your Development Environment Page.
Table Of Contents:
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
Create a sdc folder and run the following command
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:
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:
The output needs to be grater then 3.13.0-91-generic:
Install the Docker service:
A. Login to the new machine as root and run:
B. Verify that Java is installed:
C. If Java is not installed then run:
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:
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:
Check that the volume is mounted:
The expected result should be in the form:
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/
- 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>
Note: the use of spaces and dashes in the script format is mandatory.
Example usage as for the Orange environment:
A Health check to verify that OpenECOMP SDC is up and running is conducted as part of the docker_run.sh script. The expected output would look similar to that provided:
5 SDC consumers setup
This section describes the process for creating an SDC consumer that allows OpenECOMP components to communicate with SDC.
Creating SDC consumers
In order to integrate with other OpenECOMP components, consumers are configured per component. This operation is performed as an integral part of executing the Backend Docker.
The following users are predefined:
For the purposes of this document, the manual consumer configuration process is described.
To create new SDC consumers:
- Login to the SDC Rackspace VM
- Copy the file security-utils-1610.2.1.jar to the VM under /tmp
Run the following commands from the Docker, providing consumer specific values for the parameters that are inside <>:
Note: Repeat the consumer creation process for each consumer, providing Consumer specific consumerName and user_pass
Check that the consumer was successfully created in SDC: