Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes how to get and build the Jakarta 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 Jakarta - Run

Table of Contents

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 Jakarta - Run - but note the version numbers of the newly-built functions may be slightly different from the pre-built versions.
    • Version numbers used in this page may not be the most recent ... you should verify version numbers of your newly built component, and check for latest versions of pre-built components

Build A1 Policy Management Service container

  • Download the ccsdk/oran repo, Istanbul branch: 

    Code Block
    languagebash
    $ git clone "https://gerrit.onap.org/r/ccsdk/oran" -b jakarta


Build the code and create docker image

To build docker image of the A1 Policy Management Service:

Code Block
languagebash
$ 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.

(You should double check the docker tag/version corresponds to the version you've just built.)

Code Block
languagebash
themeMidnight
$ docker images
onap/ccsdk-oran-a1policymanagementservice 1.3.4-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 the SDNC/ODL Karaf Server. To build & run the A1-enabled SDNC Controller, you need to build the CCSDK & SDNC repos.

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"

Code Block
languagebash
$ cd a1-adapter
$ mvn clean install -Dmaven.test.skip=true

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

(You should double check the docker tag/versions corresponds to the latest released versions and the version you've just built.)

ProjectRepoGerrit LinkCommandNote
CCSDKccsdk/parentgit clone "https://gerrit.onap.org/r/ccsdk/parent" -b jakarta
mvn clean install -Dmaven.test.skip=trueIf the parent artifacts are not yet released you need to build this repo in order to build other any other ccsdk repos (Including ccsdk/oran/a1-adapter)
CCSDKccsdk/featuresgit clone "https://gerrit.onap.org/r/ccsdk/features" -b jakarta
mvn clean install -Dmaven.test.skip=true
CCSDKccsdk/distributiongit clone "https://gerrit.onap.org/r/ccsdk/distribution" -b jakarta
mvn clean install -Dmaven.test.skip=true -PdockerCreates the CCSDK docker image
SDNCsdnc/northboundgit clone "https://gerrit.onap.org/r/sdnc/northbound" -b jakarta
mvn clean install -Dmaven.test.skip=true
SDNCsdnc/oamgit clone "https://gerrit.onap.org/r/sdnc/oam" -b jakarta
mvn clean install -Dmaven.test.skip=true -PdockerCreates the SDNC docker image.
Make sure you refer to the appropriate docker image version in the pom file, e.g., you may need to update ccsdk.docker.version for onap/ccsdk-ansible-server-image from 1.3.3-STAGING-latest to 1.3.3-SNAPSHOT-latest to refer to the latest newly built versions.
(You should double check the docker tag/versions corresponds to the latest released versions and the version you've just built.)

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.

Code Block
languagebash
themeMidnight
$ docker images | grep onap
onap/sdnc-image latest
onap/sdnc-ansible-server-image latest
onap/admportal-sdnc-image latest
onap/ccsdk-dgbuilder-image latest
onap/sdnc-ueb-listener-image latest
onap/sdnc-dmaap-listener-image:latest

Proxy support for A1 adapter

There is the possibility to use a HTTP proxy for A1 Adapter southbound calls (when CCSDK SLI graph node functions need to perform REST calls southbound to near-RT-RICs). 

To configure HTTP 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 repo
    • URL format must be protocol://host:port for example http://proxy:8443 
  • After adding this information in the file, the CCSDK/distribution components must be rebuilt, then SDNC/oam repo must also be rebuilt to include the newly built CCSDK/distribution components.