summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/development/devtools/drools-s3p.rst112
-rw-r--r--docs/development/devtools/images/ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e.pngbin67774 -> 0 bytes
-rw-r--r--docs/development/devtools/images/ControlLoop-vCPE-Fail.pngbin67512 -> 0 bytes
-rw-r--r--docs/development/devtools/images/ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3.pngbin69667 -> 0 bytes
-rw-r--r--docs/development/devtools/images/ControlLoop-vDNS-Fail.pngbin66615 -> 0 bytes
-rw-r--r--docs/development/devtools/images/ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a.pngbin72763 -> 0 bytes
-rw-r--r--docs/release-notes.rst131
7 files changed, 208 insertions, 35 deletions
diff --git a/docs/development/devtools/drools-s3p.rst b/docs/development/devtools/drools-s3p.rst
index 18bd4898..303a6beb 100644
--- a/docs/development/devtools/drools-s3p.rst
+++ b/docs/development/devtools/drools-s3p.rst
@@ -25,6 +25,15 @@ The worker VM hosting the policy components has the following spec:
The standalone VM designated to run jmeter has the same configuration. The jmeter JVM
was instantiated with a max heap configuration of 12G.
+The drools-pdp container uses the default JVM memory settings from a default OOM installation:
+
+.. code-block:: bash
+
+ VM settings:
+ Max. Heap Size (Estimated): 989.88M
+ Using VM: OpenJDK 64-Bit Server VM
+
+
Other ONAP components used during the stability tests are:
- Policy XACML PDP to process guard queries for each transaction.
@@ -57,25 +66,12 @@ The feature-controlloop-utils was started by adding the following script:
oom/kubernetes/policy/charts/drools/resources/configmaps/features.pre.sh:
- #!/bin/bash
- bash -c "features enable controlloop-utils"
+ #!/bin/sh
+ sh -c "features enable controlloop-utils"
Stability Test of Policy PDP-D
******************************
-The 72 hour stability test happened in parallel with the stability run of the API component.
-
-Worker Node performance
-=======================
-
-The VM named onap-k8s-09 was monitored for the duration of the 72 hours
-stability run. The table below show the usage ranges:
-
-.. code-block:: bash
-
- NAME CPU(cores) CPU%
- onap-k8s-09 <=1214m <=20%
-
PDP-D performance
=================
@@ -104,16 +100,10 @@ The command executed was
.. code-block:: bash
- ./jmeter -n -t /home/ubuntu/drools-applications/testsuites/stability/src/main/resources/frankfurt/s3p.jmx -l /home/ubuntu/jmeter_result/jmeter.jtl -e -o /home/ubuntu/jmeter_result > /dev/null 2>&1
+ ./jmeter -n -t /home/ubuntu/drools-applications/testsuites/stability/src/main/resources/s3p.jmx -l /home/ubuntu/jmeter_result/jmeter.jtl -e -o /home/ubuntu/jmeter_result > /dev/null 2>&1
-The results were computed by taking the ellapsed time from the audit.log
-(this log reports all end to end transactions, marking the start, end, and
-ellapsed times).
+The results were computed by monitoring the statistics REST endpoint accessible through the telemetry shell or APIs.
-The count reflects the number of successful transactions as expected in the
-use case, as well as the average, standard deviation, and max/min. An histogram
-of the response times have been added as a visual indication on the most common
-transaction times.
vCPE Success scenario
=====================
@@ -122,9 +112,22 @@ ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e:
.. code-block:: bash
- Max: 4323 ms, Min: 143 ms, Average: 380 ms [samples taken for average: 260628]
+ # Times are in milliseconds
-.. image:: images/ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e.png
+ # Previous to the run, there was 1 failure as a consequence of testing
+ # the flows before the stability load was initiated. There was
+ # an additional failure encountered during the execution.
+
+ "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e": {
+ "policyExecutedCount": 161328,
+ "policyExecutedSuccessCount": 161326,
+ "totalElapsedTime": 44932780,
+ "averageExecutionTime": 278.5181741545175,
+ "birthTime": 1616092087842,
+ "lastStart": 1616356511841,
+ "lastExecutionTime": 1616356541972,
+ "policyExecutedFailCount": 2
+ }
vCPE Failure scenario
@@ -134,9 +137,18 @@ ControlLoop-vCPE-Fail:
.. code-block:: bash
- Max: 3723 ms, Min: 148 ms, Average: 671 ms [samples taken for average: 87888]
+ # Times are in milliseconds
-.. image:: images/ControlLoop-vCPE-Fail.png
+ "ControlLoop-vCPE-Fail": {
+ "policyExecutedCount": 250172,
+ "policyExecutedSuccessCount": 0,
+ "totalElapsedTime": 63258856,
+ "averageExecutionTime": 252.8614553187407,
+ "birthTime": 1616092143137,
+ "lastStart": 1616440688824,
+ "lastExecutionTime": 1616440689010,
+ "policyExecutedFailCount": 250172
+ }
vDNS Success scenario
=====================
@@ -145,9 +157,18 @@ ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3:
.. code-block:: bash
- Max: 6437 ms, Min: 19 ms, Average: 165 ms [samples taken for average: 59259]
+ # Times are in milliseconds
-.. image:: images/ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3.png
+ "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3": {
+ "policyExecutedCount": 235438,
+ "policyExecutedSuccessCount": 235438,
+ "totalElapsedTime": 37564263,
+ "averageExecutionTime": 159.550552587093,
+ "birthTime": 1616092578063,
+ "lastStart": 1616356511253,
+ "lastExecutionTime": 1616356511653,
+ "policyExecutedFailCount": 0
+ }
vDNS Failure scenario
=====================
@@ -156,9 +177,19 @@ ControlLoop-vDNS-Fail:
.. code-block:: bash
- Max: 1176 ms, Min: 4 ms, Average: 5 ms [samples taken for average: 340810]
+ # Times are in milliseconds
+
+ "ControlLoop-vDNS-Fail": {
+ "policyExecutedCount": 2754574,
+ "policyExecutedSuccessCount": 0,
+ "totalElapsedTime": 14396495,
+ "averageExecutionTime": 5.22639616869977,
+ "birthTime": 1616092659237,
+ "lastStart": 1616440696444,
+ "lastExecutionTime": 1616440696444,
+ "policyExecutedFailCount": 2754574
+ }
-.. image:: images/ControlLoop-vDNS-Fail.png
vFirewall Success scenario
==========================
@@ -167,6 +198,19 @@ ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a:
.. code-block:: bash
- Max: 4016 ms, Min: 177 ms, Average: 644 ms [samples taken for average: 36460]
-
-.. image:: images/ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a.png
+ # Times are in milliseconds
+
+ # Previous to the run, there were 2 failures as a consequence of testing
+ # the flows before the stability load was initiated. There was
+ # an additional failure encountered during the execution.
+
+ "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a": {
+ "policyExecutedCount": 145197,
+ "policyExecutedSuccessCount": 145194,
+ "totalElapsedTime": 33100249,
+ "averageExecutionTime": 227.96785746261975,
+ "birthTime": 1616092985229,
+ "lastStart": 1616356511732,
+ "lastExecutionTime": 1616356541972,
+ "policyExecutedFailCount": 3
+ }
diff --git a/docs/development/devtools/images/ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e.png b/docs/development/devtools/images/ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e.png
deleted file mode 100644
index 5708502f..00000000
--- a/docs/development/devtools/images/ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e.png
+++ /dev/null
Binary files differ
diff --git a/docs/development/devtools/images/ControlLoop-vCPE-Fail.png b/docs/development/devtools/images/ControlLoop-vCPE-Fail.png
deleted file mode 100644
index 8c87ddfe..00000000
--- a/docs/development/devtools/images/ControlLoop-vCPE-Fail.png
+++ /dev/null
Binary files differ
diff --git a/docs/development/devtools/images/ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3.png b/docs/development/devtools/images/ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3.png
deleted file mode 100644
index 763efe76..00000000
--- a/docs/development/devtools/images/ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3.png
+++ /dev/null
Binary files differ
diff --git a/docs/development/devtools/images/ControlLoop-vDNS-Fail.png b/docs/development/devtools/images/ControlLoop-vDNS-Fail.png
deleted file mode 100644
index bd7302c5..00000000
--- a/docs/development/devtools/images/ControlLoop-vDNS-Fail.png
+++ /dev/null
Binary files differ
diff --git a/docs/development/devtools/images/ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a.png b/docs/development/devtools/images/ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a.png
deleted file mode 100644
index 5ba85fb4..00000000
--- a/docs/development/devtools/images/ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a.png
+++ /dev/null
Binary files differ
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index a8f6d00a..6d7a5401 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -14,6 +14,135 @@ Policy Release Notes
.. * Except the date and the version number, all the other sections are optional but there must be at least
.. * one section describing the purpose of this new release.
+.. ==========================
+.. * * * HONOLULU * * *
+.. ==========================
+
+Version: 8.0.0
+--------------
+
+:Release Date: 2021-04-08 (Honolulu Release)
+
+New features
+============
+
+Artifacts released:
+
+.. csv-table::
+ :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
+ :widths: 15,10,10
+
+ "policy/parent", "3.3.0", ""
+ "policy/common", "1.8.0", ""
+ "policy/models", "2.4.2", ""
+ "policy/api", "2.4.2", "onap/policy-api:2.4.2"
+ "policy/pap", "2.4.2", "onap/policy-pap:2.4.2"
+ "policy/drools-pdp", "1.8.2", "onap/policy-drools:1.8.2"
+ "policy/apex-pdp", "2.5.2", "onap/policy-apex-pdp:2.5.2"
+ "policy/xacml-pdp", "2.4.2", "onap/policy-xacml-pdp:2.4.2"
+ "policy/drools-applications", "1.8.2", "onap/policy-pdpd-cl:1.8.2"
+ "policy/distribution", "2.5.2", "onap/policy-distribution:2.5.2"
+ "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
+
+Key Updates
+===========
+
+* Enhanced statistics
+ - PDPs provide statistics, retrievable via PAP REST API
+* PDP deployment status
+ - Policy deployment API enhanced to reflect actual policy deployment status in PDPs
+ - Make PAP component stateless
+* Policy support
+ - Upgrade XACML 3.0 code to use new Time Extensions
+ - Enhancements for interoperability between Native Policies and other policy types
+ - Support for arbitrary policy types on the Drools PDP
+ - Improve handling of multiple policies in APEX PDP
+ - Update policy-models TOSCA handling with Control Loop Entities
+* Alternative locking mechanisms
+ - Support NO locking feature in Drools-PDP
+* Security
+ - Remove credentials in code from the Apex JMS plugin
+* Actor enhancements
+ - Actors should give better warnings than NPE when data is missing
+ - Remove old event-specific actor code
+* PDP functional assignments
+ - Make PDP type configurable in drools-pdp
+ - Make PDP type configurable in xacml-pdp
+* Performance improvements
+ - Support policy updates between PAP and the PDPs, phase 1
+* Maintainability
+ - Use ONAP base docker image
+ - Remove GPLv3 components from docker containers
+ - Move CSITs to Policy repos
+ - Deprecate server pool feature in drools-pdp
+* PoCs
+ - Merge CLAMP functionality into Policy Framework project
+ - TOSCA Defined Control Loop
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+~~~~~~~~~~~~~~~~~~
+
+The policy API component requires a fresh new database when migrating to the honolulu release.
+Therefore, upgrades require a fresh new database installation.
+Please see the
+`Installing or Upgrading Policy <https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
+
+Known Vulnerabilities
+~~~~~~~~~~~~~~~~~~~~~
+
+Workarounds
+~~~~~~~~~~~
+
+Security Notes
+==============
+
+* `POLICY-3005 <https://jira.onap.org/browse/POLICY-3005>`_ - Bump direct dependency versions
+ - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.12
+ - Upgrade org.eclipse.persistence to 2.7.8
+ - Upgrade org.glassfish.jersey.containers to 2.33
+ - Upgrade com.fasterxml.jackson.module to 2.11.3
+ - Upgrade com.google.re2j to 1.5
+ - Upgrade org.mariadb.jdbc to 2.7.1
+ - Upgrade commons-codec to 1.15
+ - Upgrade com.thoughtworks.xstream to 1.4.15
+ - Upgrade org.apache.httpcomponents:httpclient to 4.5.13
+ - Upgrade org.apache.httpcomponents:httpcore to 4.4.14
+ - Upgrade org.json to 20201115
+ - Upgrade org.projectlombok to 1.18.16
+ - Upgrade org.yaml to 1.27
+ - Upgrade io.cucumber to 6.9.1
+ - Upgrade org.apache.commons:commons-lang3 to 3.11
+ - Upgrade commons-io to 2.8.0
+* `POLICY-2936 <https://jira.onap.org/browse/POLICY-2936>`_ - Upgrade to latest version of CDS API
+ - Upgrade io.grpc to 1.35.0
+ - Upgrade com.google.protobuf to 3.14.0
+
+
+References
+==========
+
+For more information on the ONAP Honolulu release, please see:
+
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
+
+
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
+
+Quick Links:
+ - `POLICY project page`_
+ - `Passing Badge information for POLICY`_
+
+
.. ========================
.. * * * GUILIN * * *
.. ========================
@@ -133,7 +262,7 @@ Security Notes
References
==========
-For more information on the ONAP Frankfurt release, please see:
+For more information on the ONAP Guilin release, please see:
#. `ONAP Home Page`_
#. `ONAP Documentation`_