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