Update Architecture
[policy/engine.git] / docs / release-notes.rst
index b4bf76a..ef4ff23 100644 (file)
@@ -13,10 +13,179 @@ Policy Release Notes
 ..      * This note must be removed after content has been added.
 
 
-Version: 1.2.2
+..      ==========================
+..      * * *   CASABLANCA   * * *
+..      ==========================
+
+Version: 3.0.0
 --------------
 
-:Release Date: 2018-05-24 (Beijing Release)
+:Release Date: 2018-11-30 (Casablanca Release)
+
+**New Features**
+
+The Casablanca release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Casablanca release, refer to `JiraPolicyCasablanca`_ (Note: Jira details can also be viewed from this link).
+
+    * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution 
+        - POLICY-723   Analyze and design the Policy SDC Distribution Application
+        - POLICY-922   Create application framework for Policy Service SDC Distribution
+        - POLICY-923   Create code to generate docker images for Policy SDC Service Distribution application
+        - POLICY-924   Create CSIT test framework for Policy SDC Service Distribution application
+        - POLICY-925   Create K8S Helm Charts for deployment via OOM project
+        - POLICY-926   Create code infrastructure for automatic policy forwarding
+        - POLICY-956   Implement IConfiguration interface to initiate Distribution Client
+        - POLICY-974   Implement INotificationCallback interface
+        - POLICY-1094  Refactor reception handler configuration parameter handling
+
+    * [POLICY-715] - This epic covers work to harden the policy platform
+        - POLICY-955   Incorporate changes to amsterdam rules template into casablanca rules template
+        - POLICY-1128  Fix new sonar issues
+
+    * [POLICY-718] - This epic covers the work to perform release planning activities.
+        - POLICY-875   Update Beijing Branch and master branch for Casablanca versions
+        - POLICY-1040  Copy and clean up Beijing wiki's for Casablanca
+
+    * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
+        - POLICY-724   Gather requirements and design high-level software architecture
+        - POLICY-1056  Create Policy API Infrastructure
+
+    * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
+        - POLICY-874   Spike: Interface Stubbing for Architectual Enhancements
+
+    * [POLICY-772] - Enhance casablanca testing abilities between various environments
+
+    * [POLICY-803] - All the new repositories must be initialized and setup to work under policy/parent.
+        - POLICY-804   Setup policy/parent
+        - POLICY-805   Setup policy/models
+        - POLICY-806   Setup policy/api
+        - POLICY-807   Setup policy/apex-pdp
+        - POLICY-808   Setup ci-management verify/merge jobs
+        - POLICY-845   Setup policy/core
+        - POLICY-846   Setup policy/xacml-pdp
+        - POLICY-847   Setup policy/gui
+        - POLICY-848   Setup policy/pap
+        - POLICY-849   Setup policy/pdp
+        - POLICY-871   Setup policy/distribution
+
+    * [POLICY-809] - Maintain and implement performance
+        - POLICY-836   Performance PSSD (Policy SDC Service Distribution)
+        - POLICY-887   Performance PDP-X - Policy Decisions
+        - POLICY-888   Performance PDP-D - Policy Decision/Enforcement
+
+    * [POLICY-814] - 72 hour stability testing (component and platform)
+        - POLICY-815   Stability PDP-X
+        - POLICY-817   Stability PDP-A
+
+    * [POLICY-824] - maintain and implement security
+        - POLICY-781   PE Support for AAF Root Certificate in HTTPS communication.
+        - POLICY-905   Fix apex-engine License and Security issues
+        - POLICY-913   policy/engine CADI (AAF) Integration
+        - POLICY-914   policy/drools-pdp CADI (AAF) Integration
+        - POLICY-918   Policy Portal GUI - upgrade to latest Portal SDK to resolve security issues
+        - POLICY-942   BRMSGW: HTTPS support for DMaaP/UEB interfaces
+        - POLICY-946   Investigate what integration of CADI (AAF) integration into the ONAP Policy Platform components really means
+        - POLICY-982   Update security issues since portal SDK was upgraded
+        - POLICY-1030  Revisit CLM reports due to new software upgrade
+        - POLICY-1059  Address the security issues with Severe (and above) Level 4-6
+
+    * [POLICY-839] - Maintain and implement usability
+
+    * [POLICY-840] - Flexible control loop coordination facility. 
+        - POLICY-951   Code placement and development procedures
+        - POLICY-952   Analyze and design the control loop coordination facility
+        - POLICY-953   Configure whether a given control loop will be regulated by flexible control loop coordination.
+        - POLICY-975   Storage of abatement (and other) events in historical database
+        - POLICY-1109  Add demo code to template.demo
+
+    * [POLICY-841] - Covers the work required to support HPA
+        - POLICY-927   Develop the code that translates HPA requirements into OOF policies
+        - POLICY-989   HPA Use Case Modeling work to support optimization policies
+
+    * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
+        - POLICY-962   Change SO Scale Out REST API call to new REST API version that support config parameters
+        - POLICY-963   Understand and Scope the Guard Policies for Scale Out
+        - POLICY-964   Modify drools-applications template to check is PROV_STATUS=Active before performing a Scale Out
+        - POLICY-968   Enforce guard policy for min/max instances of a VNF
+        - POLICY-1010  Enforce guard policy for waiting a period of time between Scale Outs
+        - POLICY-1011  Modify drools-applications template to make A&AI query to count number of instances of a VNF
+        - POLICY-1037  Use A&AI query for getting number of module instances to construct new module instance name
+        - POLICY-1038  Create new min/max guard policy template in policy engine
+        - POLICY-1039  Ensure Policy Integration Test wiki is up-to-date for new Scale Out APIs
+
+    * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
+        - POLICY-855   Verify APEX-PDP setup in ONAP
+        - POLICY-856   Bring in the model code for APEX-PDP into ONAP
+        - POLICY-857   Bring in the context code for APEX-PDP into ONAP
+        - POLICY-858   Bring in the core code for APEX-PDP into ONAP
+        - POLICY-859   Bring in the server service code for APEX-PDP into ONAP
+        - POLICY-860   Bring in the authoring code for APEX-PDP into ONAP
+        - POLICY-861   Bring in the domain example code for APEX-PDP into ONAP
+        - POLICY-862   Bring in the plugin code for APEX-PDP into ONAP
+        - POLICY-863   Bring in the application code for APEX-PDP into ONAP
+        - POLICY-864   Bring in the client code for APEX-PDP into ONAP
+        - POLICY-865   Set up Integration Tests for APEX in ONAP
+        - POLICY-866   Set up ONAP Policy Framework compliant Docker build for APEX-PDP
+        - POLICY-867   Bring in APEX-PDP documents
+        - POLICY-954   APEX: Missing items and configuration problems
+        - POLICY-1099  Create CSIT test for policy APEX PDP
+
+    * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
+    
+    * [POLICY-904] - This epic covers the features AT&T is submitting
+        - POLICY-900   TOSCA model enhancements
+        - POLICY-901   Guard policy UI enhancements
+        - POLICY-902   XACML platform enhancements
+        - POLICY-983   getConfig naming policy implementation
+        - POLICY-1042  Policy Dashboard Enhancment
+
+    * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
+        - POLICY-1079  Add support for VF Module Delete recipe
+        - POLICY-1086  Configuration/policies for OOF PCI use case
+        - POLICY-1089  Handle recommendation for PCI updates received from PCI-Handler MS
+
+    * [POLICY-1182] - Covers the work to support CCVPN use case
+        - POLICY-1183  Create SDNC actor code
+
+**Bug Fixes**
+
+The following bug fixes have been deployed with this release:
+
+    * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
+    * `[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
+    * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
+    * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
+    * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
+    * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
+    * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
+
+
+**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 (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=36964976>`_.
+
+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 (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=36964976>`_
+
+**Known Issues**
+    * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
+
+
+
+
+..      =======================
+..      * * *   BEIJING   * * *
+..      =======================
+
+Version: 2.0.0
+--------------
+
+:Release Date: 2018-06-07 (Beijing Release)
 
 **New Features**
 
@@ -32,11 +201,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,7 +251,8 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
 
 **Bug Fixes**
 
-    * `[POLICY-454] <https://jira.onap.org/browse/POLICY-454>`_ - brmsgw 1.1.2 policy rules generation in a 1.1.1 docker image
+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
@@ -100,27 +268,48 @@ The Beijing release for POLICY delivered the following Epics. For a full list of
     * `[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
-    * `[POLICY-796] <https://jira.onap.org/browse/POLICY-796>`_ - VirtualControlLoopEvent facts are piling up 
 
 
-**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
+Version: 1.0.2
 --------------
 
 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
 
 **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
 
 
-Version: 1.1.1
+Version: 1.0.1
 --------------
 
 :Release Date: 2017-11-16 (Amsterdam Release)
@@ -202,20 +391,29 @@ The Amsterdam release continued evolving the design driven architecture of and f
 
 .. Links to jira release notes
 
+.. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
 
 
 .. note
 ..      CHANGE  HISTORY
+..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
+..             Changed version number to use ONAP versions.
+..      10/08/2018 - Initial document for Casablanca release.
+..             Per Jorge, POLICY-785 did not get done in Casablanca (removed).  
+..     05/29/2018 - Information for Beijing release.
 ..      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.
+..             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.