Automation adds release-notes.rst
[policy/parent.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. _release_notes:
3
4 Policy Release Notes
5 ====================
6
7 .. note
8 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
9 ..      * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes.
10 ..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
11 ..      * this Release Notes.
12 ..      * Except the date and the version number, all the other sections are optional but there must be at least
13 ..      * one section describing the purpose of this new release.
14 ..      * This note must be removed after content has been added.
15
16 ..      ===========================
17 ..      * * *    FRANKFURT    * * *
18 ..      ===========================
19
20 Abstract
21 ========
22
23 This document provides the release notes for the Frankfurt release.
24
25 Summary
26 =======
27
28
29 Release Data
30 ============
31
32 +--------------------------------------+--------------------------------------+
33 | **Policy Project**                   |                                      |
34 |                                      |                                      |
35 +--------------------------------------+--------------------------------------+
36 | **Docker images**                    | - policy-api 2.2.0                   |
37 |                                      | - policy-pap 2.2.0                   |
38 |                                      | - policy-drools-pdp 1.6.0            |
39 |                                      | - policy-xacml-pdp 2.2.0             |
40 |                                      | - policy-apex-pdp 2.3.0              |
41 |                                      | - policy-distribution 2.3.0          |
42 |                                      | - policy-pe 1.6.1                    |
43 |                                      |                                      |
44 +--------------------------------------+--------------------------------------+
45 | **Release designation**              | 6.0.0 frankfurt                      |
46 |                                      |                                      |
47 +--------------------------------------+--------------------------------------+
48 | **Release date**                     | 2020-05-07 (TBD)                     |
49 |                                      |                                      |
50 +--------------------------------------+--------------------------------------+
51
52
53 New features
54 ------------
55
56
57
58 Known Limitations, Issues and Workarounds
59 =========================================
60
61 System Limitations
62 ------------------
63
64
65 Known Vulnerabilities
66 ---------------------
67
68
69 Workarounds
70 -----------
71
72
73 Security Notes
74 --------------
75
76
77 References
78 ==========
79
80 For more information on the ONAP Frankfurt release, please see:
81
82 #. `ONAP Home Page`_
83 #. `ONAP Documentation`_
84 #. `ONAP Release Downloads`_
85 #. `ONAP Wiki Page`_
86
87
88 .. _`ONAP Home Page`: https://www.onap.org
89 .. _`ONAP Wiki Page`: https://wiki.onap.org
90 .. _`ONAP Documentation`: https://docs.onap.org
91 .. _`ONAP Release Downloads`: https://git.onap.org
92
93 Quick Links:
94     - `POLICY project page`_
95     - `Passing Badge information for POLICY`_
96
97 ..      ==========================
98 ..      * * *     EL ALTO    * * *
99 ..      ==========================
100
101 Version: 5.0.1
102 --------------
103
104 :Release Date: 2019-10-24 (El Alto Release)
105
106 **New Features**
107
108 Artifacts released:
109
110 .. csv-table::
111    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
112    :widths: 15,10,10
113
114    "policy/parent", "3.0.1", ""
115    "policy/common", "1.5.2", ""
116    "policy/models", "2.1.4", ""
117    "policy/api", "2.1.2", "onap/policy-api:2.1.2"
118    "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
119    "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
120    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
121    "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
122    "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
123    "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
124    "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
125    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
126
127 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`_.
128
129     * [POLICY-1727] - This epic covers technical debt left over from Dublin
130         - POLICY-969    Docker improvement in policy framwork modules
131         - POLICY-1074   Fix checkstyle warnings in every repository
132         - POLICY-1121   RPM build for Apex
133         - POLICY-1223   CII Silver Badging Requirements
134         - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
135         - POLICY-1646   Replace uses of getCanonicalName() with getName()
136         - POLICY-1652   Move PapRestServer to policy/common
137         - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
138         - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
139         - POLICY-1742   Make HTTP return code handling configurable in APEX
140         - POLICY-1743   Make URL configurable in REST Requestor and REST Client
141         - POLICY-1744   Remove topic.properties and incorporate into overall properties
142         - POLICY-1770   PAP REST API for PDPGroup Healthcheck
143         - POLICY-1771   Boost policy/api JUnit code coverage
144         - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
145         - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
146         - POLICY-1784   Better Handling of "version" field value with clients
147         - POLICY-1785   Deploy same policy with a new version simply adds to the list
148         - POLICY-1786   Create a simple way to populate the guard database for testing
149         - POLICY-1791   Address Sonar issues in new policy repos
150         - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs. 
151         - POLICY-1800   API|PAP components use different version formats
152         - POLICY-1805   Build up stability test for api component to follow S3P requirements
153         - POLICY-1806   Build up S3P performance test for api component
154         - POLICY-1847   Add control loop coordination as a preloaded policy type
155         - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
156         - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
157         - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
158         - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
159         - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
160         - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
161
162     * Additional items delivered with the release.
163         - POLICY-1637   Remove "version" from PdpGroup
164         - POLICY-1653   Remove isNullVersion() method
165         - POLICY-1966   Fix more sonar issues in policy drools
166         - POLICY-1988   Generate El Alto AAF Certificates
167
168     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
169         - POLICY-1762   Create CDS API model implementation
170         - POLICY-1763   Create CDS Actor
171         - POLICY-1899   Update optimization xacml application to support more flexible Decision API
172         - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
173
174
175 **Bug Fixes**
176
177 The following bug fixes have been deployed with this release:
178
179     * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
180     * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
181     * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
182     * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs. 
183     * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
184     * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
185     * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
186     * `[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 
187     * `[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 
188     * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
189     * `[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
190     * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
191     * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
192     * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
193     * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
194     * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
195     * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
196     * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
197     * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
198     * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
199     * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
200     * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
201
202
203 **Security Notes**
204
205 *Fixed Security Issues*
206
207
208     * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final 
209     * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
210     * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
211     * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
212     * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
213     * `[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
214     * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
215     * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
216     * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
217
218 *Known Security Issues*
219
220 *Known Vulnerabilities in Used Modules*
221
222 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 (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_.
223
224 Quick Links:
225     - `POLICY project page`_
226     - `Passing Badge information for POLICY`_
227     - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
228
229 **Known Issues**
230
231 The following known issues will be addressed in a future release:
232
233     * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
234     * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
235     * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
236     * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
237     * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
238     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
239     * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
240     * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
241     * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
242     * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
243
244
245 ..      ==========================
246 ..      * * *      DUBLIN    * * *
247 ..      ==========================
248
249 Version: 4.0.0
250 --------------
251
252 :Release Date: 2019-06-26 (Dublin Release)
253
254 **New Features**
255
256 Artifacts released:
257
258 .. csv-table::
259    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
260    :widths: 15,10,10
261
262    "policy/parent", "2.1.0", ""
263    "policy/common", "1.4.0", ""
264    "policy/models", "2.0.2", ""
265    "policy/api", "2.0.1", "onap/policy-api:2.0.1"
266    "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
267    "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
268    "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
269    "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
270    "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
271    "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
272    "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
273    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
274
275 The Dublin release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Dublin release, refer to `JiraPolicyDublin`_.
276
277     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
278         - POLICY-1195   Separate model code from drools-applications into other repositories
279         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
280         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
281         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
282
283     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
284         - POLICY-1007   Remove Jackson from policy framework components
285         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
286         - POLICY-1250   Fix issues reported by sonar in policy modules
287         - POLICY-1368   Remove hibernate from policy repos
288         - POLICY-1457   Use Alpine in base docker images
289
290     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
291         - S3P Performance related items
292
293     * [POLICY-1171] - Enhance CLC Facility
294         - POLICY-1173   High-level specification of coordination directives
295
296     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
297         - POLICY-1538   Upgrade Elasticsearch to 6.4.x to clear security issue
298
299     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
300         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
301         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
302         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
303         - POLICY-1273   Policy Type Application Design Requirements
304         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
305         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
306         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
307         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
308         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
309         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
310         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
311         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
312         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
313         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
314         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
315         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
316         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
317         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
318         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
319         - POLICY-1456   Policy Architecture and Roadmap Documentation
320         - POLICY-1458   Create S3P JMeter Tests for Policy API
321         - POLICY-1460   Create S3P JMeter Tests for PAP
322         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
323         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
324         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
325         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
326         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
327         - POLICY-1516   Prototype the Policy Decision API
328         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
329         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
330
331     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
332         - Model drive control loop related items
333
334     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
335         - POLICY-1405   Develop SDNC API for trigger bandwidth
336
337     * [POLICY-1408] - This epic covers the work done with the Casablanca release
338         - POLICY-1410   List Policy API
339         - POLICY-1413   Dashboard enhancements
340         - POLICY-1414   Push Policy and DeletePolicy API enhancement
341         - POLICY-1416   Model enhancements to support CLAMP
342         - POLICY-1417   Resiliency improvements
343         - POLICY-1418   PDP APIs - make ClientAuth optional
344         - POLICY-1419   Better multi-role support
345         - POLICY-1420   Model enhancement to support embedded JSON
346         - POLICY-1421   New audit data for push/delete
347         - POLICY-1422   Enhanced encryption
348         - POLICY-1423   Save original model file
349         - POLICY-1427   Controller Logging Feature
350         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
351         - POLICY-1499   Mdc Filter Feature
352
353     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
354         - POLICY-1463   Functional code changes in Policy for OOF SON use case
355         - POLICY-1464   Config related aspects for OOF SON use case
356
357     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
358         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
359         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
360
361     * Additional items delivered with the release.
362         - POLICY-1159   Move expectException to policy-common/utils-test
363         - POLICY-1176   Work on technical debt introduced by CLC POC
364         - POLICY-1266   A&AI Modularity
365         - POLICY-1274   further improvement in PSSD S3P test
366         - POLICY-1401   Build onap.policies.Monitoring TOSCA Policy Template
367         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
368
369
370 **Bug Fixes**
371
372 The following bug fixes have been deployed with this release:
373
374     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
375     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
376     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
377     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
378     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
379
380 **Security Notes**
381
382 *Fixed Security Issues*
383
384     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
385     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
386     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
387     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
388
389 *Known Security Issues*
390
391 *Known Vulnerabilities in Used Modules*
392
393 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 (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_.
394
395 Quick Links:
396     - `POLICY project page`_
397     - `Passing Badge information for POLICY`_
398     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
399
400
401 **Known Issues**
402
403 The following known issues will be addressed in a future release:
404
405     * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs. 
406     * `[POLICY-1810] - <https://jira.onap.org/browse/POLICY-1810>`_ API: ensure that the REST APISs (URLs) are supported and consistent regardless the type of policy: operational, guard, tosca-compliant.
407     * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
408     * `[POLICY-1378] - <https://jira.onap.org/browse/POLICY-1378>`_ add support to append value into policyScope while one policy could be used by several services
409     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
410     * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
411     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
412     * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
413     * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
414     * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
415     * `[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 
416     * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
417     * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
418     * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
419     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
420     * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
421
422
423 ..      ==========================
424 ..      * * *   CASABLANCA   * * *
425 ..      ==========================
426
427 Version: 3.0.2
428 --------------
429
430 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
431
432 The following items were deployed with the Casablanca Maintenance Release:
433
434 **Bug Fixes**
435
436     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
437
438 **Security Fixes**
439
440     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
441
442 **License Issues**
443
444     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
445
446 **Known Issues**
447
448 The following known issue will be addressed in a future release.
449
450     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
451
452 A workaround for this issue consists in bypassing the Portal UI when accessing the Policy UI.   See `PAP recipes <https://docs.onap.org/en/casablanca/submodules/policy/engine.git/docs/platform/cookbook.html?highlight=policy%20cookbook#id23>`_ for the specific procedure.
453
454
455 Version: 3.0.1
456 --------------
457
458 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
459
460 The following items were deployed with the Casablanca Maintenance Release:
461
462 **New Features**
463
464     * [POLICY-1221] - Policy distribution application to support HTTPS communication
465     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
466
467 **Bug Fixes**
468
469     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
470     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
471
472
473 Version: 3.0.0
474 --------------
475
476 :Release Date: 2018-11-30 (Casablanca Release)
477
478 **New Features**
479
480 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).
481
482     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
483
484     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
485
486     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
487     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
488     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
489
490     The policy team did some forward looking spike work towards re-building the Software Architecture.
491
492     * [POLICY-809] - Maintain and implement performance
493     * [POLICY-814] - 72 hour stability testing (component and platform)
494
495     The policy team made enhancements to the Drools PDP to further support S3P Performance.
496     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
497     performance standard and performed 72 hour stability tests.
498
499     * [POLICY-824] - maintain and implement security
500
501     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
502     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
503
504     * [POLICY-840] - Flexible control loop coordination facility.
505
506     Work towards a POC for control loop coordination policies were implemented.
507
508     * [POLICY-841] - Covers the work required to support HPA
509
510     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
511
512     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
513
514     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
515
516     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
517
518     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
519     sonar issues, and checkstyle.
520
521     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
522
523     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
524
525     * [POLICY-1182] - Covers the work to support CCVPN use case
526
527     Policy templates changes were submitted that supported the CCVPN use case.
528
529 **Bug Fixes**
530
531 The following bug fixes have been deployed with this release:
532
533     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
534     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
535     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
536     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
537     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
538     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
539     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
540     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
541
542
543 **Security Notes**
544
545 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=45300864>`_.
546
547 Quick Links:
548     - `POLICY project page`_
549     - `Passing Badge information for POLICY`_
550     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
551
552 **Known Issues**
553
554     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
555     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
556
557
558
559 ..      =======================
560 ..      * * *   BEIJING   * * *
561 ..      =======================
562
563 Version: 2.0.0
564 --------------
565
566 :Release Date: 2018-06-07 (Beijing Release)
567
568 **New Features**
569
570 The Beijing release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Beijing release, refer to `JiraPolicyBeijing`_.
571
572     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
573         - POLICY-238    policy/drools-applications: clean up maven structure
574         - POLICY-336    Address Technical Debt
575         - POLICY-338    Address JUnit Code Coverage
576         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
577         - POLICY-389    Cleanup Jenkin's CI/CD process's
578         - POLICY-449    Policy API + Console : Common Policy Validation
579         - POLICY-568    Integration with org.onap AAF project
580         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
581
582     * [POLICY-391] - This epic covers the work to support Release Planning activities
583         - POLICY-552    ONAP Licensing Scan - Use Restrictions
584
585     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
586         - POLICY-529    Platform Maturity Performance - Drools PDP
587         - POLICY-567    Platform Maturity Performance - PDP-X
588
589     * [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.
590         - POLICY-488    pap should not add rules to official template provided in drools applications
591
592     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
593         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
594
595     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
596         - POLICY-622    Integrate OOF Policy Model into Policy Platform
597
598     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
599         - POLICY-525    Platform Maturity Stability - Drools PDP
600         - POLICY-526    Platform Maturity Stability - XACML PDP
601
602     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
603         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
604         - POLICY-528    Platform Maturity Resiliency - Drools PDP
605         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
606         - POLICY-585    Platform Maturity Resiliency - XACML PDP
607         - POLICY-586    Platform Maturity Resiliency - Planning
608         - POLICY-681    Regression Test Use Cases
609
610     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
611         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
612
613     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
614         - POLICY-531    Platform Maturity Scalability - XACML PDP
615         - POLICY-532    Platform Maturity Scalability - Drools PDP
616         - POLICY-623    Docker image re-design
617
618     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
619         - POLICY-533    Platform Maturity Manageability L1 - Logging
620         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
621
622     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
623         - POLICY-535    Platform Maturity Usability - User Guide
624         - POLICY-536    Platform Maturity Usability - Deployment Documentation
625         - POLICY-537    Platform Maturity Usability - API Documentation
626
627     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
628
629
630 **Bug Fixes**
631
632 The following bug fixes have been deployed with this release:
633
634     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
635     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
636     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
637     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
638     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
639     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
640     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
641     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
642     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
643     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
644     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
645     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
646     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
647     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
648     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
649
650
651 **Security Notes**
652
653 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>`_.
654
655 Quick Links:
656     - `POLICY project page`_
657     - `Passing Badge information for POLICY`_
658     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
659
660 **Known Issues**
661
662 The following known issues will be addressed in a future release:
663
664     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
665     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
666     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
667     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
668     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
669     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
670     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
671     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
672
673
674
675
676 Version: 1.0.2
677 --------------
678
679 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
680
681 **Bug Fixes**
682
683 The following fixes were deployed with the Amsterdam Maintenance Release:
684
685     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
686
687
688 Version: 1.0.1
689 --------------
690
691 :Release Date: 2017-11-16 (Amsterdam Release)
692
693 **New Features**
694
695 The Amsterdam release continued evolving the design driven architecture of and functionality for POLICY.  The following is a list of Epics delivered with the release. For a full list of stories and tasks delivered in the Amsterdam release, refer to `JiraPolicyAmsterdam`_.
696
697     * [POLICY-31] - Stabilization of Seed Code
698         - POLICY-25  Replace any remaining openecomp reference by onap
699         - POLICY-32  JUnit test code coverage
700         - POLICY-66  PDP-D Feature mechanism enhancements
701         - POLICY-67  Rainy Day Decision Policy
702         - POLICY-93  Notification API
703         - POLICY-158  policy/engine: SQL injection Mitigation
704         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
705
706     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
707         - POLICY-40  MSB Integration
708         - POLICY-124  Integration with oparent
709         - POLICY-41  OOM Integration
710         - POLICY-119  PDP-D: noop sinks
711
712     * [POLICY-34] - 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.
713         - POLICY-57  VF-C Actor code development
714         - POLICY-43  Amsterdam Use Case Template
715         - POLICY-173  Deployment of Operational Policies Documentation
716
717     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
718         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
719
720     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
721
722     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
723         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
724         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
725         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
726         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
727
728     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
729
730     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
731         - POLICY-61  vFW Use Case - Runtime
732         - POLICY-62  vDNS Use Case - Runtime
733         - POLICY-59  vCPE Use Case - Runtime
734         - POLICY-60  VOLTE Use Case - Runtime
735         - POLICY-51  Runtime Policy Update Support
736         - POLICY-328  vDNS Use Case - Runtime Testing
737         - POLICY-324  vFW Use Case - Runtime Testing
738         - POLICY-320  VOLTE Use Case - Runtime Testing
739         - POLICY-316  vCPE Use Case - Runtime Testing
740
741     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
742         - POLICY-77  Functional Test case definition for Control Loops
743         - POLICY-387  Deliver the released policy artifacts
744
745
746 **Bug Fixes**
747     - This is technically the first release of POLICY, previous release was the seed code contribution. As such, the defects fixed in this release were raised during the course of the release. Anything not closed is captured below under Known Issues. For a list of defects fixed in the Amsterdam release, refer to `JiraPolicyAmsterdam`_.
748
749
750 **Known Issues**
751     - The operational policy template has been tested with the vFW, vCPE, vDNS and VOLTE use cases.  Additional development may/may not be required for other scenarios.
752
753     - For vLBS Use Case, the following steps are required to setup the service instance:
754         -  Create a Service Instance via VID.
755         -  Create a VNF Instance via VID.
756         -  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.
757         -  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.
758         -  Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
759         -  Populate AAI with a dummy VF module for vDNS scaling.
760
761 **Security Issues**
762     - None at this time
763
764 **Other**
765     - None at this time
766
767
768 .. Links to jira release notes
769
770 .. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
771 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
772 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
773 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
774 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
775
776 .. Links to Project related pages
777
778 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
779 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
780
781
782 .. note
783 ..      CHANGE  HISTORY
784 ..      09/19/2019 - Updated for El Alto Release.
785 ..      05/16/2019 - Updated for Dublin Release.
786 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
787 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
788 ..              Changed version number to use ONAP versions.
789 ..      10/08/2018 - Initial document for Casablanca release.
790 ..      05/29/2018 - Information for Beijing release.
791 ..      03/22/2018 - Initial document for Beijing release.
792 ..      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)
793 ..              Also, Set up initial information for Beijing.
794 ..              Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
795
796
797 End of Release Notes
798
799 .. How to notes for SS
800 ..      For initial document: list epic and user stories for each, list user stories with no epics.
801 ..      For Bugs section, list bugs where Affected Version is a prior release (Casablanca, Beijing etc), Fixed Version is the current release (Dublin), Resolution is done.
802 ..      For Known issues, list bugs that are slotted for a future release.