Update Release Notes
[policy/engine.git] / docs / release-notes.rst
index d3781bc..f4d335d 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**
 
@@ -29,34 +29,25 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
         - POLICY-377   Policy Create API should validate input matches DCAE microservice template
         - POLICY-389   Cleanup Jenkin's CI/CD process's
         - POLICY-449   Policy API + Console : Common Policy Validation
-        - POLICY-520   SSL 64-bit Block Size Cipher Suites Supported (SWEET32)
         - 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
 
-    * [POLICY-393] - This epic covers the body of work involved in deploying the Policy Platform components
     * [POLICY-394] - This epic covers the work required to support a Policy developer environment in which Policy Developers can create, update policy templates/rules separate from the policy Platform runtime platform.
-        - POLICY-172   Use MSB for service discovery during Control Loop Operational Policy execution
         - POLICY-488   pap should not add rules to official template provided in drools applications
 
-    * [POLICY-396] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
         - POLICY-434   need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
 
     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
-        - POLICY-56    VNF Placement Optimization
         - POLICY-622   Integrate OOF Policy Model into Policy Platform
 
-    * [POLICY-400] - This epic covers the work required to support the Policy Platform during runtime.
-    * [POLICY-493] - This epic covers the work required to build Policy Lifecycle API.
     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
         - POLICY-525   Platform Maturity Stability - Drools PDP
         - POLICY-526   Platform Maturity Stability - XACML PDP
@@ -71,10 +62,8 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
 
     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
         - POLICY-523   Platform Maturity Security - CII Badging - Project Website
-        - POLICY-524   Platform Maturity Security - CII Badging - Automated Test Suite
 
     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
-        - POLICY-530   Platform Maturity Scalability - Policy Distribution API
         - POLICY-531   Platform Maturity Scalability - XACML PDP
         - POLICY-532   Platform Maturity Scalability - Drools PDP
         - POLICY-623   Docker image re-design
@@ -88,33 +77,48 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
         - POLICY-536   Platform Maturity Usability - Deployment Documentation
         - POLICY-537   Platform Maturity Usability - API Documentation
 
-    * [POLICY-545] - R2 Beijing - Standardize user roles and access levels across all ONAP components.
     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
-    * [POLICY-547] - R2 Beijing - Implement a new decision type policy that handles naming using policy
-
-    * [OTHER] - Other User stories 
-        - POLICY-5     Deploy a Policy high availability environment 
-        - POLICY-45    VNF Onboarding
-        - POLICY-138   Policy Code Re-Organization
-        - POLICY-148   CLI Integration
 
 
 **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
+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**
 
-Please see the `Policy R2 Beijing Security/Vulnerability Threat <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_ page for security related issues.
+   * Refer to the `Policy R2 Beijing Security/Vulnerability Threat <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_ page for security related issues.
+
+**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
+
+
 
 
 Version: 1.1.3
@@ -124,7 +128,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
 
@@ -218,13 +222,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.
 ..      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.