APEX OnapPf Guide 

Contents

APEX OnapPf Guide
- Installation
- APEXOnapPf Configuration File Explained
  - Format of the configuration file (OnapPfConfig.json) explained

Installation 

Build and Install 

Refer to Apex User Manual to find details on the build and installation of the APEX component. Information on the requirements and system configuration can also be found here.

Installation Layout 

A full installation of APEX comes with the following layout.
$APEX_HOME
    ├───bin             (1)
    ├───etc             (2)
    │   ├───editor
    │   ├───hazelcast
    │   ├───infinispan
    │   └───META-INF
    │   ├───onappf
    |       └───config      (3)
    │   └───ssl             (4)
    ├───examples            (5)
    │   ├───config          (6)
    │   ├───docker          (7)
    │   ├───events          (8)
    │   ├───html            (9)
    │   ├───models          (10)
    │   └───scripts         (11)
    ├───lib             (12)
    │   └───applications        (13)
    └───war             (14)
1

binaries, mainly scripts (bash and bat) to start the APEX engine and applications

2

configuration files, such as logback (logging) and third party library configurations

3

configuration file for APEXOnapPf, such as OnapPfConfig.json (initial configuration for APEXOnapPf)

4

ssl related files such as policy-keystore and policy-truststore

5

example policy models to get started

6

configurations for the examples (with sub directories for individual examples)

7

Docker files and additional Docker instructions for the examples

8

example events for the examples (with sub directories for individual examples)

9

HTML files for some examples, e.g. the Decisionmaker example

10

the policy models, generated for each example (with sub directories for individual examples)

11

additional scripts for the examples (with sub directories for individual examples)

12

the library folder with all Java JAR files

13

applications, also known as jar with dependencies (or fat jars), individually deployable

14

WAR files for web applications

Verify the APEXOnapPf Installation 

When APEX is installed and all settings are realized, the installation can be verified.

Verify Installation - run APEXOnapPf

A simple verification of an APEX installation can be done by simply starting the APEXOnapPf without any configuration. On Unix (or Cygwin) start the engine using $APEX_HOME/bin/apexOnapPf.sh. On Windows start the engine using %APEX_HOME%\bin\apexOnapPf.bat. The engine will fail to fully start. However, if the output looks similar to the following line, the APEX installation is realized.
1Apex [main] INFO o.o.p.a.s.onappf.ApexStarterMain - In ApexStarter with parameters []
2Apex [main] ERROR o.o.p.a.s.onappf.ApexStarterMain - start of services-onappf failed
3org.onap.policy.apex.services.onappf.exception.ApexStarterException: apex starter configuration file was not specified as an argument
4at org.onap.policy.apex.services.onappf.ApexStarterCommandLineArguments.validateReadableFile(ApexStarterCommandLineArguments.java:278)
5        at org.onap.policy.apex.services.onappf.ApexStarterCommandLineArguments.validate(ApexStarterCommandLineArguments.java:165)
6        at org.onap.policy.apex.services.onappf.ApexStarterMain.<init>(ApexStarterMain.java:66)
7        at org.onap.policy.apex.services.onappf.ApexStarterMain.main(ApexStarterMain.java:165)
To fully verify the installation, run the ApexOnapPf by providing the configuration files.

OnapPfConfig.json is the file which contains the initial configuration to startup the ApexStarter service. The dmaap topics to be used for sending or receiving messages is also specified in the this file. Provide this file as argument while running the ApexOnapPf.
1# $APEX_HOME/bin/apexOnapPf.sh -c $APEX_HOME/etc/onappf/config/OnapPfConfig.json (1)
2# $APEX_HOME/bin/apexOnapPf.sh -c C:/apex/apex-full-2.0.0-SNAPSHOT/etc/onappf/config/OnapPfConfig.json (2)
3>%APEX_HOME%\bin\apexOnapPf.bat -c %APEX_HOME%\etc\onappf\config\OnapPfConfig.json (3)
1

UNIX

2

Cygwin

3

Windows

The APEXOnapPf should start successfully. Assuming the logging levels are not changed (default level is info), the output should look similar to this (last few lines)
 1In ApexStarter with parameters [-c, C:/apex/etc/onappf/config/OnapPfConfig.json] . . .
 2Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting set alive
 3Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting register pdp status context object
 4Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting topic sinks
 5Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting Pdp Status publisher
 6Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting Register pdp update listener
 7Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting Register pdp state change request dispatcher
 8Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting Message Dispatcher . . .
 9Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager starting Rest Server . . .
10Apex [main] INFO o.o.p.c.u.services.ServiceManager - service manager started
11Apex [main] INFO o.o.p.a.s.onappf.ApexStarterMain - Started ApexStarter service
The ApexOnapPf service is now running, sending heartbeat messages to dmaap (which will be received by PAP) and listening for messages from PAP on the dmaap topic specified. Based on instructions from PAP, the ApexOnapPf will deploy or undeploy policies on the ApexEngine.

Terminate APEX by simply using CTRL+C in the console.

Running APEXOnapPf in Docker 

Running APEX from the ONAP docker repository only requires 2 commands:
Log into the ONAP docker repo
docker login -u docker -p docker nexus3.onap.org:10003
Run the APEX docker image
docker run -p 6969:6969 -p 23324:23324 -it --rm  nexus3.onap.org:10001/onap/policy-apex-pdp:2.1-SNAPSHOT-latest /bin/bash -c "/opt/app/policy/apex-pdp/bin/apexOnapPf.sh -c /opt/app/policy/apex-pdp/etc/onappf/config/OnapPfConfig.json"
To run the ApexOnapPf, the startup script apexOnapPf.sh along with the required configuration files are specified. Also, the ports 6969 (healthcheck) and 23324 (deployment port for the ApexEngine) are exposed.

Build a Docker Image

Alternatively, one can use the Dockerfile defined in the Docker package to build an image.

APEX Dockerfile

#
# Docker file to build an image that runs APEX on Java 11 or better in alpine
#
FROM onap/policy-jre-alpine:2.0.1

LABEL maintainer="Policy Team"

ARG POLICY_LOGS=/var/log/onap/policy/apex-pdp
ENV POLICY_HOME=/opt/app/policy/apex-pdp
ENV POLICY_LOGS=$POLICY_LOGS

RUN apk add --no-cache \
        vim \
        iproute2 \
        iputils \
    && addgroup -S apexuser && adduser -S apexuser -G apexuser \
    && mkdir -p $POLICY_HOME \
    && mkdir -p $POLICY_LOGS \
    && chown -R apexuser:apexuser $POLICY_LOGS \
    && mkdir /packages

COPY /maven/apex-pdp-package-full.tar.gz /packages
RUN tar xvfz /packages/apex-pdp-package-full.tar.gz --directory $POLICY_HOME \
    && rm /packages/apex-pdp-package-full.tar.gz \
    && find /opt/app -type d -perm 755 \
    && find /opt/app -type f -perm 644 \
    && chmod 755 $POLICY_HOME/bin/* \
    && cp -pr $POLICY_HOME/examples /home/apexuser \
    && chown -R apexuser:apexuser /home/apexuser/* $POLICY_HOME \
    && chmod 644 $POLICY_HOME/etc/*

USER apexuser
ENV PATH $POLICY_HOME/bin:$PATH
WORKDIR /home/apexuser

APEXOnapPf Configuration File Explained 

The ApexOnapPf is initialized using a configuration file:

OnapPfConfig.json

Format of the configuration file (OnapPfConfig.json) explained 

The configuration file is a JSON file containing the initial values for configuring the rest server for healthcheck and the pdp itself. The topic infrastructure and the topics to be used for sending or receiving messages is specified in this configuration file. A sample can be found below:
{
    "name":"ApexStarterParameterGroup",
    "restServerParameters": {  (1)
        "host": "0.0.0.0",
        "port": 6969,
        "userName": "...",
        "password": "...",
        "https": true  (2)
    },
    "pdpStatusParameters":{
        "timeIntervalMs": 120000,  (3)
        "pdpType":"apex",  (4)
        "pdpGroup":"defaultGroup",  (5)
        "description":"Pdp Heartbeat",
        "supportedPolicyTypes":[{"name":"onap.policies.controlloop.operational.Apex","version":"1.0.0"}]  (6)
    },
    "topicParameterGroup": {
        "topicSources" : [{  (7)
            "topic" : "POLICY-PDP-PAP",  (8)
            "servers" : [ "message-router" ],  (9)
            "topicCommInfrastructure" : "dmaap"  (10)
        }],
        "topicSinks" : [{  (11)
            "topic" : "POLICY-PDP-PAP",  (12)
            "servers" : [ "message-router" ],  (13)
            "topicCommInfrastructure" : "dmaap"  (14)
        }]
    }
}
1

parameters for setting up the rest server such as host, port userName and password.

2

https flag if enabled will enable https support by the rest server.

3

time interval in which PDP-A has to send heartbeats to PAP. Specified in milliseconds.

4

Type of the pdp.

5

The group to which the pdp belong to.

6

List of policy types supported by the PDP. A trailing “.*” can be used to specify multiple policy types; for example, “onap.policies.controlloop.operational.apex.*” would match any policy type beginning with “onap.policies.controlloop.operational.apex.”

7

List of topics’ details from which messages are received.

8

Topic name of the source to which PDP-A listens to for messages from PAP.

9

List of servers for the source topic.

10

The source topic infrastructure. For e.g. dmaap, noop, ueb

11

List of topics’ details to which messages are sent.

12

Topic name of the sink to which PDP-A sends messages.

13

List of servers for the sink topic.

14

The sink topic infrastructure. For e.g. dmaap, noop, ueb