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