a0fc0ea602fb8457ef896b2397a4030f90a9f1bb
[policy/parent.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
4 .. _release_notes:
5
6 Policy Release Notes
7 ####################
8
9 .. note
10 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
11 ..      * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes.
12 ..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
13 ..      * this Release Notes.
14 ..      * Except the date and the version number, all the other sections are optional but there must be at least
15 ..      * one section describing the purpose of this new release.
16
17 ..      ==========================
18 ..      * * *    HONOLULU    * * *
19 ..      ==========================
20
21 Version: 8.0.1
22 --------------
23
24 :Release Date: 2021-08-12 (Honolulu Maintenance Release #1)
25
26 **Artifacts**
27
28 Artifacts released:
29
30 .. csv-table::
31    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
32    :widths: 15,10,10
33
34    "policy/parent", "3.3.2", ""
35    "policy/common", "1.8.2", ""
36    "policy/models", "2.4.4", ""
37    "policy/api", "2.4.4", "onap/policy-api:2.4.4"
38    "policy/pap", "2.4.5", "onap/policy-pap:2.4.5"
39    "policy/drools-pdp", "1.8.4", "onap/policy-drools:1.8.4"
40    "policy/apex-pdp", "2.5.4", "onap/policy-apex-pdp:2.5.4"
41    "policy/xacml-pdp", "2.4.5", "onap/policy-xacml-pdp:2.4.5"
42    "policy/drools-applications", "1.8.4", "onap/policy-pdpd-cl:1.8.4"
43    "policy/distribution", "2.5.4", "onap/policy-distribution:2.5.4"
44    "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
45
46
47 **Bug Fixes and Necessary Enhancements**
48
49
50     * `[POLICY-3062] <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
51     * `[POLICY-3066] <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
52     * `[POLICY-3078] <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
53     * `[POLICY-3173] <https://jira.onap.org/browse/POLICY-3173>`_ - APEX-PDP incorrectly reports successful policy deployment to PAP
54     * `[POLICY-3202] <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
55     * `[POLICY-3227] <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
56     * `[POLICY-3230] <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
57     * `[POLICY-3248] <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
58     * `[POLICY-3301] <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
59     * `[POLICY-3305] <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
60     * `[POLICY-3331] <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
61     * `[POLICY-3338] <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
62     * `[POLICY-3366] <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
63     * `[POLICY-3450] <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
64     * `[POLICY-3454] <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
65     * `[POLICY-3485] <https://jira.onap.org/browse/POLICY-3485>`_ - Limit statistics record count
66     * `[POLICY-3507] <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
67     * `[POLICY-3516] <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
68
69
70 Known Limitations
71 =================
72
73 The APIs provided by xacml-pdp (e.g., healthcheck, statistics, decision)
74 are always active.  While PAP controls which policies are deployed to a
75 xacml-pdp, it does not control whether or not the APIs are active.
76 In other words, xacml-pdp will respond to decision requests, regardless
77 of whether PAP has made it ACTIVE or PASSIVE.
78
79
80 Version: 8.0.0
81 --------------
82
83 :Release Date: 2021-04-29 (Honolulu Release)
84
85 New features
86 ============
87
88 Artifacts released:
89
90 .. csv-table::
91    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
92    :widths: 15,10,10
93
94    "policy/parent", "3.3.0", ""
95    "policy/common", "1.8.0", ""
96    "policy/models", "2.4.2", ""
97    "policy/api", "2.4.2", "onap/policy-api:2.4.2"
98    "policy/pap", "2.4.2", "onap/policy-pap:2.4.2"
99    "policy/drools-pdp", "1.8.2", "onap/policy-drools:1.8.2"
100    "policy/apex-pdp", "2.5.2", "onap/policy-apex-pdp:2.5.2"
101    "policy/xacml-pdp", "2.4.2", "onap/policy-xacml-pdp:2.4.2"
102    "policy/drools-applications", "1.8.2", "onap/policy-pdpd-cl:1.8.2"
103    "policy/distribution", "2.5.2", "onap/policy-distribution:2.5.2"
104    "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
105
106 Key Updates
107 ===========
108
109 * Enhanced statistics
110    - PDPs provide statistics, retrievable via PAP REST API
111 * PDP deployment status
112    - Policy deployment API enhanced to reflect actual policy deployment status in PDPs
113    - Make PAP component stateless
114 * Policy support
115    - Upgrade XACML 3.0 code to use new Time Extensions
116    - Enhancements for interoperability between Native Policies and other policy types
117    - Support for arbitrary policy types on the Drools PDP
118    - Improve handling of multiple policies in APEX PDP
119    - Update policy-models TOSCA handling with Control Loop Entities
120 * Alternative locking mechanisms
121    - Support NO locking feature in Drools-PDP
122 * Security
123    - Remove credentials in code from the Apex JMS plugin
124 * Actor enhancements
125    - Actors should give better warnings than NPE when data is missing
126    - Remove old event-specific actor code
127 * PDP functional assignments
128    - Make PDP type configurable in drools-pdp
129    - Make PDP type configurable in xacml-pdp
130 * Performance improvements
131    - Support policy updates between PAP and the PDPs, phase 1
132 * Maintainability
133    - Use ONAP base docker image
134    - Remove GPLv3 components from docker containers
135    - Move CSITs to Policy repos
136    - Deprecate server pool feature in drools-pdp
137 * PoCs
138    - Merge CLAMP functionality into Policy Framework project
139    - TOSCA Defined Control Loop
140
141
142 Known Limitations, Issues and Workarounds
143 =========================================
144
145 System Limitations
146 ~~~~~~~~~~~~~~~~~~
147
148 The policy API component requires a fresh new database when migrating to the honolulu release.
149 Therefore, upgrades require a fresh new database installation.
150 Please see the
151 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/honolulu/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
152
153 Known Vulnerabilities
154 ~~~~~~~~~~~~~~~~~~~~~
155
156 Workarounds
157 ~~~~~~~~~~~
158
159 * `POLICY-2998 <https://jira.onap.org/browse/POLICY-2998>`_ - Provide a script to periodically purge the statistics table
160
161 Security Notes
162 ==============
163
164 * `POLICY-3005 <https://jira.onap.org/browse/POLICY-3005>`_ - Bump direct dependency versions
165     - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.12
166     - Upgrade org.eclipse.persistence to 2.7.8
167     - Upgrade org.glassfish.jersey.containers to 2.33
168     - Upgrade com.fasterxml.jackson.module to 2.11.3
169     - Upgrade com.google.re2j to 1.5
170     - Upgrade org.mariadb.jdbc to 2.7.1
171     - Upgrade commons-codec to 1.15
172     - Upgrade com.thoughtworks.xstream to 1.4.15
173     - Upgrade org.apache.httpcomponents:httpclient to 4.5.13
174     - Upgrade org.apache.httpcomponents:httpcore to 4.4.14
175     - Upgrade org.json to 20201115
176     - Upgrade org.projectlombok to 1.18.16
177     - Upgrade org.yaml to 1.27
178     - Upgrade io.cucumber to 6.9.1
179     - Upgrade org.apache.commons:commons-lang3 to 3.11
180     - Upgrade commons-io to 2.8.0
181 * `POLICY-2943 <https://jira.onap.org/browse/POLICY-2943>`_ - Review license scan issues
182     - Upgrade com.hazelcast to 4.1.1
183     - Upgrade io.netty to 4.1.58.Final
184 * `POLICY-2936 <https://jira.onap.org/browse/POLICY-2936>`_ - Upgrade to latest version of CDS API
185     - Upgrade io.grpc to 1.35.0
186     - Upgrade com.google.protobuf to 3.14.0
187
188
189 References
190 ==========
191
192 For more information on the ONAP Honolulu release, please see:
193
194 #. `ONAP Home Page`_
195 #. `ONAP Documentation`_
196 #. `ONAP Release Downloads`_
197 #. `ONAP Wiki Page`_
198
199
200 .. _`ONAP Home Page`: https://www.onap.org
201 .. _`ONAP Wiki Page`: https://wiki.onap.org
202 .. _`ONAP Documentation`: https://docs.onap.org
203 .. _`ONAP Release Downloads`: https://git.onap.org
204
205 Quick Links:
206     - `POLICY project page`_
207     - `Passing Badge information for POLICY`_
208
209
210 ..      ========================
211 ..      * * *    GUILIN    * * *
212 ..      ========================
213
214 Version: 7.0.0
215 --------------
216
217 :Release Date: 2020-12-03 (Guilin Release)
218
219 New features
220 ============
221
222 Artifacts released:
223
224 .. csv-table::
225    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
226    :widths: 15,10,10
227
228    "policy/parent", "3.2.0", ""
229    "policy/common", "1.7.1", ""
230    "policy/models", "2.3.5", ""
231    "policy/api", "2.3.3", "onap/policy-api:2.3.3"
232    "policy/pap", "2.3.3", "onap/policy-pap:2.3.3"
233    "policy/drools-pdp", "1.7.4", "onap/policy-drools:1.7.4"
234    "policy/apex-pdp", "2.4.4", "onap/policy-apex-pdp:2.4.4"
235    "policy/xacml-pdp", "2.3.3", "onap/policy-xacml-pdp:2.3.3"
236    "policy/drools-applications", "1.7.5", "onap/policy-pdpd-cl:1.7.5"
237    "policy/distribution", "2.4.3", "onap/policy-distribution:2.4.3"
238    "policy/docker", "2.1.1", "onap/policy-jdk-alpine:2.1.1, onap/policy-jre-alpine:2.1.1"
239
240 Key Updates
241 ===========
242
243 * Kubernetes integration
244    - All components return with non-zero exit code in case of application failure
245    - All components log to standard out (i.e., k8s logs) by default
246    - Continue to write log files inside individual pods, as well
247 * Multi-tenancy
248    - Basic initial support using the existing features
249 * E2E Network Slicing
250    - Added ModifyNSSI operation to SO actor
251 * Consolidated health check
252    - Indicate failure if there aren’t enough PDPs registered
253 * Legacy operational policies
254    - Removed from all components
255 * OOM helm charts refactoring
256    - Name standardization
257    - Automated certificate generation
258 * Actor Model
259    - Support various use cases and provide more flexibility to Policy Designers
260    - Reintroduced the "usecases" controller into drools-pdp, supporting the use cases
261      under the revised actor architecture
262 * Guard Application
263    - Support policy filtering
264 * Matchable Application
265   - Support for ONAP or 3rd party components to create matchable policy types out of the box
266 * Policy Lifecycle & Administration API
267    - Query/Delete by policy name & version without policy type
268 * Apex-PDP enhancements
269    - Support multiple event & response types coming from a single endpoint
270    - Standalone installation now supports Tosca-based policies
271    - Legacy policy format has been removed
272    - Support chaining/handling of gRPC failure responses
273 * Policy Distribution
274    - HPA decoders & related classes have been removed
275 * Policy Engine
276    - Deprecated
277
278 Known Limitations, Issues and Workarounds
279 =========================================
280
281 System Limitations
282 ~~~~~~~~~~~~~~~~~~
283
284 The policy API component requires a fresh new database when migrating to the guilin release.
285 Therefore, upgrades require a fresh new database installation.
286 Please see the
287 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/guilin/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
288
289 Known Vulnerabilities
290 ~~~~~~~~~~~~~~~~~~~~~
291
292 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
293
294 Workarounds
295 ~~~~~~~~~~~
296 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Use the stringify method of the execution context
297
298 Security Notes
299 ==============
300
301 * `POLICY-2878 <https://jira.onap.org/browse/POLICY-2878>`_ - Dependency upgrades
302     - Upgrade com.fasterxml.jackson to 2.11.1
303 * `POLICY-2387 <https://jira.onap.org/browse/POLICY-2387>`_ - Dependency upgrades
304     - Upgrade org.json to 20200518
305     - Upgrade com.google.re2j to 1.4
306     - Upgrade com.thoughtworks.xstream to 1.4.12
307     - Upgrade org.eclipse.persistence to 2.2.1
308     - Upgrade org.apache.httpcomponents to 4.5.12
309     - Upgrade org.projectlombok to 1.18.12
310     - Upgrade org.slf4j to 1.7.30
311     - Upgrade org.codehaus.plexus to 3.3.0
312     - Upgrade com.h2database to 1.4.200
313     - Upgrade io.cucumber to 6.1.2
314     - Upgrade org.assertj to 3.16.1
315     - Upgrade com.openpojo to 0.8.13
316     - Upgrade org.mockito to 3.3.3
317     - Upgrade org.awaitility to 4.0.3
318     - Upgrade org.onap.aaf.authz to 2.1.21
319 * `POLICY-2668 <https://jira.onap.org/browse/POLICY-2668>`_ - Dependency upgrades
320     - Upgrade org.java-websocket to 1.5.1
321 * `POLICY-2623 <https://jira.onap.org/browse/POLICY-2623>`_ - Remove log4j dependency
322 * `POLICY-1996 <https://jira.onap.org/browse/POLICY-1996>`_ - Dependency upgrades
323     - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.11
324
325
326 References
327 ==========
328
329 For more information on the ONAP Guilin release, please see:
330
331 #. `ONAP Home Page`_
332 #. `ONAP Documentation`_
333 #. `ONAP Release Downloads`_
334 #. `ONAP Wiki Page`_
335
336
337 .. _`ONAP Home Page`: https://www.onap.org
338 .. _`ONAP Wiki Page`: https://wiki.onap.org
339 .. _`ONAP Documentation`: https://docs.onap.org
340 .. _`ONAP Release Downloads`: https://git.onap.org
341
342 Quick Links:
343     - `POLICY project page`_
344     - `Passing Badge information for POLICY`_
345
346
347 ..      ===========================
348 ..      * * *    FRANKFURT    * * *
349 ..      ===========================
350
351
352 Version: 6.0.1
353 --------------
354
355 :Release Date: 2020-08-21 (Frankfurt Maintenance Release #1)
356
357 **Artifacts**
358
359 Artifacts released:
360
361 .. csv-table::
362    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
363    :widths: 15,10,10
364
365    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
366
367
368 **Bug Fixes**
369
370
371     * `[POLICY-2704] <https://jira.onap.org/browse/POLICY-2704>`_ - Legacy PDP-X and PAP stuck in PodIntializing
372
373
374 **Security Notes**
375
376 *Fixed Security Issues*
377
378
379     * `[POLICY-2678] <https://jira.onap.org/browse/POLICY-2678>`_ - policy/engine tomcat upgrade for CVE-2020-11996
380
381
382 Version: 6.0.0
383 --------------
384
385 :Release Date: 2020-06-04 (Frankfurt Release)
386
387 New features
388 ============
389
390 Artifacts released:
391
392 .. csv-table::
393    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
394    :widths: 15,10,10
395
396    "policy/parent", "3.1.3", ""
397    "policy/common", "1.6.5", ""
398    "policy/models", "2.2.6", ""
399    "policy/api", "2.2.4", "onap/policy-api:2.2.4"
400    "policy/pap", "2.2.3", "onap/policy-pap:2.2.3"
401    "policy/drools-pdp", "1.6.3", "onap/policy-drools:1.6.3"
402    "policy/apex-pdp", "2.3.2", "onap/policy-apex-pdp:2.3.2"
403    "policy/xacml-pdp", "2.2.2", "onap/policy-xacml-pdp:2.2.2"
404    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
405    "policy/engine", "1.6.4", "onap/policy-pe:1.6.4"
406    "policy/distribution", "2.3.2", "onap/policy-distribution:2.3.2"
407    "policy/docker", "2.0.1", "onap/policy-jdk-alpine:2.0.1, onap/policy-jre-alpine:2.0.1, onap/policy-jdk-debian:2.0.1, onap/policy-jre-debian:2.0.1"
408
409 Summary
410 =======
411
412 New features include policy update notifications, native policy support, streamlined health check for the Policy Administration Point (PAP),
413 configurable pre-loading/pre-deployment of policies, new APIs (e.g. to create one or more Policies with a single call), new experimental PDP monitoring GUI, and enhancements to all three PDPs: XACML, Drools, APEX.
414
415 Common changes in all policy components
416 =======================================
417
418 * Upgraded all policy components to Java 11.
419 * Logback file can be now loaded using OOM configmap.
420    - If needed, logback file can be loaded as a configmap during the OOM deployment. For this, just put the logback.xml file in corresponding config directory in OOM charts.
421
422 * TOSCA changes:
423    - “tosca_definitions_version” is now “tosca_simple_yaml_1_1_0”
424    - typeVersion→ type_version, int→integer, bool→boolean, String→string, Map→map, List→list
425 * SupportedPolicyTypes now removed from pdp status message.
426    - All PDPs now send PdpGroup to which they belong to in the registration message.
427    - SupportedPolicyTypes are not sent anymore.
428
429 * Native Policy Support
430    - Each PDP engine has its own native policy language. A new Policy Type **onap.policies.Native** was created and supported for each PDP
431      engine to support native policy types.
432
433
434 POLICY-PAP
435 ==========
436
437 * Policy Update Notifications
438    - PAP now generates notifications  via the DMaaP Message Router when policies are successfully or unsuccessfully deployed (or undeployed) from all relevant PDPs.
439
440 * PAP API to fetch Policy deployment status
441    - Clients will be able to poll the PAP API to find out when policies have been successfully or unsuccessfully deployed to the PDP's.
442
443 * Removing supportedPolicyTypes from PdpStatus
444    - PDPs are assigned to a PdpGroup based on what group is mentioned in the heartbeat. Earlier this was done based on the supportedPolicyTypes.
445
446 * Support policy types with wild-cards, Preload wildcard supported type in PAP
447
448 * PAP should NOT make a PDP passive if it cannot deploy a policy.
449    - If a PDP fails to deploy one or more policies specified in a PDP-UPDATE message, PAP will undeploy those policies that failed to deploy to the PDP.  This entails removing the policies from the Pdp Group(s), issuing new PDP-UPDATE requests, and updating the notification tracking data.
450    - Also, re-register pdp if not found in the DB during heartbeat processing.
451
452 * Consolidated health check in PAP
453    - PAP can report the health check for ALL the policy components now. The PDP’s health is tracked based on heartbeats, and other component’s REST API is used for healthcheck.
454    - “healthCheckRestClientParameters” (REST parameters for API and Distribution healthcheck) are added to the startup config file in PAP.
455
456 * PDP statistics from PAP
457    - All PDPs send statistics data as part of the heartbeat. PAP reads this and saves this data to the database, and this statistics data can be accessed from the monitoring GUI.
458
459 * PAP API for Create or Update PdpGroups
460    - A new API is now available just for creating/updating PDP Groups. Policies cannot be added/updated during PDP Group create/update operations. There is another API for this. So, if provided in the create/update group request, they are ignored. Supported policy types are defined during PDP Group creation. They cannot be updated once they are created. Refer to this for details: https://github.com/onap/policy-parent/blob/master/docs/pap/pap.rst#id8
461
462 * PAP API to deploy policies to PdpGroups
463    - A new API is introduced to deploy policies on specific PDPGroups. Each subgroup includes an "action" property, which is used to indicate that the policies are being added (POST) to the subgroup, deleted (DELETE) from the subgroup, or that the subgroup's entire set of policies is being replaced (PATCH) by a new set of policies.
464
465 POLICY-API
466 ==========
467
468 * A new simplified API to create one or more policies in one call.
469    - This simplified API doesn’t require policy type id & policy type version to be part of the URL.
470    - The simple URI “policy/api/v1/policies” with a POST input body takes in a ToscaServiceTemplate with the policies in it.
471
472 * List of Preloaded policy types are made configurable
473    - Until El Alto, the list of pre-loaded policy types are hardcoded in the code. Now, this is made configurable, and the list can be specified in the startup config file for the API component under “preloadPolicyTypes”. The list is ignored if the DB already contains one or more policy types.
474
475 * Preload default policies for ONAP components
476    - The ability to configure the preloading of initial default policies into the system upon startup.
477
478 * A lot of improvements to the API code and validations corresponding to the changes in policy-models.
479    - Creating same policyType/policy repeatedly without any change in request body will always be successful with 200 response
480    - If there is any change in the request body, then that should be a new version. If any change is posted without a version change, then 406 error response is returned.
481
482 * Known versioning issues are there in Policy Types handling.
483    - https://jira.onap.org/browse/POLICY-2377 covers the versioning issues in Policy. Basically, multiple versions of a Policy Type cannot be handled in TOSCA. So, in Frankfurt, the latest version of the policy type is examined. This will be further looked into in Guilin.
484
485 * Cascaded GET of PolicyTypes and Policies
486    - Fetching/GET PolicyType now returns all of the referenced/parent policyTypes and dataTypes as well.
487    - Fetching/GET Policy allows specifying mode now.
488    - By default the mode is “BARE”, which returns only the requested Policy in response. If mode is specified as “REFERENCED”, all of the referenced/parent policyTypes and dataTypes are returned as well.
489
490 * The /deployed API is removed from policy/api
491    - This run time administration job to see the deployment status of a policy is now possible via PAP.
492
493 * Changes related to design and support of TOSCA Compliant Policy Types for the operational and guard policy models.
494
495 POLICY-DISTRIBUTION
496 ===================
497
498 * From Frankfurt release, policy-distribution component uses APIs provided by Policy-API and Policy-PAP for creation of policy types and policies, and deployment of policies.
499    - Note: If “deployPolicies” field in the startup config file is true, then only the policies are deployed using PAP endpoint.
500
501 * Policy/engine & apex-pdp dependencies are removed from policy-distribution.
502
503
504 POLICY-APEX-PDP
505 ===============
506
507 * Changed the JavaScript executor from Nashorn to Rhino as part of Java 11 upgrade.
508    - There are minor changes in the JavaScript task logic files associated with this Rhino migration. An example for this change can be seen here: https://gerrit.onap.org/r/c/policy/apex-pdp/+/103546/2/examples/examples-onap-bbs/src/main/resources/logic/SdncResourceUpdateTask.js
509
510    - There is a known issue in Rhino javascript related to the usage of JSON.stringify. This is captured in this JIRA https://jira.onap.org/browse/POLICY-2463.
511
512 * APEX supports multiple policy deployment in Frankfurt.
513    - Up through El Alto APEX-PDP had the capability to take in only a single ToscaPolicy. When PAP sends a list of Tosca Policies in PdpUpdate, only the first one is taken and only that single Policy is deployed in APEX. This is fixed in Frankfurt. Now, APEX can deploy a list of Tosca Policies altogether into the engine.
514
515    - Note: There shouldn’t be any duplicates in the deployed policies (for e.g. same input/output parameter names, or same event/task names etc).
516
517    - For example, when 3 policies are deployed and one has duplicates, say same input/task or any such concept is used in the 2nd and 3rd policy, then APEX-PDP ignores the 3rd policy and executes only the 1st and 2nd policies. APEX-PDP also respond back to PAP with the message saying that “only Policy 1 and 2 are deployed. Others failed due to duplicate concept”.
518
519 * Context retainment during policy upgrade.
520    - In APEX-PDP, context is referred by the apex concept ‘contextAlbum’. When there is no major version change in the upgraded policy to be deployed, the existing context of the currently running policy is retained. When the upgraded policy starts running, it will have access to this context as well.
521
522    - For example, Policy A v1.1 is currently deployed to APEX. It has a contextAlbum named HeartbeatContext and heartbeats are currently added to the HeartbeatContext based on events coming in to the policy execution. Now, when Policy A v1.2 (with some other changes and same HeartbeatContext) is deployed, Policy Av1.1 is replaced by Policy A1.2 in the APEX engine, but the content in HeartbeatContext is retained for Policy A1.2.
523
524 * APEX-PDP now specifies which PdpGroup it belongs to.
525    - Up through El Alto, PAP assigned each PDP to a PDP group based on the supportedPolicyTypes it sends in the heartbeat. But in Frankfurt, each PDP comes up saying which PdpGroup they belong to, and this is sent to PAP in the heartbeat. PAP then registers the PDP the PdpGroup specified by the PDP. If no group name is specified like this, then PAP assigns the PDP to defaultGroup by default. SupportedPolicyTypes are not sent to PAP by the PDP now.
526
527    - In APEX-PDP, this can be specified in the startup config file(OnapPfConfig.json). "pdpGroup": "<groupName>" is added under “pdpStatusParameters” in the config file.
528
529 * APEX-PDP now sends PdpStatistics data in heartbeat.
530    - Apex now sends the PdpStatistics data in every heartbeat sent to PAP. PAP saves this data to the database, and this statistics data can be accessed from the monitoring GUI.
531
532 * Removed “content” section from ToscaPolicy properties in APEX.
533    - Up through El Alto, APEX specific policy information was placed under properties|content in ToscaPolicy. Avoid placing under "content" and keep the information directly under properties. So, the ToscaPolicy structure will have apex specific policy information in properties|engineServiceParameters, properties|eventInputParameters, properties|eventOutputParameters.
534
535 * Passing parameters from ApexConfig to policy logic.
536    - TaskParameters can be used to pass parameters from ApexConfig to the policy logic. Consider a scenario where from CLAMP, serviceId or closedLoopId has to be passed to the policy, and this should be available to perform some logic or action within the policy. In the CLAMP UI, while configuring the APEX Policy, specifying taskParameters with these will enable this.
537
538    - More information about the usage of Task Parameters can be found here: https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-User-Manual.html#configure-task-parameters
539
540    - In the taskLogic, taskParameters can be accessed as  executor.parameters.get("ParameterKey1"))
541
542    - More information can be found here: https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-Policy-Guide.html#accessing-taskparameters
543
544 * GRPC support for APEX-CDS interaction.
545    - APEX-PDP now supports interaction with CDS over gRPC. Up through El Alto, CDS interaction was possible over REST only. A new plugin was developed in APEX for this feature. Refer the link for more details. https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-User-Manual.html#grpc-io
546
547 POLICY-XACML-PDP
548 ================
549
550 * Added optional Decision API param to Decision API for monitor decisions that returns abbreviated results.
551    - Return only an abbreviated list of policies (e.g. metadata Policy Id and Version) without the actual contents of the policies (e.g. the Properties).
552
553 * XACML PDP now support PASSIVE_MODE.
554 * Added support to return status and error if pdp-x failed to load a policy.
555 * Changed optimization Decision API application to support "closest matches" algorithm.
556 * Changed Xacml-pdp to report the pdp group defined in XacmlPdpParameters config file as part of heartbeat. Also, removed supportedPolicyType from pdpStatus message.
557 * Design the TOSCA policy model for SDNC naming policies and implement an application that translates it to a working policy and is available for decision API.
558 * XACML pdp support for Control Loop Coordination
559    - Added policies for SON and PCI to support each blocking the other, with test cases and appropriate requests
560
561 * Extend PDP-X capabilities so that it can load in and enforce the native XACML policies deployed from PAP.
562
563 POLICY-DROOLS-PDP
564 =================
565
566 * Support for PDP-D in offline mode to support locked deployments.   This is the default ONAP installation.
567 * Parameterize maven repository URLs for easier CI/CD integration.
568 * Support for Tosca Compliant Operational Policies.
569 * Support for TOSCA Compliant Native Policies that allows creation and deployment of new drools-applications.
570 * Validation of Operational and Native Policies against their policy type.
571 * Support for a generic Drools-PDP docker image to host any type of application.
572 * Experimental Server Pool feature that supports multiple active Drools PDP hosts.
573
574 POLICY-DROOLS-APPLICATIONS
575 ==========================
576
577 * Removal of DCAE ONSET alarm duplicates (with different request IDs).
578 * Support of a new controller (frankfurt) that supports the ONAP use cases under the new actor architecture.
579 * Deprecated the "usecases" controller supporting the use cases under the legacy actor architecture.
580 * Deleted the unsupported "amsterdam" controller related projects.
581
582
583 Known Limitations, Issues and Workarounds
584 =========================================
585
586 System Limitations
587 ~~~~~~~~~~~~~~~~~~
588
589 The policy API component requires a fresh new database when migrating to the frankfurt release.
590 Therefore, upgrades require a fresh new database installation.
591 Please see the
592 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
593
594 Known Vulnerabilities
595 ~~~~~~~~~~~~~~~~~~~~~
596
597 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
598 * `POLICY-2487 <https://jira.onap.org/browse/POLICY-2487>`_ - policy/api hangs in loop if preload policy does not exist
599
600 Workarounds
601 ~~~~~~~~~~~
602 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Parse incoming object using JSON.Parse() or cast the object to a String
603
604 Security Notes
605 ==============
606
607 * `POLICY-2221 <https://jira.onap.org/browse/POLICY-2221>`_ - Password removal from helm charts
608 * `POLICY-2064 <https://jira.onap.org/browse/POLICY-2064>`_ - Allow overriding of keystore and truststore in policy helm charts
609 * `POLICY-2381 <https://jira.onap.org/browse/POLICY-2381>`_ - Dependency upgrades
610     - Upgrade drools 7.33.0
611     - Upgrade jquery to 3.4.1 in jquery-ui
612     - Upgrade snakeyaml to 1.26
613     - Upgrade org.infinispan infinispan-core 10.1.5.Final
614     - upgrade io.netty 4.1.48.Final
615     - exclude org.glassfish.jersey.media jersey-media-jaxb artifact
616     - Upgrade com.fasterxml.jackson.core 2.10.0.pr3
617     - Upgrade org.org.jgroups 4.1.5.Final
618     - Upgrade commons-codec 20041127.091804
619     - Upgrade com.github.ben-manes.caffeine 2.8.0
620
621 ..      ==========================
622 ..      * * *     EL ALTO    * * *
623 ..      ==========================
624
625 Version: 5.0.2
626 --------------
627
628 :Release Date: 2020-08-24 (El Alto Maintenance Release #1)
629
630 **New Features**
631
632 Artifacts released:
633
634 .. csv-table::
635    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
636    :widths: 15,10,10
637
638    "policy/api", "2.1.3", "onap/policy-api:2.1.3"
639    "policy/pap", "2.1.3", "onap/policy-pap:2.1.3"
640    "policy/drools-pdp", "1.5.3", "onap/policy-drools:1.5.3"
641    "policy/apex-pdp", "2.2.3", "onap/policy-apex-pdp:2.2.3"
642    "policy/xacml-pdp", "2.1.3", "onap/policy-xacml-pdp:2.1.3"
643    "policy/drools-applications", "1.5.4", "onap/policy-pdpd-cl:1.5.4"
644    "policy/engine", "1.5.3", "onap/policy-pe:1.5.3"
645    "policy/distribution", "2.2.2", "onap/policy-distribution:2.2.2"
646    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0, onap/policy/base-alpine:1.4.0"
647
648
649 **Bug Fixes**
650
651
652     * `[PORTAL-760]  <https://jira.onap.org/browse/PORTAL-760>`_  - Access to Policy portal is impossible
653     * `[POLICY-2107] <https://jira.onap.org/browse/POLICY-2107>`_ - policy/distribution license issue in resource needs to be removed
654     * `[POLICY-2169] <https://jira.onap.org/browse/POLICY-2169>`_ - SDC client interface change caused compile error in policy distribution
655     * `[POLICY-2171] <https://jira.onap.org/browse/POLICY-2171>`_ - Upgrade elalto branch models and drools-applications
656     * `[POLICY-1509] <https://jira.onap.org/browse/POLICY-1509>`_ - Investigate Apex org.python.jython-standalone.2.7.1
657     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
658
659
660 **Security Notes**
661
662 *Fixed Security Issues*
663
664
665     * `[POLICY-2475] <https://jira.onap.org/browse/POLICY-2475>`_ - Update El Alto component certificates
666
667 Version: 5.0.1
668 --------------
669
670 :Release Date: 2019-10-24 (El Alto Release)
671
672 **New Features**
673
674 Artifacts released:
675
676 .. csv-table::
677    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
678    :widths: 15,10,10
679
680    "policy/parent", "3.0.1", ""
681    "policy/common", "1.5.2", ""
682    "policy/models", "2.1.4", ""
683    "policy/api", "2.1.2", "onap/policy-api:2.1.2"
684    "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
685    "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
686    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
687    "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
688    "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
689    "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
690    "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
691    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
692
693 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`_.
694
695     * [POLICY-1727] - This epic covers technical debt left over from Dublin
696
697     - POLICY-969    Docker improvement in policy framwork modules
698     - POLICY-1074   Fix checkstyle warnings in every repository
699     - POLICY-1121   RPM build for Apex
700     - POLICY-1223   CII Silver Badging Requirements
701     - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
702     - POLICY-1646   Replace uses of getCanonicalName() with getName()
703     - POLICY-1652   Move PapRestServer to policy/common
704     - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
705     - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
706     - POLICY-1742   Make HTTP return code handling configurable in APEX
707     - POLICY-1743   Make URL configurable in REST Requestor and REST Client
708     - POLICY-1744   Remove topic.properties and incorporate into overall properties
709     - POLICY-1770   PAP REST API for PDPGroup Healthcheck
710     - POLICY-1771   Boost policy/api JUnit code coverage
711     - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
712     - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
713     - POLICY-1784   Better Handling of "version" field value with clients
714     - POLICY-1785   Deploy same policy with a new version simply adds to the list
715     - POLICY-1786   Create a simple way to populate the guard database for testing
716     - POLICY-1791   Address Sonar issues in new policy repos
717     - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
718     - POLICY-1800   API|PAP components use different version formats
719     - POLICY-1805   Build up stability test for api component to follow S3P requirements
720     - POLICY-1806   Build up S3P performance test for api component
721     - POLICY-1847   Add control loop coordination as a preloaded policy type
722     - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
723     - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
724     - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
725     - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
726     - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
727     - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
728
729     * Additional items delivered with the release.
730
731     - POLICY-1637   Remove "version" from PdpGroup
732     - POLICY-1653   Remove isNullVersion() method
733     - POLICY-1966   Fix more sonar issues in policy drools
734     - POLICY-1988   Generate El Alto AAF Certificates
735
736     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
737
738     - POLICY-1762   Create CDS API model implementation
739     - POLICY-1763   Create CDS Actor
740     - POLICY-1899   Update optimization xacml application to support more flexible Decision API
741     - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
742
743
744 **Bug Fixes**
745
746 The following bug fixes have been deployed with this release:
747
748     * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
749     * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
750     * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
751     * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
752     * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
753     * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
754     * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
755     * `[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
756     * `[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
757     * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
758     * `[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
759     * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
760     * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
761     * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
762     * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
763     * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
764     * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
765     * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
766     * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
767     * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
768     * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
769     * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
770
771
772 **Security Notes**
773
774 *Fixed Security Issues*
775
776
777     * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final
778     * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
779     * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
780     * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
781     * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
782     * `[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
783     * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
784     * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
785     * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
786
787 *Known Security Issues*
788
789 *Known Vulnerabilities in Used Modules*
790
791 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>`_.
792
793 Quick Links:
794     - `POLICY project page`_
795     - `Passing Badge information for POLICY`_
796     - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
797
798 **Known Issues**
799
800 The following known issues will be addressed in a future release:
801
802     * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
803     * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
804     * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
805     * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
806     * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
807     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
808     * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
809     * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
810     * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
811     * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
812
813
814 ..      ==========================
815 ..      * * *      DUBLIN    * * *
816 ..      ==========================
817
818 Version: 4.0.0
819 --------------
820
821 :Release Date: 2019-06-26 (Dublin Release)
822
823 **New Features**
824
825 Artifacts released:
826
827 .. csv-table::
828    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
829    :widths: 15,10,10
830
831    "policy/parent", "2.1.0", ""
832    "policy/common", "1.4.0", ""
833    "policy/models", "2.0.2", ""
834    "policy/api", "2.0.1", "onap/policy-api:2.0.1"
835    "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
836    "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
837    "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
838    "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
839    "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
840    "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
841    "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
842    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
843
844 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`_.
845
846     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
847         - POLICY-1195   Separate model code from drools-applications into other repositories
848         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
849         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
850         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
851
852     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
853         - POLICY-1007   Remove Jackson from policy framework components
854         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
855         - POLICY-1250   Fix issues reported by sonar in policy modules
856         - POLICY-1368   Remove hibernate from policy repos
857         - POLICY-1457   Use Alpine in base docker images
858
859     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
860         - S3P Performance related items
861
862     * [POLICY-1171] - Enhance CLC Facility
863         - POLICY-1173   High-level specification of coordination directives
864
865     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
866         - POLICY-1538   Upgrade Elasticsearch to 6.4.x to clear security issue
867
868     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
869         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
870         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
871         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
872         - POLICY-1273   Policy Type Application Design Requirements
873         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
874         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
875         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
876         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
877         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
878         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
879         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
880         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
881         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
882         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
883         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
884         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
885         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
886         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
887         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
888         - POLICY-1456   Policy Architecture and Roadmap Documentation
889         - POLICY-1458   Create S3P JMeter Tests for Policy API
890         - POLICY-1460   Create S3P JMeter Tests for PAP
891         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
892         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
893         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
894         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
895         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
896         - POLICY-1516   Prototype the Policy Decision API
897         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
898         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
899
900     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
901         - Model drive control loop related items
902
903     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
904         - POLICY-1405   Develop SDNC API for trigger bandwidth
905
906     * [POLICY-1408] - This epic covers the work done with the Casablanca release
907         - POLICY-1410   List Policy API
908         - POLICY-1413   Dashboard enhancements
909         - POLICY-1414   Push Policy and DeletePolicy API enhancement
910         - POLICY-1416   Model enhancements to support CLAMP
911         - POLICY-1417   Resiliency improvements
912         - POLICY-1418   PDP APIs - make ClientAuth optional
913         - POLICY-1419   Better multi-role support
914         - POLICY-1420   Model enhancement to support embedded JSON
915         - POLICY-1421   New audit data for push/delete
916         - POLICY-1422   Enhanced encryption
917         - POLICY-1423   Save original model file
918         - POLICY-1427   Controller Logging Feature
919         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
920         - POLICY-1499   Mdc Filter Feature
921
922     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
923         - POLICY-1463   Functional code changes in Policy for OOF SON use case
924         - POLICY-1464   Config related aspects for OOF SON use case
925
926     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
927         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
928         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
929
930     * Additional items delivered with the release.
931         - POLICY-1159   Move expectException to policy-common/utils-test
932         - POLICY-1176   Work on technical debt introduced by CLC POC
933         - POLICY-1266   A&AI Modularity
934         - POLICY-1274   further improvement in PSSD S3P test
935         - POLICY-1401   Build onap.policies.Monitoring TOSCA Policy Template
936         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
937
938
939 **Bug Fixes**
940
941 The following bug fixes have been deployed with this release:
942
943     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
944     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
945     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
946     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
947     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
948
949 **Security Notes**
950
951 *Fixed Security Issues*
952
953     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
954     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
955     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
956     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
957
958 *Known Security Issues*
959
960 *Known Vulnerabilities in Used Modules*
961
962 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>`_.
963
964 Quick Links:
965     - `POLICY project page`_
966     - `Passing Badge information for POLICY`_
967     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
968
969
970 **Known Issues**
971
972 The following known issues will be addressed in a future release:
973
974     * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
975     * `[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.
976     * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
977     * `[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
978     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
979     * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
980     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
981     * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
982     * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
983     * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
984     * `[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
985     * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
986     * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
987     * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
988     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
989     * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
990
991
992 ..      ==========================
993 ..      * * *   CASABLANCA   * * *
994 ..      ==========================
995
996 Version: 3.0.2
997 --------------
998
999 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
1000
1001 The following items were deployed with the Casablanca Maintenance Release:
1002
1003 **Bug Fixes**
1004
1005     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
1006
1007 **Security Fixes**
1008
1009     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
1010
1011 **License Issues**
1012
1013     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
1014
1015 **Known Issues**
1016
1017 The following known issue will be addressed in a future release.
1018
1019     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
1020
1021 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.
1022
1023
1024 Version: 3.0.1
1025 --------------
1026
1027 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
1028
1029 The following items were deployed with the Casablanca Maintenance Release:
1030
1031 **New Features**
1032
1033     * [POLICY-1221] - Policy distribution application to support HTTPS communication
1034     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
1035
1036 **Bug Fixes**
1037
1038     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
1039     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
1040
1041
1042 Version: 3.0.0
1043 --------------
1044
1045 :Release Date: 2018-11-30 (Casablanca Release)
1046
1047 **New Features**
1048
1049 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).
1050
1051     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
1052
1053     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
1054
1055     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
1056     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
1057     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
1058
1059     The policy team did some forward looking spike work towards re-building the Software Architecture.
1060
1061     * [POLICY-809] - Maintain and implement performance
1062     * [POLICY-814] - 72 hour stability testing (component and platform)
1063
1064     The policy team made enhancements to the Drools PDP to further support S3P Performance.
1065     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
1066     performance standard and performed 72 hour stability tests.
1067
1068     * [POLICY-824] - maintain and implement security
1069
1070     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
1071     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
1072
1073     * [POLICY-840] - Flexible control loop coordination facility.
1074
1075     Work towards a POC for control loop coordination policies were implemented.
1076
1077     * [POLICY-841] - Covers the work required to support HPA
1078
1079     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
1080
1081     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
1082
1083     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
1084
1085     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
1086
1087     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
1088     sonar issues, and checkstyle.
1089
1090     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
1091
1092     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
1093
1094     * [POLICY-1182] - Covers the work to support CCVPN use case
1095
1096     Policy templates changes were submitted that supported the CCVPN use case.
1097
1098 **Bug Fixes**
1099
1100 The following bug fixes have been deployed with this release:
1101
1102     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1103     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1104     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
1105     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
1106     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
1107     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
1108     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
1109     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
1110
1111
1112 **Security Notes**
1113
1114 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>`_.
1115
1116 Quick Links:
1117     - `POLICY project page`_
1118     - `Passing Badge information for POLICY`_
1119     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
1120
1121 **Known Issues**
1122
1123     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
1124     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
1125
1126
1127
1128 ..      =======================
1129 ..      * * *   BEIJING   * * *
1130 ..      =======================
1131
1132 Version: 2.0.0
1133 --------------
1134
1135 :Release Date: 2018-06-07 (Beijing Release)
1136
1137 **New Features**
1138
1139 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`_.
1140
1141     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
1142         - POLICY-238    policy/drools-applications: clean up maven structure
1143         - POLICY-336    Address Technical Debt
1144         - POLICY-338    Address JUnit Code Coverage
1145         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
1146         - POLICY-389    Cleanup Jenkin's CI/CD process's
1147         - POLICY-449    Policy API + Console : Common Policy Validation
1148         - POLICY-568    Integration with org.onap AAF project
1149         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
1150
1151     * [POLICY-391] - This epic covers the work to support Release Planning activities
1152         - POLICY-552    ONAP Licensing Scan - Use Restrictions
1153
1154     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
1155         - POLICY-529    Platform Maturity Performance - Drools PDP
1156         - POLICY-567    Platform Maturity Performance - PDP-X
1157
1158     * [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.
1159         - POLICY-488    pap should not add rules to official template provided in drools applications
1160
1161     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
1162         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
1163
1164     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
1165         - POLICY-622    Integrate OOF Policy Model into Policy Platform
1166
1167     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
1168         - POLICY-525    Platform Maturity Stability - Drools PDP
1169         - POLICY-526    Platform Maturity Stability - XACML PDP
1170
1171     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
1172         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
1173         - POLICY-528    Platform Maturity Resiliency - Drools PDP
1174         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
1175         - POLICY-585    Platform Maturity Resiliency - XACML PDP
1176         - POLICY-586    Platform Maturity Resiliency - Planning
1177         - POLICY-681    Regression Test Use Cases
1178
1179     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
1180         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
1181
1182     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
1183         - POLICY-531    Platform Maturity Scalability - XACML PDP
1184         - POLICY-532    Platform Maturity Scalability - Drools PDP
1185         - POLICY-623    Docker image re-design
1186
1187     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
1188         - POLICY-533    Platform Maturity Manageability L1 - Logging
1189         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
1190
1191     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
1192         - POLICY-535    Platform Maturity Usability - User Guide
1193         - POLICY-536    Platform Maturity Usability - Deployment Documentation
1194         - POLICY-537    Platform Maturity Usability - API Documentation
1195
1196     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
1197
1198
1199 **Bug Fixes**
1200
1201 The following bug fixes have been deployed with this release:
1202
1203     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
1204     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
1205     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
1206     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
1207     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
1208     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
1209     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
1210     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
1211     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
1212     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
1213     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
1214     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
1215     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
1216     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
1217     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
1218
1219
1220 **Security Notes**
1221
1222 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>`_.
1223
1224 Quick Links:
1225     - `POLICY project page`_
1226     - `Passing Badge information for POLICY`_
1227     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
1228
1229 **Known Issues**
1230
1231 The following known issues will be addressed in a future release:
1232
1233     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
1234     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
1235     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
1236     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
1237     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1238     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
1239     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1240     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
1241
1242
1243
1244
1245 Version: 1.0.2
1246 --------------
1247
1248 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
1249
1250 **Bug Fixes**
1251
1252 The following fixes were deployed with the Amsterdam Maintenance Release:
1253
1254     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
1255
1256
1257 Version: 1.0.1
1258 --------------
1259
1260 :Release Date: 2017-11-16 (Amsterdam Release)
1261
1262 **New Features**
1263
1264 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`_.
1265
1266     * [POLICY-31] - Stabilization of Seed Code
1267         - POLICY-25  Replace any remaining openecomp reference by onap
1268         - POLICY-32  JUnit test code coverage
1269         - POLICY-66  PDP-D Feature mechanism enhancements
1270         - POLICY-67  Rainy Day Decision Policy
1271         - POLICY-93  Notification API
1272         - POLICY-158  policy/engine: SQL injection Mitigation
1273         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
1274
1275     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
1276         - POLICY-40  MSB Integration
1277         - POLICY-124  Integration with oparent
1278         - POLICY-41  OOM Integration
1279         - POLICY-119  PDP-D: noop sinks
1280
1281     * [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.
1282         - POLICY-57  VF-C Actor code development
1283         - POLICY-43  Amsterdam Use Case Template
1284         - POLICY-173  Deployment of Operational Policies Documentation
1285
1286     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
1287         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
1288
1289     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
1290
1291     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
1292         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
1293         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
1294         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
1295         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
1296
1297     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
1298
1299     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
1300         - POLICY-61  vFW Use Case - Runtime
1301         - POLICY-62  vDNS Use Case - Runtime
1302         - POLICY-59  vCPE Use Case - Runtime
1303         - POLICY-60  VOLTE Use Case - Runtime
1304         - POLICY-51  Runtime Policy Update Support
1305         - POLICY-328  vDNS Use Case - Runtime Testing
1306         - POLICY-324  vFW Use Case - Runtime Testing
1307         - POLICY-320  VOLTE Use Case - Runtime Testing
1308         - POLICY-316  vCPE Use Case - Runtime Testing
1309
1310     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
1311         - POLICY-77  Functional Test case definition for Control Loops
1312         - POLICY-387  Deliver the released policy artifacts
1313
1314
1315 **Bug Fixes**
1316     - 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`_.
1317
1318
1319 **Known Issues**
1320     - 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.
1321
1322     - For vLBS Use Case, the following steps are required to setup the service instance:
1323         -  Create a Service Instance via VID.
1324         -  Create a VNF Instance via VID.
1325         -  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.
1326         -  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.
1327         -  Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
1328         -  Populate AAI with a dummy VF module for vDNS scaling.
1329
1330 **Security Issues**
1331     - None at this time
1332
1333 **Other**
1334     - None at this time
1335
1336
1337 .. Links to jira release notes
1338
1339 .. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
1340 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
1341 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
1342 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
1343 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
1344
1345 .. Links to Project related pages
1346
1347 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
1348 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
1349
1350
1351 .. note
1352 ..      CHANGE  HISTORY
1353 ..  09/19/2019 - Updated for El Alto Release.
1354 ..  05/16/2019 - Updated for Dublin Release.
1355 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
1356 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
1357 ..      Changed version number to use ONAP versions.
1358 ..      10/08/2018 - Initial document for Casablanca release.
1359 ..  05/29/2018 - Information for Beijing release.
1360 ..      03/22/2018 - Initial document for Beijing release.
1361 ..      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)
1362 ..      Also, Set up initial information for Beijing.
1363 ..      Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
1364
1365
1366 End of Release Notes
1367
1368 .. How to notes for SS
1369 ..  For initial document: list epic and user stories for each, list user stories with no epics.
1370 ..      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.
1371 ..      For Known issues, list bugs that are slotted for a future release.