Istanbul - Build

Owned by John Keeney (Ericsson EST)
Last updated: Oct 11, 2021
3 min read

This page describes how to get and build the Istanbul release version of A1-Policy functions.

However, pre-built versions are available to download, so re-building is not necessary for the majority of users - and should only be attempted by experienced ONAP developers.

For more information on running the pre-built and tested versions see Istanbul - Run

Project Requirements

  • Java 11 JDK (make sure that JAVA_HOME environment variable points to correct Java version)

  • Maven 3.6

  • Docker and docker-compose (latest)

Build Code

  • Note 1: While instructions to build the artifacts are included below, pre-built versions are available as Docker Images in http://nexus3.onap.org

    • Building the code should only be attempted if you really need to, or wish in incorporate some change; it is much easier to use the pre-built versions.

  • Note 2: Before attempting to retrieve or build any ONAP component please follow the instructions for Setting Up Your Development Environment 

  • Note 3: After re-building run the functions by following instructions at Istanbul - Run - but note the version numbers of the newly-built functions may be slightly different from the pre-built versions.

Build A1 Policy Management Service container

  • Download the ccsdk/oran repo, Istanbul branch: 

    $ git clone "https://gerrit.onap.org/r/ccsdk/oran" -b istanbul



Build the code and create docker image

To build docker image of the policy management service:

$ cd oran/a1-policy-management/ $ mvn clean install -Dmaven.test.skip=true

If the build is successful an image with following name and tag shall be built, use the command 'docker images' to view the newly built image in the local docker registry.

$ docker images onap/ccsdk-oran-a1policymanagementservice 1.2.2-SNAPSHOT

Build A1 Adapter for Controller

Build the code and create docker images

A1 Adapter is a feature developed within CCSDK which can then be installed in SDNC Karaf Server. To build & run the A1-enabled SDNC Controller, you need to build the CCSDK & SDNC repo's.

The Controller provides a Northbound Interface, to be used only by the A1 Policy Management Service, allowing it to pass messages over the A1 interface to near-RT-RICs in the RAN.

Use the downloaded repo 'ccsdk/oran' as in the previous step, "Build A1 Policy Management Service container"

After you build the A1 adapter artifacts, download below CCSDK/SDNC repos and build them in the following order.

Project

Repo

Gerrit Link

Command

Note

Project

Repo

Gerrit Link

Command

Note

CCSDK

ccsdk/parent

git clone "https://gerrit.onap.org/r/ccsdk/parent" -b istanbul

mvn clean install -Dmaven.test.skip=true

If the parent artifacts are not released you need to build this repo in order to build other ccsdk repos (Including ccsdk/oran/a1-adapter)

CCSDK

ccsdk/features

git clone "https://gerrit.onap.org/r/ccsdk/features" -b istanbul

mvn clean install -Dmaven.test.skip=true



CCSDK

ccsdk/distribution

git clone "https://gerrit.onap.org/r/ccsdk/distribution" -b istanbul

mvn clean install -Dmaven.test.skip=true -Pdocker

Creates the CCSDK docker image

SDNC

sdnc/northbound

git clone "https://gerrit.onap.org/r/sdnc/northbound" -b istanbul

mvn clean install -Dmaven.test.skip=true



SDNC

sdnc/oam

git clone "https://gerrit.onap.org/r/sdnc/oam" -b istanbul

mvn clean install -Dmaven.test.skip=true -Pdocker

Creates the SDNC docker image. Make sure you refer the right docker image version in the pom file.(eg: you may need to update ccsdk.docker.version for onap/ccsdk-ansible-server-image from 1.2-STAGING-latest to 1.2-SNAPSHOT-latest)

Note: full re-builds of the CCSDK and SDNC projects are prone to errors - cloned functions may require manual tweaking to be successful. It is usually better to use pre-built and tested images.

If your build is unsuccessful more help can be found from the CCSDK/SDNC Developer teams: CCSDK Project & SDNC Project

If the builds are successful, images with following name and tag shall exist, use the command 'docker images' to view the newly built images in the local docker registry.

Proxy support for A1 adapter

There is the possibility to use a proxy when CCSDK SLI node function to perform REST calls southbound to near-RT-RICs. 

In order to configure proxy:

  • Add proxy URL to properties file odlsli/src/main/properties/a1-adapter-api-dg.properties variable a1Mediator.proxy.url

    • This file is part of CCSDK/distribution project

    • After adding this information in the file, the distribution repo from CCSDK must be rebuilt, follow by the SDNC/oam repo.

    • URL format must be protocol://host:port for example http://proxy:8443