Policy Platform Development

This article explains how to build the ONAP Policy Framework for development purposes. To start, the developer should consult the latest ONAP Wiki to familiarize themselves with developer best practices and how-tos to setup their environment, see https://wiki.onap.org/display/DW/Developer+Best+Practices.

This article assumes that:

  • You are using a *nix operating system such as linux or macOS.
  • You are using a directory called git off your home directory (~/git) for your git repositories
  • Your local maven repository is in the location ~/.m2/repository
  • You have added settings to access the ONAP Nexus to your M2 configuration, see Maven Settings Example (bottom of the linked page)

The procedure documented in this article has been verified to work on a MacBook laptop running macOS Yosemite Version 10.10,5, Sierra Version 10.12.6, a HP Z600 desktop running Ubuntu 16.04.3 LTS, and an Unbuntu 16.04 VM.

Cloning All The Policy Repositories

Run a script such as the script below to clone the required modules from the ONAP git repository. This script clones all the ONAP Policy Framework repositories.

ONAP Policy Framework has dependencies to the ONAP Parent oparent module, the ONAP ECOMP SDK ecompsdkos module, and the A&AI Schema module.

Typical ONAP Policy Framework Clone Script
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
 #!/usr/bin/env bash

 ## script name for output
 MOD_SCRIPT_NAME=`basename $0`

 ## the ONAP clone directory, defaults to "onap"
 clone_dir="onap"

 ## the ONAP repos to clone
 onap_repos="\
 policy/parent \
 policy/common \
 policy/models \
 policy/docker \
 policy/api \
 policy/pap \
 policy/apex-pdp \
 policy/drools-pdp \
 policy/drools-applications \
 policy/xacml-pdp \
 policy/engine \
 policy/distribution"

 ##
 ## Help screen and exit condition (i.e. too few arguments)
 ##
 Help()
 {
     echo ""
     echo "$MOD_SCRIPT_NAME - clones all required ONAP git repositories"
     echo ""
     echo "       Usage:  $MOD_SCRIPT_NAME [-options]"
     echo ""
     echo "       Options"
     echo "         -d          - the ONAP clone directory, defaults to '.'"
     echo "         -h          - this help screen"
     echo ""
     exit 255;
 }

 ##
 ## read command line
 ##
 while [ $# -gt 0 ]
 do
     case $1 in
         #-d ONAP clone directory
         -d)
             shift
             if [ -z "$1" ]; then
                 echo "$MOD_SCRIPT_NAME: no clone directory"
                 exit 1
             fi
             clone_dir=$1
             shift
         ;;

         #-h prints help and exists
         -h)
             Help;exit 0;;

         *)    echo "$MOD_SCRIPT_NAME: undefined CLI option - $1"; exit 255;;
     esac
 done

 if [ -f "$clone_dir" ]; then
     echo "$MOD_SCRIPT_NAME: requested clone directory '$clone_dir' exists as file"
     exit 2
 fi
 if [ -d "$clone_dir" ]; then
     echo "$MOD_SCRIPT_NAME: requested clone directory '$clone_dir' exists as directory"
     exit 2
 fi

 mkdir $clone_dir
 if [ $? != 0 ]
 then
     echo cannot clone ONAP repositories, could not create directory '"'$clone_dir'"'
     exit 3
 fi

 for repo in $onap_repos
 do
     repoDir=`dirname "$repo"`
     repoName=`basename "$repo"`

     if [ ! -z $dirName ]
     then
         mkdir "$clone_dir/$repoDir"
         if [ $? != 0 ]
         then
             echo cannot clone ONAP repositories, could not create directory '"'$clone_dir/repoDir'"'
             exit 4
         fi
     fi

     git clone https://gerrit.onap.org/r/${repo} $clone_dir/$repo
 done

 echo ONAP has been cloned into '"'$clone_dir'"'

Execution of the script above results in the following directory hierarchy in your ~/git directory:

  • ~/git/onap
  • ~/git/onap/policy
  • ~/git/onap/policy/parent
  • ~/git/onap/policy/common
  • ~/git/onap/policy/models
  • ~/git/onap/policy/api
  • ~/git/onap/policy/pap
  • ~/git/onap/policy/docker
  • ~/git/onap/policy/drools-applications
  • ~/git/onap/policy/drools-pdp
  • ~/git/onap/policy/engine
  • ~/git/onap/policy/apex-pdp
  • ~/git/onap/policy/xacml-pdp
  • ~/git/onap/policy/distribution

Building ONAP Policy Framework Components

Step 1: Optionally, for a completely clean build, remove the ONAP built modules from your local repository.

rm -fr ~/.m2/repository/org/onap

Step 2: A pom such as the one below can be used to build the ONAP Policy Framework modules. Create the pom.xml file in the directory ~/git/onap/policy.

Typical pom.xml to build the ONAP Policy Framework
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.onap</groupId>
     <artifactId>onap-policy</artifactId>
     <version>1.0.0-SNAPSHOT</version>
     <packaging>pom</packaging>
     <name>${project.artifactId}</name>
     <inceptionYear>2017</inceptionYear>
     <organization>
         <name>ONAP</name>
     </organization>

     <modules>
         <module>parent</module>
         <module>common</module>
         <module>models</module>
         <module>api</module>
         <module>pap</module>
         <module>apex-pdp</module>
         <module>xacml-pdp</module>
         <module>drools-pdp</module>
         <module>drools-applications</module>
         <!-- The engine repo is being deprecated,
         and can be ommitted if not working with
         legacy api and components. -->
         <module>engine</module>
         <module>distribution</module>
     </modules>
 </project>

Policy Architecture/API Transition

In Dublin, a new Policy Architecture was introduced. The legacy architecture runs in parallel with the new architecture. It will be deprecated after Frankfurt release.

If the developer is only interested in working with the new architecture components, the engine sub-module can be ommitted.

Step 3: You can now build the Policy framework

cd ~/git/onap
mvn clean install

End of Document