Merge "Fix errors in apex-pdp documentation"
authorLiam Fallon <liam.fallon@est.tech>
Sun, 1 Dec 2019 11:34:00 +0000 (11:34 +0000)
committerGerrit Code Review <gerrit@onap.org>
Sun, 1 Dec 2019 11:34:00 +0000 (11:34 +0000)
docs/apex/APEX-OnapPf-Guide.rst
docs/design/design.rst
docs/installation/oom.rst
docs/pap/response/group-query-pap-resp.json
integration/pom.xml

index 2429185..5e75f32 100644 (file)
@@ -369,45 +369,49 @@ Format of the configuration file (OnapPfConfig.json) explained
 
          .. 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.                |
-            +-----------------------------------+-----------------------------------+
-            | **11**                            | Topic name of the sink to which   |
-            |                                   | PDP-A sends messages.             |
-            +-----------------------------------+-----------------------------------+
-            | **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**                             | 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.”   |
+            +-----------------------------------+-------------------------------------------------+
+            | **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.                              |
+            +-----------------------------------+-------------------------------------------------+
+            | **11**                            | Topic name of the sink to which                 |
+            |                                   | PDP-A sends messages.                           |
+            +-----------------------------------+-------------------------------------------------+
+            | **12**                            | List of servers for the sink                    |
+            |                                   | topic.                                          |
+            +-----------------------------------+-------------------------------------------------+
+            | **13**                            | The sink topic infrastructure.                  |
+            |                                   | For e.g. dmaap, noop, ueb                       |
+            +-----------------------------------+-------------------------------------------------+
index da0c3dc..84beb9e 100644 (file)
@@ -396,7 +396,10 @@ pdp_subgroups                R       M        N/A        A list of PDP subgroups
 ->pdp_type                   R       M        N/A        The PDP type of this PDP subgroup, currently xacml, drools, or
                                                          apex
 ->supported_policy_types     R       N/A      N/A        A list of the policy types supported by the PDPs in this PDP
-                                                         subgroup
+                                                         subgroup.  A trailing “.*” can be used to specify multiple 
+                                                         policy types; for example, “onap.policies.monitoring.*” 
+                                                         would match any policy type beginning with 
+                                                         “onap.policies.monitoring.”
 ->policies                   R       M        N/A        The list of policies running on the PDPs in this PDP subgroup
 ->->(name)                   R       M        N/A        The name of a TOSCA policy running in this PDP subgroup
 ->->policy_type              R       N/A      N/A        The TOSCA policy type of the policy
@@ -861,7 +864,7 @@ services          O       List of String   One or more services the policy appli
 resources         O       List of String   The unique ID for the Control Loop
 geography         O       List of String   The target VNF the actor is executing the recipe on
 
-================= ======= ======== ==================================================================
+================= ======= ============== ==================================================================
 
 This example below shows the JSON body of an Optimize Decision API call.
 
index 748a37b..44588df 100644 (file)
@@ -61,8 +61,8 @@ Accessing the policy docker containers is the same as for any kubernetes contain
 
   kubectl -n onap exec -it dev-policy-policy-xacml-pdp-584844b8cf-9zptx bash
 
-Rebuilding and/or modifying the Policy Charts
-*********************************************
+Installing or Upgrading Policy
+******************************
 The assumption is you have cloned the charts from the OOM repository into a local directory.
 
 **Step 1** Go into local copy of OOM charts
@@ -99,6 +99,12 @@ After deploying policy, loop on monitoring the policy pods until they come up.
   helm deploy dev-policy local/onap --namespace onap
   kubectl get pods -n onap
 
+Restarting a faulty component
+*****************************
+Each policy component can be restarted independently by issuing the following command:
+
+kubectl delete pod <policy-pod> -n onap
+
 Exposing ports
 **************
 For security reasons, the ports for the policy containers are configured as ClusterIP and thus not exposed. If you find you need those ports in a development environment, then the following will expose them.
@@ -107,7 +113,36 @@ For security reasons, the ports for the policy containers are configured as Clus
 
   kubectl -n onap expose service policy-api --port=7171 --target-port=6969 --name=api-public --type=NodePort
 
-Customizing PDP-D Installations
+Overriding certificate stores
+*******************************
+Each policy component keystore and or truststore can be overriden.   The procedure will be applicable
+to an installation that requires certificates other than the pre-packaged AAF derived ones
+that come with the official ONAP distribution.
+
+To override a default keystore, the new certificate store (policy-keystore) file should be placed at the
+appropriate helm chart locations below:
+
+* **oom/kubernetes/policy/charts/drools/resources/secrets/policy-keystore** drools pdp keystore override.
+* **oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-keystore** apex pdp keystore override.
+* **oom/kubernetes/policy/charts/policy-api/resources/config/policy-keystore** api keystore override.
+* **oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-keystore** distribution keystore override.
+* **oom/kubernetes/policy/charts/policy-pap/resources/config/policy-keystore** pap keystore override.
+* **oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-keystore** xacml pdp keystore override.
+
+In the event that the truststore (policy-truststore) needs to be overriden as well, place it at the appropriate
+location below:
+
+* **oom/kubernetes/policy/charts/drools/resources/configmaps/policy-truststore** drools pdp truststore override.
+* **oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-truststore** apex pdp truststore override.
+* **oom/kubernetes/policy/charts/policy-api/resources/config/policy-truststore** api truststore override.
+* **oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-truststore** distribution truststore override.
+* **oom/kubernetes/policy/charts/policy-pap/resources/config/policy-truststore** pap truststore override.
+* **oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-truststore** xacml pdp truststore override.
+
+After these changes, follow the procedures in the :ref:`Installing or Upgrading Policy` section to make usage of
+the new stores effective.
+
+Additional PDP-D Customizations
 *******************************
 
 Credentials and other configuration parameters can be set as values
index eb8b1db..cbdf508 100644 (file)
                             "version": "1.0.0"
                         },
                         {
-                            "name": "onap.policies.monitoring.cdap.tca.hi.lo.app",
-                            "version": "1.0.0"
-                        },
-                        {
-                            "name": "onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server",
-                            "version": "1.0.0"
-                        },
-                        {
-                            "name": "onap.policies.monitoring.docker.sonhandler.app",
+                            "name": "onap.policies.monitoring.*",
                             "version": "1.0.0"
                         },
                         {
index 611ece5..a5cefed 100644 (file)
@@ -44,6 +44,7 @@
         <version.jackson>2.10.0.pr3</version.jackson>
         <version.drools>7.28.0.Final</version.drools>
         <version.jersey>2.29.1</version.jersey>
+        <version.ccsdk>0.4.4</version.ccsdk>
     </properties>
 
     <distributionManagement>
                 <artifactId>logback-classic</artifactId>
                 <version>${version.logback}</version>
             </dependency>
-            
+
             <!-- Dmaap Client -->
             <dependency>
                 <groupId>org.onap.dmaap.messagerouter.dmaapclient</groupId>
                 <version>${version.dmaap}</version>
             </dependency>
 
+            <!-- Common Controller SDK -->
+            <dependency>
+                <groupId>org.onap.ccsdk.cds.components</groupId>
+                <artifactId>proto-definition</artifactId>
+                <version>${version.ccsdk}</version>
+            </dependency>
+
             <!-- AAF Client -->
             <dependency>
                 <groupId>org.onap.aaf.authz</groupId>
                 <plugin>
                     <groupId>org.codehaus.mojo</groupId>
                     <artifactId>versions-maven-plugin</artifactId>
-                    <version>2.5</version>
+                    <version>2.7</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-dependency-plugin</artifactId>
-                    <version>3.1.0</version>
+                    <version>3.1.1</version>
                 </plugin>
                 <plugin>
+                    <!-- THIS PLUGIN IS RETIRED -->
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-reactor-plugin</artifactId>
                     <version>1.1</version>
                 </plugin>
                 <plugin>
+                    <!-- THIS PLUGIN IS RETIRED -->
+                    <!-- Advise to use m2e -->
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-eclipse-plugin</artifactId>
                     <version>2.10</version>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-install-plugin</artifactId>
-                    <version>2.5.2</version>
+                    <version>3.0.0-M1</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-source-plugin</artifactId>
-                    <version>3.0.1</version>
+                    <version>3.2.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-assembly-plugin</artifactId>
-                    <version>3.1.0</version>
+                    <version>3.2.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-jar-plugin</artifactId>
-                    <version>3.1.0</version>
+                    <version>3.2.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-javadoc-plugin</artifactId>
-                    <version>3.0.0</version>
+                    <version>3.1.1</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-shade-plugin</artifactId>
-                    <version>3.1.1</version>
+                    <version>3.2.1</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-archetype-plugin</artifactId>
-                    <version>3.0.1</version>
+                    <version>3.1.2</version>
                 </plugin>
                 <plugin>
                     <groupId>org.apache.maven.archetype</groupId>
                     <artifactId>archetype-packaging</artifactId>
-                    <version>3.0.1</version>
+                    <version>3.1.2</version>
                 </plugin>
                 <plugin>
                     <groupId>com.coderplus.maven.plugins</groupId>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-compiler-plugin</artifactId>
-                    <version>3.7.0</version>
+                    <version>3.8.1</version>
                     <configuration>
                         <encoding>${project.build.sourceEncoding}</encoding>
                         <source>${java.version}</source>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-war-plugin</artifactId>
-                    <version>2.6</version>
+                    <version>3.2.3</version>
+                </plugin>
+                <plugin>
+                    <groupId>io.fabric8</groupId>
+                    <artifactId>docker-maven-plugin</artifactId>
+                    <version>0.31.0</version>
                 </plugin>
                 <plugin>
                     <groupId>org.kie</groupId>