Automation adds release-notes.rst
[policy/parent.git] / docs / release-notes.rst
index e392f1f..08dfe29 100644 (file)
@@ -1,4 +1,5 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. _release_notes:
 
 Policy Release Notes
 ====================
@@ -12,6 +13,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 +101,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,17 +111,17 @@ 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`_.
@@ -69,7 +151,6 @@ The El Alto release for POLICY delivered the following Epics. For a full list of
        - 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-1825   Enhance the policy/drools-pdp S3P Stability and Performance tests
        - 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
@@ -116,12 +197,24 @@ The following bug fixes have been deployed with this release:
     * `[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*
@@ -144,6 +237,9 @@ The following known issues will be addressed in a future release:
     * `[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,9 +753,9 @@ The Amsterdam release continued evolving the design driven architecture of and f
     - For vLBS Use Case, the following steps are required to setup the service instance:
                -  Create a Service Instance via VID.
         -  Create a VNF Instance via VID.
-        -  Preload SDNC with topology data used for the actual VNF instantiation (both base and DNS scaling modules). NOTE: you may want to set “vlb_name_0” in the base VF module data to something unique. This is the vLB server name that DCAE will pass to Policy during closed loop. If the same name is used multiple times, the Policy name-query to AAI will show multiple entries, one for each occurrence of that vLB VM name in the OpenStack zone. Note that this is not a limitation, typically server names in a domain are supposed to be unique.
-        -  Instantiate the base VF module (vLB, vPacketGen, and one vDNS) via VID. NOTE: The name of the VF module MUST start with ``Vfmodule_``. The same name MUST appear in the SDNC preload of the base VF module topology. Well relax this naming requirement for Beijing Release.
-        -  Run heatbridge from the Robot VM using ``Vfmodule_``  as stack name (it is the actual stack name in OpenStack)
+        -  Preload SDNC with topology data used for the actual VNF instantiation (both base and DNS scaling modules). NOTE: you may want to set "vlb_name_0" in the base VF module data to something unique. This is the vLB server name that DCAE will pass to Policy during closed loop. If the same name is used multiple times, the Policy name-query to AAI will show multiple entries, one for each occurrence of that vLB VM name in the OpenStack zone. Note that this is not a limitation, typically server names in a domain are supposed to be unique.
+        -  Instantiate the base VF module (vLB, vPacketGen, and one vDNS) via VID. NOTE: The name of the VF module MUST start with ``Vfmodule_``. The same name MUST appear in the SDNC preload of the base VF module topology. We'll relax this naming requirement for Beijing Release.
+        -  Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
         -  Populate AAI with a dummy VF module for vDNS scaling.
 
 **Security Issues**