Release notes structure
[policy/parent.git] / docs / release-notes.rst
index a3f2336..8d4e958 100644 (file)
@@ -12,6 +12,87 @@ Policy Release Notes
 ..      * one section describing the purpose of this new release.
 ..      * This note must be removed after content has been added.
 
+..      ===========================
+..      * * *    FRANKFURT    * * *
+..      ===========================
+
+Abstract
+========
+
+This document provides the release notes for the Frankfurt release.
+
+Summary
+=======
+
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Policy Project**                   |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - policy-api 2.2.0                   |
+|                                      | - policy-pap 2.2.0                   |
+|                                      | - policy-drools-pdp 1.6.0            |
+|                                      | - policy-xacml-pdp 2.2.0             |
+|                                      | - policy-apex-pdp 2.3.0              |
+|                                      | - policy-distribution 2.3.0          |
+|                                      | - policy-pe 1.6.1                    |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 6.0.0 frankfurt                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020-05-07 (TBD)                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+New features
+------------
+
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+
+Workarounds
+-----------
+
+
+Security Notes
+--------------
+
+
+References
+==========
+
+For more information on the ONAP Frankfurt 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`_
+
 ..      ==========================
 ..      * * *     EL ALTO    * * *
 ..      ==========================
@@ -19,7 +100,7 @@ Policy Release Notes
 Version: 5.0.1
 --------------
 
-:Release Date: 2019-09-30 (El Alto Release)
+:Release Date: 2019-10-24 (El Alto Release)
 
 **New Features**
 
@@ -29,74 +110,110 @@ Artifacts released:
    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
    :widths: 15,10,10
 
-   "policy/parent", "3.0.0", ""
-   "policy/common", "1.5.0", ""
-   "policy/models", "2.1.2", ""
-   "policy/api", "2.1.1", "onap/policy-api:2.1.1"
-   "policy/pap", "2.1.1", "onap/policy-pap:2.1.1"
-   "policy/drools-pdp", "1.5.1", "onap/policy-drools:1.5.1"
+   "policy/parent", "3.0.1", ""
+   "policy/common", "1.5.2", ""
+   "policy/models", "2.1.4", ""
+   "policy/api", "2.1.2", "onap/policy-api:2.1.2"
+   "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
+   "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
-   "policy/xacml-pdp", "2.1.1", "onap/policy-xacml-pdp:2.1.1"
-   "policy/drools-applications", "1.5.1", "onap/policy-pdpd-cl:1.5.1"
-   "policy/engine", "1.5.1", "onap/policy-pe:1.5.1"
-   "policy/distribution", "2.2.0", "onap/policy-distribution:2.2.0"
+   "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
+   "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
+   "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
+   "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
 
 The El Alto release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the El Alto release, refer to `JiraPolicyElAlto`_.
 
     * [POLICY-1727] - This epic covers technical debt left over from Dublin
        - POLICY-969    Docker improvement in policy framwork modules
+       - POLICY-1074   Fix checkstyle warnings in every repository
        - POLICY-1121   RPM build for Apex
        - POLICY-1223   CII Silver Badging Requirements
-       - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
+       - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
        - POLICY-1646   Replace uses of getCanonicalName() with getName()
-       - POLICY-1653   Remove isNullVersion() method
+       - POLICY-1652   Move PapRestServer to policy/common
        - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
        - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
        - POLICY-1742   Make HTTP return code handling configurable in APEX
+       - POLICY-1743   Make URL configurable in REST Requestor and REST Client
        - POLICY-1744   Remove topic.properties and incorporate into overall properties
        - POLICY-1770   PAP REST API for PDPGroup Healthcheck
        - POLICY-1771   Boost policy/api JUnit code coverage
+       - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
        - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
        - POLICY-1784   Better Handling of "version" field value with clients
        - POLICY-1785   Deploy same policy with a new version simply adds to the list
+       - POLICY-1786   Create a simple way to populate the guard database for testing
        - POLICY-1791   Address Sonar issues in new policy repos
        - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs. 
        - POLICY-1800   API|PAP components use different version formats
        - POLICY-1805   Build up stability test for api component to follow S3P requirements
        - POLICY-1806   Build up S3P performance test for api component
-       - POLICY-1826   Move the dmaap and pdp simulator to policy/common
+       - POLICY-1847   Add control loop coordination as a preloaded policy type
+       - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
+       - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
        - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
+       - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
+       - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
+       - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
+
+    * Additional items delivered with the release.
+       - POLICY-1637   Remove "version" from PdpGroup
+       - POLICY-1653   Remove isNullVersion() method
+       - POLICY-1966   Fix more sonar issues in policy drools
+       - POLICY-1988   Generate El Alto AAF Certificates
 
     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
        - POLICY-1762   Create CDS API model implementation
+       - POLICY-1763   Create CDS Actor
+       - POLICY-1899   Update optimization xacml application to support more flexible Decision API
+       - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
+
 
 **Bug Fixes**
 
 The following bug fixes have been deployed with this release:
 
-       - POLICY-1793   API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
-       - POLICY-1801   Deploy/undeploy via integer version fails
-       - POLICY-1802   Apex-pdp: context album is mandatory for policy model to compile
-       - POLICY-1803   PAP should undeploy policies when subgroup is deleted
-       - POLICY-1808   API|PAP|PDP-X [new] should publish docker images with the following tag X.Y-SNAPSHOT-latest 
-       - POLICY-1809   In the return of GET call to retrieve the >1 version of guard policy, "version" field is always "1.0.0" 
-       - POLICY-1818   APEX does not allow arbitrary Kafka parameters to be specified
-       - POLICY-1830   Policy throws error parsing its Publish on APPC-CL topic
-       - POLICY-1838   Drools-pdp error log is missing data in ErrorDescription field
-       - POLICY-1839   Policy Model  currently needs to be escaped
-       - POLICY-1842   Fix documentation links
-       - POLICY-1843   Decision API not returning monitoring policies when calling api with policy-type
-       - POLICY-1844   XACML PDP does not update policy statistics
-       - POLICY-1859   Drools rules should not timeout when given timeout=0 - should be treated as infinite
-       - POLICY-1872   brmsgw fails building a jar - trafficgenerator dependency does not exist
-       - POLICY-1876   ONAP-PAP-REST JUnit fail on Centos
-       - POLICY-1879   ApexPDP - Build/Test fails in Nordix - InetAddress.getLocalHost() fails
+    * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
+    * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
+    * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
+    * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs. 
+    * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
+    * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
+    * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
+    * `[POLICY-1807] <https://jira.onap.org/browse/POLICY-1807>`_ - Latest version is always returned when using the endpoint to retrieve all versions of a particular policy 
+    * `[POLICY-1808] <https://jira.onap.org/browse/POLICY-1808>`_ - API|PAP|PDP-X [new] should publish docker images with the following tag X.Y-SNAPSHOT-latest 
+    * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
+    * `[POLICY-1811] <https://jira.onap.org/browse/POLICY-1811>`_ - The endpoint of retrieving the latest version of TOSCA policy does not return the latest one, especially when there are double-digit versions
+    * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
+    * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
+    * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
+    * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
+    * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
+    * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
+    * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
+    * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
+    * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
+    * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
+    * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
+
 
 **Security Notes**
 
 *Fixed Security Issues*
 
+
+    * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final 
+    * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
+    * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
+    * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
+    * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
+    * `[POLICY-2000] <https://jira.onap.org/browse/POLICY-2000>`_ - Upgrade oparent 2.1.0-SNAPSHOT - to pull in jetty server to 9.4.20.v20190813
+    * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
+    * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
+    * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
+
 *Known Security Issues*
 
 *Known Vulnerabilities in Used Modules*
@@ -112,10 +229,16 @@ Quick Links:
 
 The following known issues will be addressed in a future release:
 
-POLICY-1276    JRuby interpreter shutdown fails on second and subsequent runs
-POLICY-1291    Maven Error when building Apex documentation in Windows
-POLICY-1725    XACML PDP returns 500 vs 400 for bad syntax JSON
-POLICY-1832    API|PAP: data race condition seem to appear sometimes when creating and deploying policy
+    * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
+    * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
+    * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
+    * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
+    * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
+    * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
+    * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
+    * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
+    * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
+    * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
 
 
 ..      ==========================
@@ -657,12 +780,12 @@ The Amsterdam release continued evolving the design driven architecture of and f
 
 .. note
 ..      CHANGE  HISTORY
+..     09/19/2019 - Updated for El Alto Release.
 ..     05/16/2019 - Updated for Dublin Release.
 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
 ..      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.
 ..      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)