Merge "New min/max Guard Policy"
[policy/engine.git] / docs / release-notes.rst
index 91ec769..708c351 100644 (file)
@@ -13,10 +13,10 @@ Policy Release Notes
 ..      * This note must be removed after content has been added.
 
 
-Version: 1.2.0
+Version: 1.2.3
 --------------
 
-:Release Date: 2018-05-24 (Beijing Release)
+:Release Date: 2018-06-07 (Beijing Release)
 
 **New Features**
 
@@ -32,11 +32,9 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
         - POLICY-568   Integration with org.onap AAF project
         - POLICY-610   Support vDNS scale out for multiple times in Beijing release
 
-
     * [POLICY-391] - This epic covers the work to support Release Planning activities
         - POLICY-552   ONAP Licensing Scan - Use Restrictions
 
-
     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
         - POLICY-529   Platform Maturity Performance - Drools PDP
         - POLICY-567   Platform Maturity Performance - PDP-X
@@ -84,29 +82,50 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
 
 **Bug Fixes**
 
-    * POLICY-454       brmsgw 1.1.2 policy rules generation in a 1.1.1 docker image
-    * POLICY-484       Extend election handler run window and clean up error messages
-    * POLICY-494       POLICY EELF Audit.log not in ECOMP Standards Compliance
-    * POLICY-501       Fix issues blocking election handler and add directed interface for opstate
-    * POLICY-509       Add IntelliJ file to .gitingore
-    * POLICY-510       Do not enforce hostname validation
-    * POLICY-518       StateManagement creation of EntityManagers.
-    * POLICY-519       Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
-    * POLICY-629       Fixed a bug on editor screen
-    * POLICY-684       Fix regex for brmsgw dependency handling
-    * POLICY-707       ONAO-PAP-REST unit tests fail on first build on clean checkout 
-    * POLICY-717       Fix a bug in checking required fields if the object has include function
-    * POLICY-734       Fix Fortify Header Manipulation Issue
-    * POLICY-743       Fixed data name since its name was changed on server side
-    * POLICY-753       Policy Health Check failed with multi-node cluster
-    * POLICY-763       PDP-D throwing NullPointerException for multiple vDNS and VOLTE messages injected in parallel
-    * POLICY-765       junit test for guard fails intermittently
+The following bug fixes have been deployed with this release:
 
+    * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
+    * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
+    * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
+    * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
+    * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
+    * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
+    * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
+    * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
+    * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
+    * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout 
+    * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
+    * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
+    * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
+    * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
+    * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
 
 
-**Security Issues**
+**Security Notes**
+
+POLICY code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_.
+
+Quick Links:
+       - `POLICY project page <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_
+
+       - `Passing Badge information for POLICY <https://bestpractices.coreinfrastructure.org/en/projects/1614>`_
+
+       - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
+
+**Known Issues**
+
+The following known issues will be addressed in a future release:
+
+    * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
+    * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
+    * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
+    * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
+    * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
+    * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
+    * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
+    * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
+
 
-   * Please see the `Policy R2 Beijing Security/Vulnerability Threat <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_ page for security related issues.
 
 
 Version: 1.1.3
@@ -116,7 +135,7 @@ Version: 1.1.3
 
 **Bug Fixes**
 
-The following bugs were deployed with the Amsterdam Maintenance Release:
+The following fixes were deployed with the Amsterdam Maintenance Release:
 
     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
 
@@ -210,13 +229,17 @@ The Amsterdam release continued evolving the design driven architecture of and f
 .. note
 ..      CHANGE  HISTORY
 ..      03/22/2018 - Initial document for Beijing release.
-..             For initial document: list epic and user stories for each, list user stories with no epics.  
-..             For Bugs section, list bugs that are not tied to an epic.  Remove all items with "Won't Do" resolution.
 ..      01/15/2018 - Added change for version 1.1.3 to the Amsterdam branch.  Also corrected prior version (1.2.0) to (1.1.1)
-..      11/16/2017 - Initial document for Amsterdam release.
+..             Also, Set up initial information for Beijing.
+..     05/29/2018 - Information for Beijing release.
+..             Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
  
 
 End of Release Notes
 
+.. How to notes for SS 
+..     For initial document: list epic and user stories for each, list user stories with no epics.  
+..             For Bugs section, list bugs that are not tied to an epic.  Remove all items with "Won't Do" resolution.
+..             For Known issues, list bugs that are slotted for a future release.