.. http://creativecommons.org/licenses/by/4.0
-APEX-OnapPf Guide
+APEX OnapPf Guide
*****************
.. contents::
^^^^^^^^^^^^
Build and Install
--------------------
+-----------------
.. container:: paragraph
- Refer `Apex User Manual <https://docs.onap.org/en/casablanca/submodules/policy/apex-pdp.git/docs/APEX-User-Manual.html>`_ to find details on the build and installation of the APEX component. Information on the requirements and system configuration can also be found here.
+ Refer to
+ :ref:`Apex User Manual <apex-user-manual-label>` 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
-------------------
:number-lines:
#
- # Docker file to build an image that runs APEX on Java 8 in alpine
+ # Docker file to build an image that runs APEX on Java 11 or better in alpine
#
- FROM onap/policy-base-alpine:1.4.0
+ FROM onap/policy-jre-alpine:2.0.1
LABEL maintainer="Policy Team"
- ARG BUILD_VERSION=${BUILD_VERSION}
ARG POLICY_LOGS=/var/log/onap/policy/apex-pdp
-
- ENV BUILD_VERSION ${BUILD_VERSION}
- ENV POLICY_HOME=/opt/app/policy
- ENV POLICY_APEX_PDP_HOME=${POLICY_HOME}/apex-pdp
- ENV POLICY_LOGS=${POLICY_LOGS}
+ ENV POLICY_HOME=/opt/app/policy/apex-pdp
+ ENV POLICY_LOGS=$POLICY_LOGS
RUN apk add --no-cache \
- vim \
- iproute2 \
- iputils
-
- # Create apex user and group
- RUN addgroup -S apexuser && adduser -S apexuser -G apexuser
-
-
- # Add Apex-specific directories and set ownership as the Apex admin user
- RUN mkdir -p ${POLICY_APEX_PDP_HOME} \
- && mkdir -p ${POLICY_LOGS} \
- && chown -R apexuser:apexuser ${POLICY_LOGS}
-
- # Unpack the tarball
- RUN mkdir /packages
- COPY apex-pdp-package-full.tar.gz /packages
- RUN tar xvfz /packages/apex-pdp-package-full.tar.gz --directory ${POLICY_APEX_PDP_HOME} \
- && rm /packages/apex-pdp-package-full.tar.gz
-
- # Ensure everything has the correct permissions
- RUN find /opt/app -type d -perm 755 \
+ 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 a+x ${POLICY_APEX_PDP_HOME}/bin/*
-
- # Copy examples to Apex user area
- RUN cp -pr ${POLICY_APEX_PDP_HOME}/examples /home/apexuser \
- && chown -R apexuser:apexuser /home/apexuser/*
+ && 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_APEX_PDP_HOME}/bin:$PATH
+ ENV PATH $POLICY_HOME/bin:$PATH
WORKDIR /home/apexuser
APEXOnapPf Configuration File Explained
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. container:: paragraph
"pdpStatusParameters":{
"timeIntervalMs": 120000, (3)
"pdpType":"apex", (4)
+ "pdpGroup":"defaultGroup", (5)
"description":"Pdp Heartbeat",
- "supportedPolicyTypes":[{"name":"onap.policies.controlloop.operational.Apex","version":"1.0.0"}] (5)
+ "supportedPolicyTypes":[{"name":"onap.policies.controlloop.operational.Apex","version":"1.0.0"}] (6)
},
"topicParameterGroup": {
- "topicSources" : [{ (6)
- "topic" : "POLICY-PDP-PAP", (7)
- "servers" : [ "message-router" ], (8)
- "topicCommInfrastructure" : "dmaap" (9)
+ "topicSources" : [{ (7)
+ "topic" : "POLICY-PDP-PAP", (8)
+ "servers" : [ "message-router" ], (9)
+ "topicCommInfrastructure" : "dmaap" (10)
}],
- "topicSinks" : [{ (10)
- "topic" : "POLICY-PDP-PAP", (11)
- "servers" : [ "message-router" ], (12)
- "topicCommInfrastructure" : "dmaap" (13)
+ "topicSinks" : [{ (11)
+ "topic" : "POLICY-PDP-PAP", (12)
+ "servers" : [ "message-router" ], (13)
+ "topicCommInfrastructure" : "dmaap" (14)
}]
}
}
.. container:: colist arabic
- +-----------------------------------+-----------------------------------+
- | **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** | List of policy types supported by |
- | | the PDP. |
- +-----------------------------------+-----------------------------------+
- | **6** | List of topics' details from |
- | | which messages are received. |
- +-----------------------------------+-----------------------------------+
- | **7** | Topic name of the source to which |
- | | PDP-A listens to for messages |
- | | from PAP. |
- +-----------------------------------+-----------------------------------+
- | **8** | List of servers for the source |
- | | topic. |
- +-----------------------------------+-----------------------------------+
- | **9** | The source topic infrastructure. |
- | | For e.g. dmaap, noop, ueb |
- +-----------------------------------+-----------------------------------+
- | **10** | List of topics' details to which |
- | | messages are sent to. |
- +-----------------------------------+-----------------------------------+
- | **11** | Topic name of the sink to which |
- | | PDP-A sends messages to. |
- +-----------------------------------+-----------------------------------+
- | **12** | List of servers for the sink |
- | | topic. |
- +-----------------------------------+-----------------------------------+
- | **13** | The sink topic infrastructure. |
- | | For e.g. dmaap, noop, ueb |
- +-----------------------------------+-----------------------------------+
+ +-----------------------------------+-------------------------------------------------+
+ | **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 |
+ +-----------------------------------+-------------------------------------------------+
Code Review / policy / parent.git / blobdiff