Update policy release notes
[policy/parent.git] / docs / release-notes.rst
index 6d7a540..f63bc8b 100644 (file)
@@ -18,10 +18,69 @@ Policy Release Notes
 ..      * * *    HONOLULU    * * *
 ..      ==========================
 
+Version: 8.0.1
+--------------
+
+:Release Date: 2021-08-12 (Honolulu Maintenance Release #1)
+
+**Artifacts**
+
+Artifacts released:
+
+.. csv-table::
+   :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
+   :widths: 15,10,10
+
+   "policy/parent", "3.3.2", ""
+   "policy/common", "1.8.2", ""
+   "policy/models", "2.4.4", ""
+   "policy/api", "2.4.4", "onap/policy-api:2.4.4"
+   "policy/pap", "2.4.5", "onap/policy-pap:2.4.5"
+   "policy/drools-pdp", "1.8.4", "onap/policy-drools:1.8.4"
+   "policy/apex-pdp", "2.5.4", "onap/policy-apex-pdp:2.5.4"
+   "policy/xacml-pdp", "2.4.5", "onap/policy-xacml-pdp:2.4.5"
+   "policy/drools-applications", "1.8.4", "onap/policy-pdpd-cl:1.8.4"
+   "policy/distribution", "2.5.4", "onap/policy-distribution:2.5.4"
+   "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
+
+
+**Bug Fixes and Necessary Enhancements**
+
+
+    * `[POLICY-3062] <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
+    * `[POLICY-3066] <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
+    * `[POLICY-3078] <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
+    * `[POLICY-3173] <https://jira.onap.org/browse/POLICY-3173>`_ - APEX-PDP incorrectly reports successful policy deployment to PAP
+    * `[POLICY-3202] <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
+    * `[POLICY-3227] <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
+    * `[POLICY-3230] <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
+    * `[POLICY-3248] <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
+    * `[POLICY-3301] <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
+    * `[POLICY-3305] <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
+    * `[POLICY-3331] <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
+    * `[POLICY-3338] <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
+    * `[POLICY-3366] <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
+    * `[POLICY-3450] <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
+    * `[POLICY-3454] <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
+    * `[POLICY-3485] <https://jira.onap.org/browse/POLICY-3485>`_ - Limit statistics record count
+    * `[POLICY-3507] <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
+    * `[POLICY-3516] <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
+
+
+Known Limitations
+=================
+
+The APIs provided by xacml-pdp (e.g., healthcheck, statistics, decision)
+are always active.  While PAP controls which policies are deployed to a
+xacml-pdp, it does not control whether or not the APIs are active.
+In other words, xacml-pdp will respond to decision requests, regardless
+of whether PAP has made it ACTIVE or PASSIVE.
+
+
 Version: 8.0.0
 --------------
 
-:Release Date: 2021-04-08 (Honolulu Release)
+:Release Date: 2021-04-29 (Honolulu Release)
 
 New features
 ============
@@ -89,7 +148,7 @@ 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.
+`Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/honolulu/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
 
 Known Vulnerabilities
 ~~~~~~~~~~~~~~~~~~~~~
@@ -97,6 +156,8 @@ Known Vulnerabilities
 Workarounds
 ~~~~~~~~~~~
 
+* `POLICY-2998 <https://jira.onap.org/browse/POLICY-2998>`_ - Provide a script to periodically purge the statistics table
+
 Security Notes
 ==============
 
@@ -117,6 +178,9 @@ Security Notes
     - Upgrade io.cucumber to 6.9.1
     - Upgrade org.apache.commons:commons-lang3 to 3.11
     - Upgrade commons-io to 2.8.0
+* `POLICY-2943 <https://jira.onap.org/browse/POLICY-2943>`_ - Review license scan issues
+    - Upgrade com.hazelcast to 4.1.1
+    - Upgrade io.netty to 4.1.58.Final
 * `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
@@ -180,8 +244,6 @@ Key Updates
    - All components return with non-zero exit code in case of application failure
    - All components log to standard out (i.e., k8s logs) by default
    - Continue to write log files inside individual pods, as well
-* Multi-tenancy
-   - Basic initial support using the existing features
 * E2E Network Slicing
    - Added ModifyNSSI operation to SO actor
 * Consolidated health check
@@ -220,7 +282,7 @@ System Limitations
 The policy API component requires a fresh new database when migrating to the guilin 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.
+`Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/guilin/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
 
 Known Vulnerabilities
 ~~~~~~~~~~~~~~~~~~~~~
@@ -471,14 +533,14 @@ POLICY-APEX-PDP
 * Passing parameters from ApexConfig to policy logic.
    - TaskParameters can be used to pass parameters from ApexConfig to the policy logic. Consider a scenario where from CLAMP, serviceId or closedLoopId has to be passed to the policy, and this should be available to perform some logic or action within the policy. In the CLAMP UI, while configuring the APEX Policy, specifying taskParameters with these will enable this.
 
-   - More information about the usage of Task Parameters can be found here: https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-User-Manual.html#configure-task-parameters
+   - More information about the usage of Task Parameters can be found here: https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-User-Manual.html#configure-task-parameters
 
    - In the taskLogic, taskParameters can be accessed as  executor.parameters.get("ParameterKey1"))
 
-   - More information can be found here: https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-Policy-Guide.html#accessing-taskparameters
+   - More information can be found here: https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-Policy-Guide.html#accessing-taskparameters
 
 * GRPC support for APEX-CDS interaction.
-   - APEX-PDP now supports interaction with CDS over gRPC. Up through El Alto, CDS interaction was possible over REST only. A new plugin was developed in APEX for this feature. Refer the link for more details. https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-User-Manual.html#grpc-io
+   - APEX-PDP now supports interaction with CDS over gRPC. Up through El Alto, CDS interaction was possible over REST only. A new plugin was developed in APEX for this feature. Refer the link for more details. https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-User-Manual.html#grpc-io
 
 POLICY-XACML-PDP
 ================
@@ -525,7 +587,7 @@ System Limitations
 The policy API component requires a fresh new database when migrating to the frankfurt release.
 Therefore, upgrades require a fresh new database installation.
 Please see the
-`Installing or Upgrading Policy <https://onap.readthedocs.io/en/frankfurt/submodules/policy/parent.git/docs/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
+`Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
 
 Known Vulnerabilities
 ~~~~~~~~~~~~~~~~~~~~~