Update release notes for the London 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 Framework 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 ..      * * *     LONDON     * * *
19 ..      ==========================
20
21 Version: 12.0.0
22 ---------------
23
24 :Release Date: 2023-06-15 (London Release)
25
26 Artifacts released:
27
28 .. list-table::
29    :widths: 15 10 10
30    :header-rows: 1
31
32    * - Repository
33      - Java Artifact
34      - Docker Image (if applicable)
35    * - policy/parent
36      - 3.7.2
37      - N/A
38    * - policy/docker
39      - 2.6.2
40      - | policy-jre-alpine
41        | policy-jdk-alpine
42        | policy-db-migrator
43    * - policy/common
44      - 1.12.2
45      - N/A
46    * - policy/models
47      - 2.8.2
48      - N/A
49    * - policy/api
50      - 2.8.2
51      - policy-api
52    * - policy/pap
53      - 2.8.2
54      - policy-pap
55    * - policy/apex-pdp
56      - 2.9.2
57      - policy-apex-pdp
58    * - policy/drools-pdp
59      - 1.12.2
60      - policy-drools
61    * - policy/xacml-pdp
62      - 2.8.2
63      - policy-xacml-pdp
64    * - policy/distribution
65      - 2.9.2
66      - policy-distribution
67    * - policy/clamp
68      - 6.4.3
69      - | policy-clamp-ac-pf-ppnt
70        | policy-clamp-ac-k8s-ppnt
71        | policy-clamp-ac-http-ppnt
72        | policy-clamp-runtime-acm'
73    * - policy/gui
74      - 2.4.2
75      - policy-gui
76    * - policy/drools-applications
77      - 1.12.2
78      - policy-pdpd-cl
79
80 Key Updates
81 ===========
82
83 * Improvements to CLAMP Automation Composition Management (ACM)
84
85   CLAMP ACM is improved to allow much more flexibility in the specification and life cycle management of rApps. ACM can manage the lifecycle of
86   rApps made up of an arbitrary number of microservices and rules/learning models/schemas in the form of metadata. In the London release,
87   the state machine is improved to allow priming of rApp types, and to support deploymeent/undeployment and locking/unlocking of rApps.
88   Update of the properties of rApps is also supported at run time. In addition,
89   `ITU Recommendation X.731 <https://www.itu.int/rec/T-REC-X.731-199201-I/en>`_ is now supported for state reporting from rApp microservices.
90
91   See:
92    - `POLICY-4401 <https://jira.onap.org/browse/POLICY-4401>`_ - R12: Improvements specific to clamp
93
94 * Improved database support in CLAMP ACM
95
96   CLAMP ACM now supports MySql 8.x as a database and supports secured DB communication.
97
98   See:
99    - `POLICY-4395 <https://jira.onap.org/browse/POLICY-4395>`_ - R12: Database related issues
100
101 * Metadata driven API Generation
102
103   Up until now, the Policy Framework components used handwritten code to implement their REST interfaces and the Swagger 2 API documentation was generated from
104   annotations in the code. From the London release on, the REST API code is generated from OpenAPI 3.0 (Swagger 3.0) documents. In addition, the API documentation
105   is substantially enhanced. See the `Policy Offered APIs in the documentation <https://docs.onap.org/projects/onap-policy-parent/en/london/offeredapis.html>`_.
106
107   See:
108    - `POLICY-4123 <https://jira.onap.org/browse/POLICY-4123>`_ - R12: OpenAPI Adaption and Swagger Cleanup
109
110 * Improved Metrics and SLAs
111
112   The metrics generated by the Policy Framework have been substantially improved for the London release. In addition to gathering metrics on REST call
113   performance and policy deployment and execution time, we have defined SLA values for these metrics. We have implemented automated tests that run
114   as part of the CSIT testing that ensure the SLAs are complied with.
115
116   See:
117    - `POLICY-4124 <https://jira.onap.org/browse/POLICY-4124>`_ - R12: Add metrics to measure SLAs
118
119 * Improved Testing
120
121   Testing is much improved in the London release.
122     - S3P tests have been automated and run as CSIT tests
123     - Automated tests to verify SLA compliance using prometheus metrics are added
124     - A suite of contract tests is provided for each REST API
125     - Tests now use http rather than https
126
127   See:
128    - `POLICY-4125 <https://jira.onap.org/browse/POLICY-4125>`_ - R12: New Test Development
129    - `POLICY-4126 <https://jira.onap.org/browse/POLICY-4126>`_ - R12: Improve Automated Testing and Policy Framework S3P Tests
130
131 Known Limitations, Issues and Workarounds
132 =========================================
133
134 System Limitations
135 ~~~~~~~~~~~~~~~~~~
136 N/A
137
138 Known Vulnerabilities
139 ~~~~~~~~~~~~~~~~~~~~~
140 .. list-table::
141    :widths: 8 3 5 15
142    :header-rows: 1
143
144    * - Dependency
145      - Security Threat Level
146      - Policy Framework Components
147      - Comment
148    * - com.fasterxml.jackson.core:jackson-core:2.14.1 (2.15.1)
149      - 10
150      - | policy/common (D)
151        | policy/models (T)
152        | policy/api (T)
153        | policy/pap (T)
154        | policy/distribution (T)
155        | policy/clamp (T)
156        | policy/gui (T)
157        | policy/apex-pdp (T)
158        | policy/xacml-pdp (T)
159        | policy/drools-pdp (T)
160        | policy/drools-applications (T)
161      - Used in the implementation of policy endpoints
162    * - com.google.protobuf:protobuf-java:3.10.0
163      - 10
164      - | policy/models (T)
165        | policy/clamp (T)
166        | policy/apex-pdp (T)
167        | policy/drools-applications (T)
168      - Transitive dependency pulled in by CDS/Spring/Springboot
169    * - com.squareup.okhttp3:okhttp:4.9.1
170      - 10
171      - | policy/clamp (T)
172      - Transitive dependency pulled in by Spring/Springboot
173    * - com.sthoughtworks.xstrea:xstream:1.4.19
174      - 10
175      - | policy/drools-pdp (T)
176      - Transitive dependency pulled in by Drools rules
177    * - net.minidev:json-smart:2.4.6
178      - 10
179      - | policy/models (T)
180        | policy/apex-pdp (T)
181        | policy/drools-applications (T)
182      - Transitive dependency pulled in by CDS
183    * - io.grpc:grpc-core:1.25.0
184      - 6
185      - | policy/models (T)
186        | policy/apex-pdp (T)
187        | policy/drools-applications (T)
188      - Transitive dependency pulled in by CDS
189    * - org.apache.maven:maven-model:3.8.6
190      - 6
191      - | policy/drools-pdp (T)
192      - Transitive dependency pulled in to handle artifact generation
193    * - org.apache.tomcat.embed:tomcat-embed-core:9.0.71
194      - 10
195      - | policy/api (T)
196        | policy/pap (T)
197        | policy/clamp (T)
198      - Transitive dependency pulled in by org.springframework.boot:spring-boot-starter-web
199    * - org.bouncycastle:bc.fips:1.0.2.3
200      - 6
201      - | policy/common (T)
202        | policy/models (T)
203        | policy/distribution (T)
204        | policy/apex-pdp (T)
205      - Transitive dependency pulled in by org.bouncycastle:bcpkix-fips:1.0.5 in the utils-test module
206    * - org.eclipse.jetty:jetty-http:10.0.13
207      - 6
208      - | policy/common (T)
209        | policy/models (T)
210        | policy/api (T)
211        | policy/pap (T)
212        | policy/distribution (T)
213        | policy/clamp (T)
214        | policy/gui (T)
215        | policy/apex-pdp (T)
216        | policy/drools-pdp (T)
217        | policy/xacml-pdp (T)
218        | policy/drools-applications (T)
219      - Transitive dependency pulled in by org.eclipse.jetty:jetty-server
220    * - org.eclipse.jetty:jetty-server:10.0.13
221      - 6
222      - | policy/common (D)
223        | policy/models (T)
224        | policy/api (T)
225        | policy/pap (T)
226        | policy/distribution (T)
227        | policy/clamp (T)
228        | policy/gui (T)
229        | policy/apex-pdp (T)
230        | policy/drools-pdp (T)
231        | policy/xacml-pdp (T)
232        | policy/drools-applications (T)
233      - Used in the implementation of policy endpoints
234    * - org.jetbrains.kotlin:kotlin-daemon-client:1.3.61
235      - 6
236      - | policy/models (T)
237        | policy/apex-pdp (T)
238        | policy/drools-applications (T)
239      - Transitive dependency pulled in by CDS
240    * - org.jetbrains.kotlin:kotlin-scripting-jvm:1.3.61
241      - 6
242      - | policy/models (T)
243        | policy/apex-pdp (T)
244        | policy/drools-applications (T)
245      - Transitive dependency pulled in by CDS
246    * - org.springframework:spring-web:5.3.25
247      - 10
248      - | policy/api (T)
249        | policy/pap (T)
250        | policy/clamp (T)
251        | policy/gui (T)
252      - Transitive dependency pulled in by Spring/Springboot
253    * - org.springframework:spring-webmvc:5.3.25
254      - 10
255      - | policy/api (T)
256        | policy/pap (T)
257        | policy/clamp (T)
258        | policy/gui (T)
259      - Transitive dependency pulled in by Spring/Springboot
260    * - org.springframework.boot:spring-boot-actuator-autoconfigure:2.7.8
261      - 10
262      - | policy/api (T)
263        | policy/pap (T)
264        | policy/clamp (T)
265        | policy/gui (T)
266      - Transitive dependency pulled in by Spring/Springboot
267    * - org.springframework.boot:spring-boot-autoconfigure:2.7.8
268      - 10
269      - | policy/models (T)
270        | policy/api (T)
271        | policy/pap (T)
272        | policy/clamp (T)
273        | policy/gui (T)
274        | policy/apex-pdp (T)
275        | policy/drools-applications (T)
276      - Transitive dependency pulled in by Spring/Springboot
277    * - org.springframework.security:spring-security-config:5.7.6
278      - 10
279      - | policy/api (T)
280        | policy/pap (T)
281        | policy/clamp (T)
282      - Transitive dependency pulled in by Spring/Springboot
283    * - org.springframework.security:spring-security-web:5.7.6
284      - 10
285      - | policy/api (T)
286        | policy/pap (T)
287        | policy/clamp (T)
288      - Transitive dependency pulled in by Spring/Springboot
289    * - org.webjars:jquery-ui:1.12.1
290      - 6
291      - | policy/gui (T)
292      - Used by GUI for doing jquery queries
293
294 Workarounds
295 ~~~~~~~~~~~
296 N/A
297
298 Security Notes
299 ==============
300
301 Upgrading to Spring 6 and Springboot 3 is required to remove security vulnerabilities above. This change requries moving to Java 17.
302 This change will be done in the Montreal release of the Policy Framework. See `POLICY-4665 <https://jira.onap.org/browse/POLICY-4665>`_.
303
304 Functional Improvements
305 =======================
306 | `POLICY-4395 <https://jira.onap.org/browse/POLICY-4395>`_ - R12: Database related issues
307 |  `POLICY-4184 <https://jira.onap.org/browse/POLICY-4184>`_ - ACM Support for MySql 8.x DB client interfaces
308 |  `POLICY-4358 <https://jira.onap.org/browse/POLICY-4358>`_ - Support secured DB communications for CLAMP/ACM
309 | `POLICY-4401 <https://jira.onap.org/browse/POLICY-4401>`_ - R12: Improvements specific to clamp
310 |  `POLICY-4282 <https://jira.onap.org/browse/POLICY-4282>`_ - Test and Verification of ACM State Management
311 |  `POLICY-4330 <https://jira.onap.org/browse/POLICY-4330>`_ - Add Prometheus metric messages for ACM
312 |  `POLICY-4413 <https://jira.onap.org/browse/POLICY-4413>`_ - Refactor the state machines in CLAMP ACM-R and the Participant Intermediary
313 |  `POLICY-4418 <https://jira.onap.org/browse/POLICY-4418>`_ - Remove old implementation of statistics in ACM
314 |  `POLICY-4458 <https://jira.onap.org/browse/POLICY-4458>`_ - Create a Participant for A1-PMS 
315 |  `POLICY-4525 <https://jira.onap.org/browse/POLICY-4525>`_ - Create a Participant for KServe
316 |  `POLICY-4563 <https://jira.onap.org/browse/POLICY-4563>`_ - ACM manual and automation tests
317 |  `POLICY-4639 <https://jira.onap.org/browse/POLICY-4639>`_ - UseState and OperationalState support in ACM
318
319 Necessary Improvements and Bug Fixes
320 ====================================
321
322 Necessary Improvements
323 ~~~~~~~~~~~~~~~~~~~~~~
324 | `POLICY-4122 <https://jira.onap.org/browse/POLICY-4122>`_ - R12: Refactoring and Removal of Unused Code
325 |  `POLICY-4138 <https://jira.onap.org/browse/POLICY-4138>`_ - Transfer the API handling from the clamp-backend microservice to another microservice
326 |  `POLICY-4139 <https://jira.onap.org/browse/POLICY-4139>`_ - Remove the clamp-backend microservice
327 |  `POLICY-4140 <https://jira.onap.org/browse/POLICY-4140>`_ - Ensure that all unit tests and automated integration and S3P tests still pass when the unused code is removed
328 |  `POLICY-4157 <https://jira.onap.org/browse/POLICY-4157>`_ - Investigation story For Server-Client in PF
329 | `POLICY-4123 <https://jira.onap.org/browse/POLICY-4123>`_ - R12: OpenAPI Adaption and Swagger Cleanup
330 |  `POLICY-3368 <https://jira.onap.org/browse/POLICY-3368>`_ - Revise Rest API conventions and structure
331 |  `POLICY-3465 <https://jira.onap.org/browse/POLICY-3465>`_ - Upgrade Swagger to io.swagger.core.v3
332 |  `POLICY-4143 <https://jira.onap.org/browse/POLICY-4143>`_ - Generate Contract Testing stubs from OpenAPI specifications
333 |  `POLICY-4144 <https://jira.onap.org/browse/POLICY-4144>`_ - Ensure that all unit tests and automated integration and S3P tests still pass when the OpenAPI approach is reversed
334 |  `POLICY-4158 <https://jira.onap.org/browse/POLICY-4158>`_ - Open API Specifications as a Source Artifacts ACM
335 |  `POLICY-4159 <https://jira.onap.org/browse/POLICY-4159>`_ - Maven build for OpenAPI Interface Generation
336 |  `POLICY-4160 <https://jira.onap.org/browse/POLICY-4160>`_ - Rest endpoint implementation code Acm
337 |  `POLICY-4162 <https://jira.onap.org/browse/POLICY-4162>`_ - Spike to understand OpenAPI Adaption
338 |  `POLICY-4404 <https://jira.onap.org/browse/POLICY-4404>`_ - Remove SpringFox from Policy Framework
339 |  `POLICY-4448 <https://jira.onap.org/browse/POLICY-4448>`_ - Rest endpoint implementation code Api and Pap
340 | `POLICY-4124 <https://jira.onap.org/browse/POLICY-4124>`_ - R12: Add metrics to measure SLAs
341 |  `POLICY-4145 <https://jira.onap.org/browse/POLICY-4145>`_ - Enable Observability and Performance Management
342 |  `POLICY-4147 <https://jira.onap.org/browse/POLICY-4147>`_ - Add Prometheus counters for measuring APEX PDP performance SLAs
343 |  `POLICY-4148 <https://jira.onap.org/browse/POLICY-4148>`_ - Check counter names for consistency
344 |  `POLICY-4149 <https://jira.onap.org/browse/POLICY-4149>`_ - Verify that the counters are being produced
345 |  `POLICY-4165 <https://jira.onap.org/browse/POLICY-4165>`_ - SLAs from Global Requirements
346 |  `POLICY-4469 <https://jira.onap.org/browse/POLICY-4469>`_ - SLAs on REST Interfaces for Async Requests
347 | `POLICY-4125 <https://jira.onap.org/browse/POLICY-4125>`_ - R12: New Test Development
348 |  `POLICY-4150 <https://jira.onap.org/browse/POLICY-4150>`_ - Add the tests to the automated test suite in the Policy Framework
349 |  `POLICY-4151 <https://jira.onap.org/browse/POLICY-4151>`_ - Add tests that check SLA compliance
350 |  `POLICY-4152 <https://jira.onap.org/browse/POLICY-4152>`_ - Execute the new tests
351 |  `POLICY-4164 <https://jira.onap.org/browse/POLICY-4164>`_ - Verify SLAs on Policy Execution in PDPs
352 |  `POLICY-4571 <https://jira.onap.org/browse/POLICY-4571>`_ - S3P Test to check multiple PDP registration
353 |  `POLICY-4655 <https://jira.onap.org/browse/POLICY-4655>`_ - Remove k8s based csit from jenkins
354 | `POLICY-4126 <https://jira.onap.org/browse/POLICY-4126>`_ - R12: Improve Automated Testing and Policy Framework S3P Tests
355 |  `POLICY-4111 <https://jira.onap.org/browse/POLICY-4111>`_ - S3P testing of APEX-PDP prometheus metrics
356 |  `POLICY-4153 <https://jira.onap.org/browse/POLICY-4153>`_ - Ensure reports on SLA compliance are generated by test execution
357 |  `POLICY-4154 <https://jira.onap.org/browse/POLICY-4154>`_ - Write a suite of automated contract tests.
358 |  `POLICY-4155 <https://jira.onap.org/browse/POLICY-4155>`_ - Add the tests to the automated test suite in the Policy Framework
359 |  `POLICY-4156 <https://jira.onap.org/browse/POLICY-4156>`_ - Automate the current S3P test suites in the Policy Framework
360 |  `POLICY-4417 <https://jira.onap.org/browse/POLICY-4417>`_ - Support Policy CSIT tests in kubernetes environment with helm chart
361 |  `POLICY-4501 <https://jira.onap.org/browse/POLICY-4501>`_ - Add ACM demo service template example in clamp
362 | `POLICY-4127 <https://jira.onap.org/browse/POLICY-4127>`_ - R12: Enhance Policy Framework Documentation
363 |  `POLICY-4581 <https://jira.onap.org/browse/POLICY-4581>`_ - Policy Offered APIs
364 |  `POLICY-4583 <https://jira.onap.org/browse/POLICY-4583>`_ - Update Policy Platform Development Tools documentation
365 |  `POLICY-4586 <https://jira.onap.org/browse/POLICY-4586>`_ - Review and update the ACM design documentation
366 |  `POLICY-4587 <https://jira.onap.org/browse/POLICY-4587>`_ - Write documentation for Composition and participant development in ACM
367 | `POLICY-4396 <https://jira.onap.org/browse/POLICY-4396>`_ - R12: Improvements specific to apex-pdp
368 |  `POLICY-4411 <https://jira.onap.org/browse/POLICY-4411>`_ - Make apex-pdp dockerfile consistent
369 |  `POLICY-4460 <https://jira.onap.org/browse/POLICY-4460>`_ - Add documentation for KafkaAvroSerializer support in apex-pdp
370 | `POLICY-4397 <https://jira.onap.org/browse/POLICY-4397>`_ - R12: Improvements specific to xacml-pdp
371 |  `POLICY-4218 <https://jira.onap.org/browse/POLICY-4218>`_ - Add handling of references in the XACML-PDP Tutorial code to the release scripts
372 | `POLICY-4398 <https://jira.onap.org/browse/POLICY-4398>`_ - R12: Improvements specific to drools-pdp and drools-applications
373 |  `POLICY-4405 <https://jira.onap.org/browse/POLICY-4405>`_ - Mitigate vulnerable dependencies in drools-pdp
374 | `POLICY-4399 <https://jira.onap.org/browse/POLICY-4399>`_ - R12: Improvements to api/pap and policy handling
375 |  `POLICY-4451 <https://jira.onap.org/browse/POLICY-4451>`_ - Policy PAP hard codes topic names
376 |  `POLICY-4455 <https://jira.onap.org/browse/POLICY-4455>`_ - Make topics in PAP configurable
377 |  `POLICY-4463 <https://jira.onap.org/browse/POLICY-4463>`_ - Fix pap csit with topics names
378 | `POLICY-4407 <https://jira.onap.org/browse/POLICY-4407>`_ - R12: Software (non functional) improvements
379 |  `POLICY-4360 <https://jira.onap.org/browse/POLICY-4360>`_ - Fix grafana compose 
380 |  `POLICY-4466 <https://jira.onap.org/browse/POLICY-4466>`_ - Move duplicate POM config for git-commit-id-maven-plugin to policy/parent
381 |  `POLICY-4471 <https://jira.onap.org/browse/POLICY-4471>`_ - Check and repair CSIT jobs
382 |  `POLICY-4474 <https://jira.onap.org/browse/POLICY-4474>`_ - Ensure code coverage in all components is over 80%
383 |  `POLICY-4482 <https://jira.onap.org/browse/POLICY-4482>`_ - Mitigate Vulnerabilities in Dependencies of Policy Components
384 |  `POLICY-4484 <https://jira.onap.org/browse/POLICY-4484>`_ - Perform Interim Release of Policy Framework for London
385 |  `POLICY-4536 <https://jira.onap.org/browse/POLICY-4536>`_ - Fix Sonar issues in PF components
386 |  `POLICY-4547 <https://jira.onap.org/browse/POLICY-4547>`_ - Fix issue in StartAndStop Activator Test
387 |  `POLICY-4549 <https://jira.onap.org/browse/POLICY-4549>`_ - Improve MariaDB sqls for db-migrator
388 |  `POLICY-4558 <https://jira.onap.org/browse/POLICY-4558>`_ - Remove Integration Docker base images from Policy Framework base images
389 |  `POLICY-4570 <https://jira.onap.org/browse/POLICY-4570>`_ - Policy Framework Interim Release
390 |  `POLICY-4578 <https://jira.onap.org/browse/POLICY-4578>`_ - Update vulnerabilities in Policy Components
391 |  `POLICY-4628 <https://jira.onap.org/browse/POLICY-4628>`_ - Update sdc-distribution-client to 2.0.1
392 |  `POLICY-4638 <https://jira.onap.org/browse/POLICY-4638>`_ - Restructure policy-gui
393 |  `POLICY-4648 <https://jira.onap.org/browse/POLICY-4648>`_ - Release images for M4
394 |  `POLICY-4680 <https://jira.onap.org/browse/POLICY-4680>`_ - Pin versions of python libraries in csit configuration
395 | `REQ-439 <https://jira.onap.org/browse/REQ-439>`_ - Continuation of Package Upgrades in Direct Dependencies
396 |  `POLICY-4472 <https://jira.onap.org/browse/POLICY-4472>`_ - Packages Upgrades in Direct Dependencies for London Release
397
398 Bug Fixes
399 ~~~~~~~~~
400 | `POLICY-4649 <https://jira.onap.org/browse/POLICY-4649>`_ - Fix postgres script syntax errors 
401 | `POLICY-4625 <https://jira.onap.org/browse/POLICY-4625>`_ - Participant primed status is not updated correctly in the runtime 
402 | `POLICY-4623 <https://jira.onap.org/browse/POLICY-4623>`_ - Fix Anchor installing-or-upgrading-policy in docs
403 | `POLICY-4576 <https://jira.onap.org/browse/POLICY-4576>`_ - Omission in release script to update oom images
404 | `POLICY-4575 <https://jira.onap.org/browse/POLICY-4575>`_ - Fix ClassCastException in ACM
405 | `POLICY-4562 <https://jira.onap.org/browse/POLICY-4562>`_ - Sonar hotspot Interrupted Exception
406 | `POLICY-4561 <https://jira.onap.org/browse/POLICY-4561>`_ - Fix UNDEPLOY transition in policyParticipant in ACM
407 | `POLICY-4560 <https://jira.onap.org/browse/POLICY-4560>`_ - Fix participantHtml issue with multi instances in ACM
408 | `POLICY-4537 <https://jira.onap.org/browse/POLICY-4537>`_ - Policy DB scripts are bound to fixed MariaDB version
409 | `POLICY-4527 <https://jira.onap.org/browse/POLICY-4527>`_ - Galera jobs must use repositoryGenerator quitQuit images 
410 | `POLICY-4491 <https://jira.onap.org/browse/POLICY-4491>`_ - Fix PAP CSIT intermittent failure
411 | `POLICY-4490 <https://jira.onap.org/browse/POLICY-4490>`_ - Disable ACM CSITs due to ongoing work
412 | `POLICY-4486 <https://jira.onap.org/browse/POLICY-4486>`_ - Fix copy contructor in DocToscaServiceTemplate in ACM
413 | `POLICY-4473 <https://jira.onap.org/browse/POLICY-4473>`_ - Clamp ACM dockersuse profile not working
414 | `POLICY-4429 <https://jira.onap.org/browse/POLICY-4429>`_ - PDP-X guard table creation script problems with = in password
415 | `POLICY-4410 <https://jira.onap.org/browse/POLICY-4410>`_ - Fix ACM stability and performance jmx configuration for random failures
416 | `POLICY-4381 <https://jira.onap.org/browse/POLICY-4381>`_ - The REST path of ACM endpoints is not configurable via Spring properties
417
418 References
419 ==========
420
421 For more information on the ONAP London release, please see:
422
423 #. `ONAP Home Page`_
424 #. `ONAP Documentation`_
425 #. `ONAP Release Downloads`_
426 #. `ONAP Wiki Page`_
427
428 .. _`ONAP Home Page`: https://www.onap.org
429 .. _`ONAP Wiki Page`: https://wiki.onap.org
430 .. _`ONAP Documentation`: https://docs.onap.org
431 .. _`ONAP Release Downloads`: https://git.onap.org
432
433 Quick Links:
434     - `POLICY project page`_
435     - `Passing Badge information for POLICY`_
436
437 ..      ==========================
438 ..      * * *     KOHN       * * *
439 ..      ==========================
440
441 Version: 11.0.0
442 ---------------
443
444 :Release Date: 2022-11-20 (Kohn Release)
445
446 Artifacts released:
447
448 .. list-table::
449    :widths: 15 10 10
450    :header-rows: 1
451
452    * - Repository
453      - Java Artifact
454      - Docker Image (if applicable)
455    * - policy/parent
456      - 3.6.1
457      - N/A
458    * - policy/docker
459      - 2.5.1
460      - | policy-jre-alpine
461        | policy-jdk-alpine
462        | policy-db-migrator
463    * - policy/common
464      - 1.11.1
465      - N/A
466    * - policy/models
467      - 2.7.2
468      - N/A
469    * - policy/api
470      - 2.7.2
471      - policy-api
472    * - policy/pap
473      - 2.7.2
474      - policy-pap
475    * - policy/apex-pdp
476      - 2.8.2
477      - policy-apex-pdp
478    * - policy/drools-pdp
479      - 1.11.2
480      - policy-drools
481    * - policy/xacml-pdp
482      - 2.7.2
483      - policy-xacml-pdp
484    * - policy/distribution
485      - 2.8.2
486      - policy-distribution
487    * - policy/clamp
488      - 6.3.2
489      - | policy-clamp-ac-pf-ppnt
490        | policy-clamp-ac-k8s-ppnt
491        | policy-clamp-ac-http-ppnt
492        | policy-clamp-runtime-acm'
493    * - policy/gui
494      - 2.3.2
495      - policy-gui
496    * - policy/drools-applications
497      - 1.11.2
498      - policy-pdpd-cl
499
500 Key Updates
501 ===========
502
503 * Support for O1 and A1 Policy Payloads in the 5G SON use Case
504
505   The 5G SON policy is updated to allow O1 and A1 Policy payloads to be passed to SDN-R. Now, policies can pass O1 and
506   A1 Policy payloads.
507
508   See:
509    - `REQ-1212 <https://jira.onap.org/browse/REQ-1212>`_ - 5G SON use case enhancements for Kohn release
510    - `POLICY-4108 <https://jira.onap.org/browse/POLICY-4108>`_ Control Loop Policy for A1-based action for SON
511      Use Case
512
513
514 * Native Kafka messaging bewtween Policy Framework components
515
516   The Policy Framework can now be configured to use Kafka for asynchronous communication between PAP and PDPs and
517   between CLAMP ACM Runtime and Participants. Kafka messaging is an alternative to using DMaaP MR for asynchronous
518   messaging. The Policy Framework components are configured to use either DMaaP or Kafka messaging, with DMaaP
519   being the default. This change is supported by APEX-PDP in this release and will be supported DROOLS-PDP and XACML-PDP
520   in future releases.
521
522   See:
523    - `POLICY-4121  <https://jira.onap.org/browse/POLICY-4121>`_ - R11: DMaaP and Kafka updates
524
525 * Support for Secured Database Communication
526
527   Database communiction with MariaDB, MySql, or PostgreSQL can be configured to be secure. Secure database communication
528   is introduced for API, PAP, DROOLS-PDP and XACML-PDP. Support for secure database communication will be introduced in
529   CLAMP ACM in a future release.
530
531   See:
532    - `POLICY-4176  <https://jira.onap.org/browse/POLICY-4176>`_ - Support Secured Database Connections
533
534 * Support for MySql 8
535
536   The Policy Framework can use MySql 8 for persistence in addition to MariaDb and Postgres. Interoperability with MySql
537   8 has been added for DB-MIGRATOR, API, PAP, DROOLS-PDP, XACML-PDP, and CLAM ACM.
538
539   See:
540    - `POLICY-4314  <https://jira.onap.org/browse/POLICY-4314>`_ - Support for MySql 8.x DB client interfaces
541
542 * Support for Service Mesh
543
544   All Policy Framework components and images support service mesh and are service mesh compatible. The OOM charts for
545   all Policy Framework components have been updated to supprot configuration for Service Mesh. In addition, some minor
546   bugs in startup scripts were fixed to allow HTTP or HTTPS to be configured on components.
547
548 * XACML-PDP improvements
549
550   - Support for XACML 3.1 introduced
551   - Exposure of application level metrics
552   - Support for Postgres database as well as MariaDB
553   - Support for DCAE TCAGEN2 monitoring app changes
554   - Logging to standard output
555   - XACML tutorial updated and improved
556
557   See:
558    - `POLICY-4049  <https://jira.onap.org/browse/POLICY-4049>`_ - R11: Improvements specific to xacml-pdp
559
560 * DROOLS-PDP and DROOLS-Applications improvements
561
562   - Latest Drools libraries supported
563   - JDBC pooling libraries upgraded
564
565   See:
566    - `POLICY-4050  <https://jira.onap.org/browse/POLICY-4050>`_ - R11: Improvements specific to drools-pdp and drools-applications
567
568 * APEX-PDP Improvements
569
570    - Support for event definitions in JSON as well as AVRO is added
571    - Support for Metadata Set generation from the APEX CLI editor
572    - Support for deserialization of messages encoded in Avro carried over Kafka
573
574   See:
575    - `POLICY-4048  <https://jira.onap.org/browse/POLICY-4048>`_ - R11: Improvements specific to apex-pdp
576
577 * Policy-Distribution Improvements
578
579    - Configuration added to allow distribution of CLAMP ACM compositions
580    - Policy distribution re-synchs if SDC is reinstalled
581
582    See:
583     - `POLICY-4052  <https://jira.onap.org/browse/POLICY-4052>`_ - R11: Improvements to distribution
584
585 * CLAMP Improvements
586
587    - Instance properties can be edited
588    - Helm repository can be configured in the Kubernetes participant
589
590   See:
591    - `POLICY-4053  <https://jira.onap.org/browse/POLICY-4053>`_ - R11: Improvements specific to clamp
592
593 * System Attribute Improvements
594     - Demo Grafana dashboards available for policy framework components
595     - All parameters in Helm Charts have default values
596     - Springboot dependency handling improved in policy-parent
597     - CSITs amended to use HTTP rather than HTTPS and to use released image versions from Nexus when snapshot image
598       versions are not available
599     - Updates to database drivers to latest versions
600
601 Known Limitations, Issues and Workarounds
602 =========================================
603
604 System Limitations
605 ~~~~~~~~~~~~~~~~~~
606 N/A
607
608 Known Vulnerabilities
609 ~~~~~~~~~~~~~~~~~~~~~
610 .. list-table::
611    :widths: 8 3 5 15
612    :header-rows: 1
613
614    * - Dependency
615      - Security Threat Level
616      - Policy Framework Components
617      - Comment
618    * - io.grpc:grpc-core:1.25.0
619      - 6
620      - | policy/models
621        | policy/apex-pdp
622      - Transitive dependency pulled in by the CDS project
623    * - io.springfox:springfox-swagger-ui:3.0.0
624      - 6
625      - | policy/api
626        | policy/pap
627        | policy/clamp
628      - Dependency used to generate Swagger files from annotations
629    * - io.springfox:springfox-swagger2:3.0.0
630      - 6
631      - | policy/api
632        | policy/pap
633        | policy/clamp
634      - Dependency used to generate Swagger files from annotations
635    * - io.projectreactor.netty:reactor-netty-core:1.0.19
636      - 6
637      - | policy/clamp
638      - TBC
639    * - io.projectreactor.netty:reactor-netty-http:1.0.19
640      - 6
641      - | policy/clamp
642      - TBC
643    * - org.webjars jquery-ui 1.12.1
644      - 6
645      - | policy/gui
646      - TBC
647    * - com.thoughtworks.xstream:xstream:1.4.17
648      - 10
649      - | policy/drools-pdp
650      - Pulled in by the Drools rule engine
651    * - org.apache.maven:maven-compat:3.3.9
652      - 10
653      - | policy/drools-pdp
654      - Pulled in by the Drools rule engine
655    * - org.apache.maven:maven-core:3.3.9
656      - 10
657      - | policy/drools-pdp
658      - Pulled in by the Drools rule engine
659    * - org.apache.maven:maven-settings:3.3.9
660      - 10
661      - | policy/drools-pdp
662      - Pulled in by the Drools rule engine
663    * - org.jsoup:jsoup:1.7.2
664      - 10
665      - | policy/drools-pdp
666      - Pulled in by the Drools rule engine
667
668 Workarounds
669 ~~~~~~~~~~~
670 N/A
671
672 Security Notes
673 ==============
674 .. list-table::
675    :widths: 8 3 5 15
676    :header-rows: 1
677
678    * - Dependency
679      - Security Threat Level
680      - Policy Framework Components
681      - Comment
682    * - org.springframework:spring-web:5.3.22
683      - 10
684      - | policy/common
685        | policy/api
686        | policy/pap
687        | policy/clamp
688        | policy/gui
689      - Threat only applies when serialising and deserialising Java Objects, which the Policy Framework does not do
690
691 Functional Improvements
692 =======================
693 | `POLICY-4108  <https://jira.onap.org/browse/POLICY-4108>`_ - Control Loop Policy for A1-based action for SON Use Case
694 |  `POLICY-4356  <https://jira.onap.org/browse/POLICY-4356>`_ - 5g son policy models changes
695 |  `POLICY-4357  <https://jira.onap.org/browse/POLICY-4357>`_ - 5g son policy drools apps changes
696
697 | `POLICY-4121  <https://jira.onap.org/browse/POLICY-4121>`_ - R11: DMaaP and Kafka updates
698 |  `POLICY-4131  <https://jira.onap.org/browse/POLICY-4131>`_ - Update the DMaaP client in the Policy Framework common utility library.
699 |  `POLICY-4132  <https://jira.onap.org/browse/POLICY-4132>`_ - Check that all asynchronous messaging continues to work with updated DMaaP client
700 |  `POLICY-4133  <https://jira.onap.org/browse/POLICY-4133>`_ - Add a Kafka client in the Policy Framework common utility library.
701 |  `POLICY-4134  <https://jira.onap.org/browse/POLICY-4134>`_ - Configure the Policy Framework components to use Kafka along with DMaaP
702 |  `POLICY-4135  <https://jira.onap.org/browse/POLICY-4135>`_ - Check that all asynchronous messaging continues to work with Kafka messaging
703 |  `POLICY-4313  <https://jira.onap.org/browse/POLICY-4313>`_ - Move kafka version management to policy/parent/integration
704 |  `POLICY-4204  <https://jira.onap.org/browse/POLICY-4204>`_ - OOM experimentation using strimzi
705 |  `POLICY-4146  <https://jira.onap.org/browse/POLICY-4146>`_ - Add Prometheus counters for measuring SLAs on ACM REST endpoints
706 |  `POLICY-4163  <https://jira.onap.org/browse/POLICY-4163>`_ - SLAs on REST Interfaces
707 |  `POLICY-4166  <https://jira.onap.org/browse/POLICY-4166>`_ - Spike to understand metrics to measure SLAs
708 |  `POLICY-4220  <https://jira.onap.org/browse/POLICY-4220>`_ - CSIT does not display logs for some containers
709 |  `POLICY-4086  <https://jira.onap.org/browse/POLICY-4086>`_ - Improve CSIT to use proper currentInstanceCount value in PdpGroups
710 |  `POLICY-4338  <https://jira.onap.org/browse/POLICY-4338>`_ - Convert CSITs to use HTTP rather than HTTPS
711 |  `POLICY-4167  <https://jira.onap.org/browse/POLICY-4167>`_ - Add build instruction in readme
712
713 | `POLICY-4120  <https://jira.onap.org/browse/POLICY-4120>`_ - R11: SUSE flavoured images in the Policy Framework
714 |  `POLICY-4128  <https://jira.onap.org/browse/POLICY-4128>`_ - Create an OpenSuse docker file equivalent to the existing Alpine docker file for each image in the Policy Framework
715 |  `POLICY-4129  <https://jira.onap.org/browse/POLICY-4129>`_ - Add a build profile to each repo build to trigger generation of Suse flavoured images
716 |  `POLICY-4130  <https://jira.onap.org/browse/POLICY-4130>`_ - Add OCI Image spec labels to both Alpine and OpenSuse docker files
717 |  `POLICY-4208  <https://jira.onap.org/browse/POLICY-4208>`_ - Reduce size of docker images
718 |  `POLICY-4278  <https://jira.onap.org/browse/POLICY-4278>`_ - Upgrade OpenSuse to version 15.4
719 |  `POLICY-4334  <https://jira.onap.org/browse/POLICY-4334>`_ - Allow setting external dockerfile
720
721 | `POLICY-3642  <https://jira.onap.org/browse/POLICY-3642>`_ - R11: Database and TOSCA related issues
722 |  `POLICY-1749  <https://jira.onap.org/browse/POLICY-1749>`_ - Resolve specification of policy type versions in policies in TOSCA
723 |  `POLICY-2540  <https://jira.onap.org/browse/POLICY-2540>`_ - Proper handling of data types in policy-models and policy-api
724 |  `POLICY-3236  <https://jira.onap.org/browse/POLICY-3236>`_ - Adjust flexibility of Tosca Service Template Handling
725 |  `POLICY-4067  <https://jira.onap.org/browse/POLICY-4067>`_ - Fetch all versions of a policyType API returning only the latest version
726 |  `POLICY-4176  <https://jira.onap.org/browse/POLICY-4176>`_ - Support Secured Database Connections
727 |  `POLICY-4314  <https://jira.onap.org/browse/POLICY-4314>`_ - Support for MySql 8.x DB client interfaces
728 |  `POLICY-3489  <https://jira.onap.org/browse/POLICY-3489>`_ - Add script to load default data into tables using db-migrator
729 |  `POLICY-3585  <https://jira.onap.org/browse/POLICY-3585>`_ - TOSCA Handling issues
730 |  `POLICY-4097  <https://jira.onap.org/browse/POLICY-4097>`_ - Validate policy-api redundancy with at least 2 pods using J release
731 |  `POLICY-4098  <https://jira.onap.org/browse/POLICY-4098>`_ - Validate policy-pap redundancy with at least 2 pods using J release
732 |  `POLICY-4099  <https://jira.onap.org/browse/POLICY-4099>`_ - Spike to determine the work in apex-pdp for redundancy support
733 |  `POLICY-4100  <https://jira.onap.org/browse/POLICY-4100>`_ - Spike to determine the work in drools-pdp for redundancy support
734
735 | `POLICY-4048  <https://jira.onap.org/browse/POLICY-4048>`_ - R11: Improvements specific to apex-pdp
736 |  `POLICY-4290  <https://jira.onap.org/browse/POLICY-4290>`_ - Support JSON based event schema in apex-pdp
737 |  `POLICY-3446  <https://jira.onap.org/browse/POLICY-3446>`_ - Change apex-pdp to use BeanValidator
738 |  `POLICY-3810  <https://jira.onap.org/browse/POLICY-3810>`_ - Fix sonar issues in apex-pdp
739 |  `POLICY-4084  <https://jira.onap.org/browse/POLICY-4084>`_ - Apex cli editor should generate policies with metadataSet
740 |  `POLICY-4285  <https://jira.onap.org/browse/POLICY-4285>`_ - Remove debian packaging from apex-pdp build
741 |  `POLICY-4324  <https://jira.onap.org/browse/POLICY-4324>`_ - Fix Docker File for Apex MyFirstExample
742 |  `POLICY-4369  <https://jira.onap.org/browse/POLICY-4369>`_ - Support KafkaAvroDeserializer in KafkaConsumer plugin of apex-pdp
743
744 | `POLICY-4049  <https://jira.onap.org/browse/POLICY-4049>`_ - R11: Improvements specific to xacml-pdp
745 |  `POLICY-3762  <https://jira.onap.org/browse/POLICY-3762>`_ - Expose application level metrics in xacml-pdp
746 |  `POLICY-4187  <https://jira.onap.org/browse/POLICY-4187>`_ - Support postgresql in Xacml PDP
747 |  `POLICY-4317  <https://jira.onap.org/browse/POLICY-4317>`_ - PAP, PDP-X: Support DCAE tcagen2 monitoring app changes
748 |  `POLICY-3495  <https://jira.onap.org/browse/POLICY-3495>`_ - Xacml-pdp should log to stdout
749 |  `POLICY-4171  <https://jira.onap.org/browse/POLICY-4171>`_ - Update Docker Tag related configurations in XACML Tutorial code
750 |  `POLICY-4275  <https://jira.onap.org/browse/POLICY-4275>`_ - Upgrade XACML PDP to use XACML 3.1 release
751
752 | `POLICY-4050  <https://jira.onap.org/browse/POLICY-4050>`_ - R11: Improvements specific to drools-pdp and drools-applications
753 |  `POLICY-3960  <https://jira.onap.org/browse/POLICY-3960>`_ - Add/update documents for application metrics support in drools-pdp
754 |  `POLICY-4177  <https://jira.onap.org/browse/POLICY-4177>`_ - Support secured DB communications for PDP-D Core
755 |  `POLICY-4197  <https://jira.onap.org/browse/POLICY-4197>`_ - PDP-D: thread dump upon detection of application stuck session
756 |  `POLICY-4213  <https://jira.onap.org/browse/POLICY-4213>`_ - PDP-D APPS: Jenkins jobs started to fail basic builds
757 |  `POLICY-4281  <https://jira.onap.org/browse/POLICY-4281>`_ - Upgrade JDBC pooling libraries in drools
758 |  `POLICY-4335  <https://jira.onap.org/browse/POLICY-4335>`_ - PDP-D: Upgrade to the latest version of drools libraries
759
760 | `POLICY-4051  <https://jira.onap.org/browse/POLICY-4051>`_ - R11: Improvements to api, pap and policy handling
761 |  `POLICY-3887  <https://jira.onap.org/browse/POLICY-3887>`_ - Enhancement in enhanced policy health check
762 |  `POLICY-2874  <https://jira.onap.org/browse/POLICY-2874>`_ - Investigate Policy-API S3P stability test results
763 |  `POLICY-4288  <https://jira.onap.org/browse/POLICY-4288>`_ - Check PAP CSIT Undeploy test timeout
764
765 | `POLICY-4052  <https://jira.onap.org/browse/POLICY-4052>`_ - R11: Improvements to distribution
766 |  `POLICY-4110  <https://jira.onap.org/browse/POLICY-4110>`_ - Update configuration changes for distribution of ACM
767 |  `POLICY-2103  <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
768
769 | `POLICY-4053  <https://jira.onap.org/browse/POLICY-4053>`_ - R11: Improvements specific to clamp
770 |  `POLICY-4078  <https://jira.onap.org/browse/POLICY-4078>`_ - Investigation of DB issue within Policy Clamp runtime
771 |  `POLICY-4341  <https://jira.onap.org/browse/POLICY-4341>`_ - ACM Runtime pod fails to come-up referencing to wrong filepath
772 |  `POLICY-4365  <https://jira.onap.org/browse/POLICY-4365>`_ - Increase code coverage in clamp
773 |  `POLICY-4094  <https://jira.onap.org/browse/POLICY-4094>`_ - Add Edit functionality for instance properties in Policy GUI
774 |  `POLICY-4105  <https://jira.onap.org/browse/POLICY-4105>`_ - Remove usage of jackson libraries from clamp runtime acm
775 |  `POLICY-4113  <https://jira.onap.org/browse/POLICY-4113>`_ - Make the permitted helm repository protocol a configurable parameter in k8s participant
776 |  `POLICY-4224  <https://jira.onap.org/browse/POLICY-4224>`_ - Clean up CLAMP Docker handling
777 |  `POLICY-4225  <https://jira.onap.org/browse/POLICY-4225>`_ - Fix type version in all tosca_service_template
778 |  `POLICY-4229  <https://jira.onap.org/browse/POLICY-4229>`_ - Fix type version in all tosca_service_template in parent documetation
779 |  `POLICY-4237  <https://jira.onap.org/browse/POLICY-4237>`_ - Add override parameters for enabling protocol in k8s-ppnt helm chart
780 |  `POLICY-4240  <https://jira.onap.org/browse/POLICY-4240>`_ - Update PMSH service template for ACM
781 |  `POLICY-4286  <https://jira.onap.org/browse/POLICY-4286>`_ - Junk output in the docker build for kubernetes participant
782 |  `POLICY-4289  <https://jira.onap.org/browse/POLICY-4289>`_ - Refactoring redundant spring libraries defined in clamp pom files
783 |  `POLICY-4371  <https://jira.onap.org/browse/POLICY-4371>`_ - Remove policy-clamp-be from OOM deployment for Service Mesh
784 |  `POLICY-4382  <https://jira.onap.org/browse/POLICY-4382>`_ - Update ACM document in ONAP doc for Kohn release
785
786 Necessary Improvements and Bug Fixes
787 ====================================
788
789 Necessary Improvements
790 ~~~~~~~~~~~~~~~~~~~~~~
791 | `POLICY-4045  <https://jira.onap.org/browse/POLICY-4045>`_ - R11: Software (non functional) improvements
792 |  `POLICY-3967  <https://jira.onap.org/browse/POLICY-3967>`_ - Create detailed grafana dashboards for each policy framework component
793 |  `POLICY-4168  <https://jira.onap.org/browse/POLICY-4168>`_ - Security vulnerability when unzipping csar on distribution
794 |  `POLICY-4169  <https://jira.onap.org/browse/POLICY-4169>`_ - Ensure all parameters in Helm Charts have default values
795 |  `POLICY-3860  <https://jira.onap.org/browse/POLICY-3860>`_ - Analyze and improve spring boot dependencies management in PF components
796 |  `POLICY-4207  <https://jira.onap.org/browse/POLICY-4207>`_ - Remove Jenkins jobs on Guilin branches
797 |  `POLICY-4228  <https://jira.onap.org/browse/POLICY-4228>`_ - Add Ramesh Murugan Iyer as a committer
798 |  `POLICY-4230  <https://jira.onap.org/browse/POLICY-4230>`_ - Update Weekly Meetings with status from daily scrums
799 |  `POLICY-4234  <https://jira.onap.org/browse/POLICY-4234>`_ - Fix CSITs on Honolulu/Istanbul/Jakarta branches
800 |  `POLICY-4242  <https://jira.onap.org/browse/POLICY-4242>`_ - PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR KOHN
801 |  `POLICY-4280  <https://jira.onap.org/browse/POLICY-4280>`_ - Upgrade mariadb driver to latest 2.x version in PDP-D, and APPS
802 |  `POLICY-4287  <https://jira.onap.org/browse/POLICY-4287>`_ - Update Docker Builds to allow for multiple architecture Docker Fille generation
803 |  `POLICY-4308  <https://jira.onap.org/browse/POLICY-4308>`_ - Unmaintained Repos
804 |  `POLICY-4354  <https://jira.onap.org/browse/POLICY-4354>`_ - Update INFO.yaml fine on all repos
805 |  `POLICY-4393  <https://jira.onap.org/browse/POLICY-4393>`_ - Update dependencies to remove security vulnerabilities
806
807 | `POLICY-4046  <https://jira.onap.org/browse/POLICY-4046>`_ - R11: Address technical debt left over from Previous Release
808 |  `POLICY-4093  <https://jira.onap.org/browse/POLICY-4093>`_ - Update spring vesion in oparent and remove override in policy/parent
809
810 Bug Fixes
811 ~~~~~~~~~
812 | `POLICY-4170  <https://jira.onap.org/browse/POLICY-4170>`_ - Fix k8s-ppnt cluster role binding name in OOM
813 | `POLICY-4186  <https://jira.onap.org/browse/POLICY-4186>`_ - Wrong versions of policy related jar in policy-xacml-pdp latest image
814 | `POLICY-4226  <https://jira.onap.org/browse/POLICY-4226>`_ - policy distribution cannot disable https to SDC
815 | `POLICY-4236  <https://jira.onap.org/browse/POLICY-4236>`_ - K8s participant marks the deployment failed if the deployment is initiated with a delay
816 | `POLICY-4238  <https://jira.onap.org/browse/POLICY-4238>`_ - CLAMP ACM docker image Java logging does not work
817 | `POLICY-4239  <https://jira.onap.org/browse/POLICY-4239>`_ - ACM commissioning fails with 404 error when deployed in CSIT docker
818 | `POLICY-4241  <https://jira.onap.org/browse/POLICY-4241>`_ - Participant update list in ACM is not populated with multiple AC elements
819 | `POLICY-4268  <https://jira.onap.org/browse/POLICY-4268>`_ - Logging directory mismatch for policy OOM components
820 | `POLICY-4269  <https://jira.onap.org/browse/POLICY-4269>`_ - Clamp Backend fails without AAF in Service Mesh
821 | `POLICY-4270  <https://jira.onap.org/browse/POLICY-4270>`_ - CSIT fails while executing CLAMP ACM test cases
822 | `POLICY-4274  <https://jira.onap.org/browse/POLICY-4274>`_ - XACML-PDP raw decision API serialization is incorrect
823 | `POLICY-4326  <https://jira.onap.org/browse/POLICY-4326>`_ - Look into Policy-Distribution grafana chart for negative heap memory
824 | `POLICY-4331  <https://jira.onap.org/browse/POLICY-4331>`_ - Policy-GUI Apex Broken Tests
825 | `POLICY-4339  <https://jira.onap.org/browse/POLICY-4339>`_ - Clamp build fails in policy participant module while processing policies without topology template
826 | `POLICY-4351  <https://jira.onap.org/browse/POLICY-4351>`_ - log of Element container is not visible at Standard Output
827 | `POLICY-4352  <https://jira.onap.org/browse/POLICY-4352>`_ - Lob type from jpa entities casting wrongly on postgres
828 | `POLICY-4353  <https://jira.onap.org/browse/POLICY-4353>`_ - JSON schema plugin is not working with multiple events mentioned in apex config with | separator
829 | `POLICY-4355  <https://jira.onap.org/browse/POLICY-4355>`_ - PodStatus Validator is failing to check if the pod is running in K8sParticipant
830
831 References
832 ==========
833
834 For more information on the ONAP Kohn release, please see:
835
836 #. `ONAP Home Page`_
837 #. `ONAP Documentation`_
838 #. `ONAP Release Downloads`_
839 #. `ONAP Wiki Page`_
840
841 .. _`ONAP Home Page`: https://www.onap.org
842 .. _`ONAP Wiki Page`: https://wiki.onap.org
843 .. _`ONAP Documentation`: https://docs.onap.org
844 .. _`ONAP Release Downloads`: https://git.onap.org
845
846 Quick Links:
847     - `POLICY project page`_
848     - `Passing Badge information for POLICY`_
849
850 ..      ==========================
851 ..      * * *    JAKARTA     * * *
852 ..      ==========================
853
854 Version: 10.0.0
855 ---------------
856
857 :Release Date: 2022-05-12 (Jakarta Release)
858
859 Artifacts released:
860
861 .. list-table::
862    :widths: 15 10 10
863    :header-rows: 1
864
865    * - Repository
866      - Java Artifact
867      - Docker Image (if applicable)
868    * - policy/parent
869      - 3.5.3
870      - N/A
871    * - policy/docker
872      - 2.4.3
873      - | policy-jre-alpine
874        | policy-jdk-alpine
875        | policy-db-migrator
876    * - policy/common
877      - 1.10.3
878      - N/A
879    * - policy/models
880      - 2.6.3
881      - N/A
882    * - policy/api
883      - 2.6.3
884      - policy-api
885    * - policy/pap
886      - 2.6.3
887      - policy-pap
888    * - policy/apex-pdp
889      - 2.7.3
890      - policy-apex-pdp
891    * - policy/drools-pdp
892      - 1.10.3
893      - policy-drools
894    * - policy/xacml-pdp
895      - 2.6.3
896      - policy-xacml-pdp
897    * - policy/distribution
898      - 2.7.3
899      - policy-distribution
900    * - policy/clamp
901      - 6.2.3
902      - | policy-clamp-backend
903        | policy-clamp-ac-pf-ppnt
904        | policy-clamp-ac-k8s-ppnt
905        | policy-clamp-ac-http-ppnt
906        | policy-clamp-runtime-acm'
907    * - policy/gui
908      - 2.2.3
909      - policy-gui
910    * - policy/drools-applications
911      - 1.10.3
912      - policy-pdpd-cl
913
914 Key Updates
915 ===========
916
917 * `REQ-994 <https://jira.onap.org/browse/REQ-994>`_ - Control Loop in TOSCA LCM Improvement
918   CLAMP (Control Loop Automation Management Platform) functionalities, moved to the Policy project in the Istanbul
919   release, provides a Control Loop Lifecycle management architecture. A control Loop is a key concept for Automation
920   and Assurance Use Cases and remains a top priority for ONAP as an automation platform butit is not the only possible
921   composition of components that is possible to combine to deliver functionality.
922
923   This work evolves the Control Loop LCM architecture to provide abstract Automation Composition
924   Management (ACM) logic with a generic Automation Composition definition, isolating Composition logic logic from ONAP
925   component logic. It elaborates APIs that allow integrate with other design systems as well as 3PP component integration.
926
927   The current PMSH and TCS control loops are migrated to use an Automation Composition approach. Support for Automation
928   Compositions in SDC is also introduced.
929
930 * Metadata Sets for Policy Types.
931
932   A Metadata set allows a global set of metadata containing rules or global parameters that all instances of a certain
933   policy type can use. Metadta sets are introduced in the Policy Framework in the Jakarta release. This means that
934   different rule set implementations can be associated with a policy type, which can be used in appropriate situations.
935
936 * Introduction of Prometheus for monitoring Policy components so that necessary alerts can be easily triggered and
937   possible outages can be avoided in production systems.
938
939   * Expose application level metrics in policy components. An end user can plug in a prometheus instance and start
940     listening to the metrics exposed by policy components and either raise alerts or show them on a Grafana dashboard
941     for operations team to keep monitoring the health of the system.
942
943   * Provide sample Grafana dashboards for policy metrics.
944
945 * Improve the policy/api and policy/pap readiness probes to handle database failures so that the policy/api and
946   policy/pap kubernetes pods are marked ready only if the policy database pod is ready.
947
948 * Migration of Policy Framework components to Springboot to support easier handling, configuration and maintenance.
949   The migrated components are policy/api, policy/pap, policy/clamp, and policy/gui.
950
951 * Enhanced healthchecks on drools pdp to report on stuck applications.  This together with enhanced liveness probes
952   self-heals the unresponsive pod in such condition by restarting it.
953
954 * Drools PDP has been upgraded to the latest available stable version: 7.68.0.Final.
955
956 * Extend CDS actor model to decouple VNF handling from the vFirewall use case.
957
958 * Policy Framework Database Configurability. Some of the components in the Policy Framework can be configured to use
959   any JDBC-compliant RDBMS and configuraiton files are supplied for the Postgres RDBMS. MariaDB remains the default
960   RDBMS for the Policy Framework in ONAP. Further testing will be carried out using Postgres in Kohn and future
961   releases.
962
963 * System Attribute Improvements
964     - Transaction boundaries on REST calls are implemented per REST call on applications migrated to Spring (policy/api,
965       policy/pap, and policy/clamp)
966     - JDBC backend uses Spring and Hibernate rather than Eclipselink
967     - All GUIs are now included in the policy/gui microservice
968     - Documentation is retionalized and cleaned up, testing documentation is now complete
969     - Scripts are added to make release of the Policy Framework easier
970
971 Known Limitations, Issues and Workarounds
972 =========================================
973
974 System Limitations
975 ~~~~~~~~~~~~~~~~~~
976 N/A
977
978 Known Vulnerabilities
979 ~~~~~~~~~~~~~~~~~~~~~
980 N/A
981
982 Workarounds
983 ~~~~~~~~~~~
984 N/A
985
986 Security Notes
987 ==============
988
989 | `POLICY-2744 <https://jira.onap.org/browse/POLICY-2744>`_ - Use an account other than healthcheck in API and PAP components for provisioning of policies
990 | `POLICY-3815 <https://jira.onap.org/browse/POLICY-3815>`_ - Use an account other than healthcheck in API and PAP components for provisioning of policies - OOM Charts
991 | `POLICY-3862 <https://jira.onap.org/browse/POLICY-3862>`_ - Check all code for Log4J before version 2.15.0 and upgrade if necessary
992 | `POLICY-4085 <https://jira.onap.org/browse/POLICY-4085>`_ - Remove usage of jackson libraries from clamp runtime
993
994
995 Functional Improvements
996 =======================
997 | `POLICY-1837 <https://jira.onap.org/browse/POLICY-1837>`_ - Review transaction boundaries of models
998 | `POLICY-2715 <https://jira.onap.org/browse/POLICY-2715>`_ - Allow underlying database to be configured: MariaDB or Postgres
999 | `POLICY-2952 <https://jira.onap.org/browse/POLICY-2952>`_ - R10: TOSCA Control Loop Design Time
1000 | `POLICY-2973 <https://jira.onap.org/browse/POLICY-2973>`_ - Build interaction between SDC and Design Time Catalogue
1001 | `POLICY-3034 <https://jira.onap.org/browse/POLICY-3034>`_ - Support statistics in PDP-X
1002 | `POLICY-3213 <https://jira.onap.org/browse/POLICY-3213>`_ - Persistence Policy Models using JPA/JDBC/Hibernate/MariaDB
1003 | `POLICY-3498 <https://jira.onap.org/browse/POLICY-3498>`_ - Provide API to retrieve policies deployed since a given time
1004 | `POLICY-3579 <https://jira.onap.org/browse/POLICY-3579>`_ - End to End Demo of PMSH usecase
1005 | `POLICY-3582 <https://jira.onap.org/browse/POLICY-3582>`_ - Uber Story: Cover the full scope of LCM for Control Loops: Server Side
1006 | `POLICY-3638 <https://jira.onap.org/browse/POLICY-3638>`_ - Change policy-gui so that all GUIs work in the same jar/JVM
1007 | `POLICY-3745 <https://jira.onap.org/browse/POLICY-3745>`_ - PDP-D: Upgrade drools to the latest 7.x release
1008 | `POLICY-3747 <https://jira.onap.org/browse/POLICY-3747>`_ - Support Readiness and Liveness probes on Control loop helm charts
1009 | `POLICY-3748 <https://jira.onap.org/browse/POLICY-3748>`_ - Enable cluster admin role for k8s participant helm chart in OOM
1010 | `POLICY-3750 <https://jira.onap.org/browse/POLICY-3750>`_ - R10: Improve runtime monitoring capabilities in policy components
1011 | `POLICY-3753 <https://jira.onap.org/browse/POLICY-3753>`_ - Migrate policy-api component to spring boot
1012 | `POLICY-3754 <https://jira.onap.org/browse/POLICY-3754>`_ - Migrate policy-pap component to spring boot
1013 | `POLICY-3755 <https://jira.onap.org/browse/POLICY-3755>`_ - Create a list of application metrics to be exposed in policy framework components
1014 | `POLICY-3756 <https://jira.onap.org/browse/POLICY-3756>`_ - Expose application level metrics in policy-api
1015 | `POLICY-3757 <https://jira.onap.org/browse/POLICY-3757>`_ - Expose application level metrics in policy-pap
1016 | `POLICY-3759 <https://jira.onap.org/browse/POLICY-3759>`_ - Expose application level metrics in policy-distribution
1017 | `POLICY-3760 <https://jira.onap.org/browse/POLICY-3760>`_ - Expose application level metrics in apex-pdp
1018 | `POLICY-3761 <https://jira.onap.org/browse/POLICY-3761>`_ - Expose application level metrics in drools-pdp
1019 | `POLICY-3763 <https://jira.onap.org/browse/POLICY-3763>`_ - Improve policy-api & policy-pap readiness probes to handle db failures
1020 | `POLICY-3777 <https://jira.onap.org/browse/POLICY-3777>`_ - R10: Control Loop in TOSCA LCM improvement
1021 | `POLICY-3781 <https://jira.onap.org/browse/POLICY-3781>`_ - R10: Policy Framework Database Configurability
1022 | `POLICY-3808 <https://jira.onap.org/browse/POLICY-3808>`_ - Commission a Control Loop Type from a Control Loop Type package/service
1023 | `POLICY-3816 <https://jira.onap.org/browse/POLICY-3816>`_ - Support Policy Type Metadata Sets in Policy Framework
1024 | `POLICY-3823 <https://jira.onap.org/browse/POLICY-3823>`_ - Proof of concept of Controlloop design time with SDC
1025 | `POLICY-3835 <https://jira.onap.org/browse/POLICY-3835>`_ - Write scripts to make release of the Policy Framework easier
1026 | `POLICY-3839 <https://jira.onap.org/browse/POLICY-3839>`_ - Migrate controlloop runtime from Eclipselink to Hibernate
1027 | `POLICY-3865 <https://jira.onap.org/browse/POLICY-3865>`_ - PDP-D APPS: extend CDS actor VNF operations support
1028 | `POLICY-3870 <https://jira.onap.org/browse/POLICY-3870>`_ - Add Controlloop design-time components to SDC
1029 | `POLICY-3886 <https://jira.onap.org/browse/POLICY-3886>`_ - Create basic installation & setup for prometheus & grafana
1030 | `POLICY-3889 <https://jira.onap.org/browse/POLICY-3889>`_ - Implement TCS Control Loops using a TOSCA appraoch
1031 | `POLICY-3892 <https://jira.onap.org/browse/POLICY-3892>`_ - Create basic grafana dashboards for monitoring policy framework components
1032 | `POLICY-3896 <https://jira.onap.org/browse/POLICY-3896>`_ - Change Apex Editor to use Spring Boot
1033 | `POLICY-3902 <https://jira.onap.org/browse/POLICY-3902>`_ - Extend PDP-X statistics endpoint to support per application metrics
1034 | `POLICY-3921 <https://jira.onap.org/browse/POLICY-3921>`_ - Align TOSCA Control Loop with Automation Composition
1035 | `POLICY-3938 <https://jira.onap.org/browse/POLICY-3938>`_ - Rename CLAMP "TOSCA Control Loop" feature to CLAMP "Automation Composition Management"
1036 | `POLICY-4040 <https://jira.onap.org/browse/POLICY-4040>`_ - Enable prometheus monitoring on drools-pdp charts
1037
1038 Necessary Improvements and Bug Fixes
1039 ====================================
1040
1041 Necessary Improvements
1042 ~~~~~~~~~~~~~~~~~~~~~~
1043 | `POLICY-1820 <https://jira.onap.org/browse/POLICY-1820>`_ - Transfer APEX model to use policy-models
1044 | `POLICY-2086 <https://jira.onap.org/browse/POLICY-2086>`_ - Remove references to mariadb from resource files
1045 | `POLICY-2587 <https://jira.onap.org/browse/POLICY-2587>`_ - CLC target locking behavior needs to be by-passed for CLC to be effective
1046 | `POLICY-2588 <https://jira.onap.org/browse/POLICY-2588>`_ - Target Locking Implementations should be configurable
1047 | `POLICY-2683 <https://jira.onap.org/browse/POLICY-2683>`_ - REQ-443  improve its CII Badging score by improving input validation and documenting it in their CII Badging site.
1048 | `POLICY-3076 <https://jira.onap.org/browse/POLICY-3076>`_ - Improve code coverage in policy framework repos
1049 | `POLICY-3259 <https://jira.onap.org/browse/POLICY-3259>`_ - Components should not crash at start-up due to dmaap issues
1050 | `POLICY-3269 <https://jira.onap.org/browse/POLICY-3269>`_ - Allow policy to disable guard check in drools-apps
1051 | `POLICY-3358 <https://jira.onap.org/browse/POLICY-3358>`_ - Remove Clamp GUI from Clamp Repo
1052 | `POLICY-3380 <https://jira.onap.org/browse/POLICY-3380>`_ - Archive onap/clamp and remove any jenkins jobs
1053 | `POLICY-3386 <https://jira.onap.org/browse/POLICY-3386>`_ - PDP-D: better liveness checks to recover from stuck sessions
1054 | `POLICY-3540 <https://jira.onap.org/browse/POLICY-3540>`_ - Refactor Participant Interfaces and Tests
1055 | `POLICY-3708 <https://jira.onap.org/browse/POLICY-3708>`_ - Improve Documentation for Jakarta Release
1056 | `POLICY-3710 <https://jira.onap.org/browse/POLICY-3710>`_ - Tidy up the Policy Framework documentation
1057 | `POLICY-3791 <https://jira.onap.org/browse/POLICY-3791>`_ - sphinx-build warnings in policy parent docs
1058 | `POLICY-3804 <https://jira.onap.org/browse/POLICY-3804>`_ - Add gui-clamp coverage info to sonar
1059 | `POLICY-3866 <https://jira.onap.org/browse/POLICY-3866>`_ - Tidy up Policy Framework Documentation
1060 | `POLICY-3885 <https://jira.onap.org/browse/POLICY-3885>`_ - Document metadataSet usage in policy documentation
1061 | `POLICY-3895 <https://jira.onap.org/browse/POLICY-3895>`_ - Improve drools pdp and drools apps logging
1062 | `POLICY-3920 <https://jira.onap.org/browse/POLICY-3920>`_ - Write a User Guide for TOSCA Control Loops in CLAMP
1063 | `POLICY-3927 <https://jira.onap.org/browse/POLICY-3927>`_ - Remove Unused maven dependencies in apex-editor
1064 | `POLICY-3928 <https://jira.onap.org/browse/POLICY-3928>`_ - Remove Unused test resources in apex-editor
1065 | `POLICY-3977 <https://jira.onap.org/browse/POLICY-3977>`_ - PDP-D: enhanced healthchecks for monitoring subcomponents
1066 | `POLICY-3979 <https://jira.onap.org/browse/POLICY-3979>`_ - PDP-D + APPS: investigate configuration to use MySql instead of MariaDB
1067
1068 Bug Fixes
1069 ~~~~~~~~~
1070 | `POLICY-3153 <https://jira.onap.org/browse/POLICY-3153>`_ - Fix Db connection issues in TOSCA control loop
1071 | `POLICY-3589 <https://jira.onap.org/browse/POLICY-3589>`_ - Http participant unable to resolve Intermediary config during startup
1072 | `POLICY-3743 <https://jira.onap.org/browse/POLICY-3743>`_ - APEX-PDP RestClient reports failure when response code!=200
1073 | `POLICY-3749 <https://jira.onap.org/browse/POLICY-3749>`_ - Drools CSITs failing due to version related problem
1074 | `POLICY-3780 <https://jira.onap.org/browse/POLICY-3780>`_ - Update endpoints in xacml-pdp jmx files
1075 | `POLICY-3794 <https://jira.onap.org/browse/POLICY-3794>`_ - Cannot create a new APEX policy on Policy Editor
1076 | `POLICY-3831 <https://jira.onap.org/browse/POLICY-3831>`_ - Camel Integration Tests Failing
1077 | `POLICY-3871 <https://jira.onap.org/browse/POLICY-3871>`_ - Fix issues in existing entity classes in policy-models
1078 | `POLICY-3893 <https://jira.onap.org/browse/POLICY-3893>`_ - apex-pdp intermittent error in build
1079 | `POLICY-3897 <https://jira.onap.org/browse/POLICY-3897>`_ - Fix issue with usage of GeneratedValue in PfGeneratedIdKey
1080 | `POLICY-3905 <https://jira.onap.org/browse/POLICY-3905>`_ - drools pdp merge job failing
1081 | `POLICY-3913 <https://jira.onap.org/browse/POLICY-3913>`_ - Fix issue where some metrics are lost in spring boot
1082 | `POLICY-3914 <https://jira.onap.org/browse/POLICY-3914>`_ - Fix spring configuration for pap csit
1083 | `POLICY-3929 <https://jira.onap.org/browse/POLICY-3929>`_ - Race condition in apex-editor model upload
1084 | `POLICY-3933 <https://jira.onap.org/browse/POLICY-3933>`_ - CLAMP CSIT failing with HTTP 401 unauthorized for URL error
1085 | `POLICY-3978 <https://jira.onap.org/browse/POLICY-3978>`_ - Changing default append on instance name
1086 | `POLICY-3983 <https://jira.onap.org/browse/POLICY-3983>`_ - Policy-API is not using the mounted logback.xml file
1087 | `POLICY-4030 <https://jira.onap.org/browse/POLICY-4030>`_ - PAP/API healthcheck response code not in line with the actual health report
1088 | `POLICY-4039 <https://jira.onap.org/browse/POLICY-4039>`_ - Fix configuration issues causing automation composition issues
1089 | `POLICY-4041 <https://jira.onap.org/browse/POLICY-4041>`_ - Duplicate log entries in policy-gui
1090 | `POLICY-4043 <https://jira.onap.org/browse/POLICY-4043>`_ - Batch deploy/undeploy operations incrementing corresponding apex counter by only 1
1091 | `POLICY-4044 <https://jira.onap.org/browse/POLICY-4044>`_ - APEX-PDP engine metrics remain 0 even after execution of events
1092 | `POLICY-4068 <https://jira.onap.org/browse/POLICY-4068>`_ - PAP consolidated healthcheck returning report with empty url for PAP
1093 | `POLICY-4087 <https://jira.onap.org/browse/POLICY-4087>`_ - Inconsistent behaviour in APEX when PDP STATE changed to PASSIVE and then ACTIVE
1094 | `POLICY-4088 <https://jira.onap.org/browse/POLICY-4088>`_ - PAP shows incorrect deployments counter on parallel deploy/undeploy
1095 | `POLICY-4092 <https://jira.onap.org/browse/POLICY-4092>`_ - Modify Nssi Closed Loop Error
1096 | `POLICY-4095 <https://jira.onap.org/browse/POLICY-4095>`_ - Failures on Daily Master tests onap-policy-clamp-runtime-acm
1097 | `POLICY-4096 <https://jira.onap.org/browse/POLICY-4096>`_ - Policy deployment fails if prometheus operator is not installed
1098 | `POLICY-4104 <https://jira.onap.org/browse/POLICY-4104>`_ - Issue when serialization into JSON Object which brings allot of garbage
1099 | `POLICY-4106 <https://jira.onap.org/browse/POLICY-4106>`_ - PDP-D APPS: Network Slicing: incorrect SO operation
1100
1101 References
1102 ==========
1103
1104 For more information on the ONAP Jakarta release, please see:
1105
1106 #. `ONAP Home Page`_
1107 #. `ONAP Documentation`_
1108 #. `ONAP Release Downloads`_
1109 #. `ONAP Wiki Page`_
1110
1111 .. _`ONAP Home Page`: https://www.onap.org
1112 .. _`ONAP Wiki Page`: https://wiki.onap.org
1113 .. _`ONAP Documentation`: https://docs.onap.org
1114 .. _`ONAP Release Downloads`: https://git.onap.org
1115
1116 Quick Links:
1117     - `POLICY project page`_
1118     - `Passing Badge information for POLICY`_
1119
1120 ..      ==========================
1121 ..      * * *    ISTANBUL    * * *
1122 ..      ==========================
1123
1124 Version: 9.0.1
1125 --------------
1126
1127 :Release Date: 2022-02-17 (Istanbul Maintenance Release #1)
1128
1129 **Artifacts**
1130
1131 Artifacts released:
1132
1133 .. list-table::
1134    :widths: 15 10 10
1135    :header-rows: 1
1136
1137    * - Repository
1138      - Java Artifact
1139      - Docker Image (if applicable)
1140    * - policy/parent
1141      - 3.4.4
1142      - N/A
1143    * - policy/docker
1144      - 2.3.2
1145      - | onap/policy-jdk-alpine:2.3.2
1146        | onap/policy-jre-alpine:2.3.2
1147        | onap/policy-db-migrator:2.3.2
1148    * - policy/common
1149      - 1.9.2
1150      - N/A
1151    * - policy/models
1152      - 2.5.2
1153      - N/A
1154    * - policy/api
1155      - 2.5.2
1156      - onap/policy-api:2.5.2
1157    * - policy/pap
1158      - 2.5.2
1159      - onap/policy-pap:2.5.2
1160    * - policy/drools-pdp
1161      - 1.9.2
1162      - onap/policy-drools:1.9.2
1163    * - policy/apex-pdp
1164      - 2.6.2
1165      - onap/policy-apex-pdp:2.6.2
1166    * - policy/xacml-pdp
1167      - 2.5.2
1168      - onap/policy-xacml-pdp:2.5.2
1169    * - policy/drools-applications
1170      - 1.9.2
1171      - onap/policy-pdpd-cl:1.9.2
1172    * - policy/clamp
1173      - 6.1.4
1174      - | onap/policy-clamp-backend:6.1.4
1175        | onap/policy-clamp-frontend:6.1.4
1176        | onap/policy-clamp-cl-pf-ppnt:6.1.4
1177        | onap/policy-clamp-cl-k8s-ppnt:6.1.4
1178        | onap/policy-clamp-cl-http-ppnt:6.1.4
1179        | onap/policy-clamp-cl-runtime:6.1.4
1180    * - policy/gui
1181      - 2.1.2
1182      - onap/policy-gui:2.1.2
1183    * - policy/distribution
1184      - 2.6.2
1185      - onap/policy-distribution:2.6.2
1186
1187 **Bug Fixes and Necessary Enhancements**
1188
1189     * `[POLICY-3862] <https://jira.onap.org/browse/POLICY-3862>`_
1190       - Check all code for Log4J before version 2.15.0 and upgrade if necessary
1191
1192 Version: 9.0.0
1193 --------------
1194
1195 :Release Date: 2021-11-04 (Istanbul Release)
1196
1197 New features
1198 ============
1199
1200 Artifacts released:
1201
1202 .. list-table::
1203    :widths: 15 10 10
1204    :header-rows: 1
1205
1206    * - Repository
1207      - Java Artifact
1208      - Docker Image (if applicable)
1209    * - policy/parent
1210      - 3.4.3
1211      - N/A
1212    * - policy/docker
1213      - 2.3.1
1214      - | onap/policy-jdk-alpine:2.3.1
1215        | onap/policy-jre-alpine:2.3.1
1216        | onap/policy-db-migrator:2.3.1
1217    * - policy/common
1218      - 1.9.1
1219      - N/A
1220    * - policy/models
1221      - 2.5.1
1222      - N/A
1223    * - policy/api
1224      - 2.5.1
1225      - onap/policy-api:2.5.1
1226    * - policy/pap
1227      - 2.5.1
1228      - onap/policy-pap:2.5.1
1229    * - policy/drools-pdp
1230      - 1.9.1
1231      - onap/policy-drools:1.9.1
1232    * - policy/apex-pdp
1233      - 2.6.1
1234      - onap/policy-apex-pdp:2.6.1
1235    * - policy/xacml-pdp
1236      - 2.5.1
1237      - onap/policy-xacml-pdp:2.5.1
1238    * - policy/drools-applications
1239      - 1.9.1
1240      - onap/policy-pdpd-cl:1.9.1
1241    * - policy/clamp
1242      - 6.1.3
1243      - | onap/policy-clamp-backend:6.1.3
1244        | onap/policy-clamp-frontend:6.1.3
1245        | onap/policy-clamp-cl-pf-ppnt:6.1.3
1246        | onap/policy-clamp-cl-k8s-ppnt:6.1.3
1247        | onap/policy-clamp-cl-http-ppnt:6.1.3
1248        | onap/policy-clamp-cl-runtime:6.1.3
1249    * - policy/gui
1250      - 2.1.1
1251      - onap/policy-gui:2.1.1
1252    * - policy/distribution
1253      - 2.6.1
1254      - onap/policy-distribution:2.6.1
1255
1256 Key Updates
1257 ===========
1258
1259 Clamp -> policy
1260 Control Loop
1261 Database
1262
1263 * `REQ-684 <https://jira.onap.org/browse/REQ-684>`_ - Merge CLAMP functionality into Policy Framework project
1264     - keep CLAMP functions into ONAP
1265     - reduce ONAP footprint
1266     - consolidate the UI (Control loop UI and policy)
1267     - enables code sharing and common handling for REST and TOSCA
1268     - introduces the Spring Framework into the Policy Framework
1269     - see `the CLAMP documentation <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp.html>`_
1270
1271 * `REQ-716 <https://jira.onap.org/browse/REQ-716>`_ - Control Loop in TOSCA LCM
1272    - Allows Control Loops to be defined and described in Metadata using TOSCA
1273    - Control loops can run on the fly on any component that implements a *participant* API
1274    - Control Loops can be commissioned into Policy/CLAMP, they can be parameterized, initiated on arbitrary
1275      participants, activated and monitored
1276    - See `the CLAMP TOSCA Control Loop documentation
1277      <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp.html>`_
1278
1279 * CLAMP Client Policy and TOSCA Handling
1280     - Push existing policy(tree) into pdp
1281     - Handling of PDP Groups
1282     - Handling of Policy Types
1283     - Handling of TOSCA Service Templates
1284     - Push of Policies to PDPs
1285     - Support multiple PDP Groups per Policy Type
1286     - Tree view in Policies list
1287     - Integration of new TOSCA Control Loop GUI into CLAMP GUI
1288
1289 * Policy Handling Improvements
1290     - Support delta policies in PDPs
1291     - Allow XACML rules to specify EventManagerService
1292     - Sending of notifications to Kafka & Rest in apex-pdp policies
1293     - External configuration of groups other than defaultGroup
1294     - XACML Decision support for Multiple Requests
1295     - Updated query parameter names and support for wildcards in APIs
1296     - Added new APIs for Policy Audit capabilities
1297     - Capability to send multiple output events from a state in APEX-PDP
1298
1299 * System Attribute Improvements
1300     - Support for upgrade and rollback, starting with upgrade from the Honolulu release to the Istanbul release
1301     - Consolidated health check
1302     - Phase 1 of Spring Framework introduction
1303     - Phase 1 of Prometheus introduction, base Prometheus metrics
1304
1305 Known Limitations, Issues and Workarounds
1306 =========================================
1307
1308 System Limitations
1309 ~~~~~~~~~~~~~~~~~~
1310 N/A
1311
1312 Known Vulnerabilities
1313 ~~~~~~~~~~~~~~~~~~~~~
1314 N/A
1315
1316 Workarounds
1317 ~~~~~~~~~~~
1318 N/A
1319
1320 Security Notes
1321 ==============
1322
1323 | `POLICY-3169 <https://jira.onap.org/browse/POLICY-3169>`_ - Remove security issues reported by NEXUS-IQ
1324 | `POLICY-3315 <https://jira.onap.org/browse/POLICY-3315>`_ - Review license scan issues
1325 | `POLICY-3327 <https://jira.onap.org/browse/POLICY-3327>`_ - OOM AAF generated certificates contain invalid SANs entries
1326 | `POLICY-3338 <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
1327 | `POLICY-3384 <https://jira.onap.org/browse/POLICY-3384>`_ - Use signed certificates in the CSITs
1328 | `POLICY-3431 <https://jira.onap.org/browse/POLICY-3431>`_ - Review license scan issues
1329 | `POLICY-3516 <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
1330 | `POLICY-3590 <https://jira.onap.org/browse/POLICY-3590>`_ - Address security vulnerabilities and License issues in Policy Framework
1331 | `POLICY-3697 <https://jira.onap.org/browse/POLICY-3697>`_ - Review license scan issues
1332
1333
1334 Functional Improvements
1335 =======================
1336 | `REQ-684 <https://jira.onap.org/browse/REQ-684>`_ - Merge CLAMP functionality into Policy Framework project
1337 | `REQ-716 <https://jira.onap.org/browse/REQ-716>`_ - Control Loop in TOSCA LCM
1338 | `POLICY-1787 <https://jira.onap.org/browse/POLICY-1787>`_ - Support mariadb upgrade/rollback functionality
1339 | `POLICY-2535 <https://jira.onap.org/browse/POLICY-2535>`_ - Query deployed policies by regex on the name, for a given policy type
1340 | `POLICY-2618 <https://jira.onap.org/browse/POLICY-2618>`_ - PDP-D make legacy configuration interface (used by brmsgw) an optional feature
1341 | `POLICY-2769 <https://jira.onap.org/browse/POLICY-2769>`_ - Support multiple PAP instances
1342 | `POLICY-2865 <https://jira.onap.org/browse/POLICY-2865>`_ - Add support and documentation on how an application can control what info is returned in Decision API
1343 | `POLICY-2896 <https://jira.onap.org/browse/POLICY-2896>`_ - Improve consolidated health check to include dependencies
1344 | `POLICY-2920 <https://jira.onap.org/browse/POLICY-2920>`_ - policy-clamp ui is capable to push and existing policy(tree) into pdp
1345 | `POLICY-2921 <https://jira.onap.org/browse/POLICY-2921>`_ - use the policy-clamp ui to manage pdp groups
1346 | `POLICY-2923 <https://jira.onap.org/browse/POLICY-2923>`_ - use the policy-clamp ui to manage policy types
1347 | `POLICY-2930 <https://jira.onap.org/browse/POLICY-2930>`_ - clamp-backend rest api to push policies to pdp
1348 | `POLICY-2931 <https://jira.onap.org/browse/POLICY-2931>`_ - clamp GUI to push policy to pdp
1349 | `POLICY-3072 <https://jira.onap.org/browse/POLICY-3072>`_ - clamp ui support multiple pdp group per policy type
1350 | `POLICY-3107 <https://jira.onap.org/browse/POLICY-3107>`_ - Support delta policies in PDPs
1351 | `POLICY-3165 <https://jira.onap.org/browse/POLICY-3165>`_ - Implement tree view in policies list
1352 | `POLICY-3209 <https://jira.onap.org/browse/POLICY-3209>`_ - CLAMP Component Lifecycle Management using Spring Framework
1353 | `POLICY-3218 <https://jira.onap.org/browse/POLICY-3218>`_ - Integrate CLAMP GUIs (Instantiation/Monitoring) in the policy-gui repo
1354 | `POLICY-3227 <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
1355 | `POLICY-3228 <https://jira.onap.org/browse/POLICY-3228>`_ - Implement clamp backend part to add policy models api
1356 | `POLICY-3229 <https://jira.onap.org/browse/POLICY-3229>`_ - Implement the front end part to add tosca model
1357 | `POLICY-3230 <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
1358 | `POLICY-3260 <https://jira.onap.org/browse/POLICY-3260>`_ - Allow rules to specify EventManagerService
1359 | `POLICY-3324 <https://jira.onap.org/browse/POLICY-3324>`_ - Design a solution for sending notifications to Kafka & Rest in apex-pdp policies
1360 | `POLICY-3331 <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
1361 | `POLICY-3340 <https://jira.onap.org/browse/POLICY-3340>`_ - Create REST API's in PAP to fetch the audit information stored in DB
1362 | `POLICY-3514 <https://jira.onap.org/browse/POLICY-3514>`_ - XACML Decision support for Multiple Requests
1363 | `POLICY-3524 <https://jira.onap.org/browse/POLICY-3524>`_ - Explore options to integrate prometheus with policy framework components
1364 | `POLICY-3527 <https://jira.onap.org/browse/POLICY-3527>`_ - Update query parameter names in policy audit api's
1365 | `POLICY-3533 <https://jira.onap.org/browse/POLICY-3533>`_ - PDP-D: make DB port provisionable
1366 | `POLICY-3538 <https://jira.onap.org/browse/POLICY-3538>`_ - Export basic metrics from policy components for prometheus
1367 | `POLICY-3545 <https://jira.onap.org/browse/POLICY-3545>`_ - Use generic create policy url in policy/distribution
1368 | `POLICY-3557 <https://jira.onap.org/browse/POLICY-3557>`_ - Export basic prometheus metrics from clamp
1369
1370 Necessary Improvements and Bug Fixes
1371 ====================================
1372
1373 Necessary Improvements
1374 ~~~~~~~~~~~~~~~~~~~~~~
1375 | `POLICY-2418 <https://jira.onap.org/browse/POLICY-2418>`_ - Refactor XACML PDP POJO's into Bean objects in order to perform validation more simply
1376 | `POLICY-2429 <https://jira.onap.org/browse/POLICY-2429>`_ - Mark policy/engine read-only and remove ci-management jobs for it
1377 | `POLICY-2542 <https://jira.onap.org/browse/POLICY-2542>`_ - Improve the REST parameter validation for PAP api's
1378 | `POLICY-2767 <https://jira.onap.org/browse/POLICY-2767>`_ - Improve error handling of drools-pdp when requestID in onset is not valid UUID
1379 | `POLICY-2899 <https://jira.onap.org/browse/POLICY-2899>`_ - Store basic audit details of deploy/undeploy operations in PAP
1380 | `POLICY-2996 <https://jira.onap.org/browse/POLICY-2996>`_ - Address technical debt left over from Honolulu
1381 | `POLICY-3059 <https://jira.onap.org/browse/POLICY-3059>`_ - Fix name of target-database property in persistence.xml files
1382 | `POLICY-3062 <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
1383 | `POLICY-3078 <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
1384 | `POLICY-3087 <https://jira.onap.org/browse/POLICY-3087>`_ - Use sl4fj instead of EELFLogger
1385 | `POLICY-3089 <https://jira.onap.org/browse/POLICY-3089>`_ - Cleanup logs for success/failure consumers in apex-pdp
1386 | `POLICY-3096 <https://jira.onap.org/browse/POLICY-3096>`_ - Fix intermittent test failures in APEX
1387 | `POLICY-3128 <https://jira.onap.org/browse/POLICY-3128>`_ - Use command command-line handler across policy repos
1388 | `POLICY-3129 <https://jira.onap.org/browse/POLICY-3129>`_ - Refactor command-line handling across policy-repos
1389 | `POLICY-3132 <https://jira.onap.org/browse/POLICY-3132>`_ - Apex-pdp documentation refers to missing logos.png
1390 | `POLICY-3134 <https://jira.onap.org/browse/POLICY-3134>`_ - Use base image for policy-jdk docker images
1391 | `POLICY-3136 <https://jira.onap.org/browse/POLICY-3136>`_ - Ignore jacoco and checkstyle when in eclipse
1392 | `POLICY-3143 <https://jira.onap.org/browse/POLICY-3143>`_ - Remove keystore files from policy repos
1393 | `POLICY-3145 <https://jira.onap.org/browse/POLICY-3145>`_ - HTTPS clients should not allow self-signed certificates
1394 | `POLICY-3147 <https://jira.onap.org/browse/POLICY-3147>`_ - Xacml-pdp should not use RestServerParameters for client parameters
1395 | `POLICY-3155 <https://jira.onap.org/browse/POLICY-3155>`_ - Use python3 for CSITs
1396 | `POLICY-3160 <https://jira.onap.org/browse/POLICY-3160>`_ - Use "sh" instead of "ash" where possible
1397 | `POLICY-3163 <https://jira.onap.org/browse/POLICY-3163>`_ - Remove spaces from xacml file name
1398 | `POLICY-3166 <https://jira.onap.org/browse/POLICY-3166>`_ - Use newer onap base image in clamp
1399 | `POLICY-3171 <https://jira.onap.org/browse/POLICY-3171>`_ - Fix sporadic error in models provider junits
1400 | `POLICY-3175 <https://jira.onap.org/browse/POLICY-3175>`_ - Minor clean-up of drools-apps
1401 | `POLICY-3182 <https://jira.onap.org/browse/POLICY-3182>`_ - Update npm repo
1402 | `POLICY-3189 <https://jira.onap.org/browse/POLICY-3189>`_ - Create a new key class which uses the @GeneratedValue annotation
1403 | `POLICY-3190 <https://jira.onap.org/browse/POLICY-3190>`_ - Investigate handling of context albums in Apex-PDP for failure responses (ex - AAI)
1404 | `POLICY-3198 <https://jira.onap.org/browse/POLICY-3198>`_ - Remove VirtualControlLoopEvent from OperationsHistory classes
1405 | `POLICY-3211 <https://jira.onap.org/browse/POLICY-3211>`_ - Parameter Handling and Parameter Validation
1406 | `POLICY-3214 <https://jira.onap.org/browse/POLICY-3214>`_ - Change Monitoring UI implementation to use React
1407 | `POLICY-3215 <https://jira.onap.org/browse/POLICY-3215>`_ - Update CLAMP Module structure to Multi Module Maven approach
1408 | `POLICY-3221 <https://jira.onap.org/browse/POLICY-3221>`_ - wrong lifecycle state information in INFO.yaml for policy/clamp
1409 | `POLICY-3222 <https://jira.onap.org/browse/POLICY-3222>`_ - Use existing clamp gui to set the parameters during CL instantiation
1410 | `POLICY-3235 <https://jira.onap.org/browse/POLICY-3235>`_ - gui-editor-apex fails to start
1411 | `POLICY-3257 <https://jira.onap.org/browse/POLICY-3257>`_ - Update csit test cases to include policy status & statistics api's
1412 | `POLICY-3261 <https://jira.onap.org/browse/POLICY-3261>`_ - Rules need a way to release locks
1413 | `POLICY-3262 <https://jira.onap.org/browse/POLICY-3262>`_ - Extract more common code from UsecasesEventManager
1414 | `POLICY-3292 <https://jira.onap.org/browse/POLICY-3292>`_ - Update the XACML PDP Tutorial docker compose files to point to release Honolulu images
1415 | `POLICY-3298 <https://jira.onap.org/browse/POLICY-3298>`_ - Add key names to IndexedXxx factory class toString() methods
1416 | `POLICY-3299 <https://jira.onap.org/browse/POLICY-3299>`_ - Merge policy CSITs into docker/csit
1417 | `POLICY-3300 <https://jira.onap.org/browse/POLICY-3300>`_ - PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR ISTANBUL
1418 | `POLICY-3303 <https://jira.onap.org/browse/POLICY-3303>`_ - Update the default logback.xml in APEX to log to STDOUT
1419 | `POLICY-3305 <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
1420 | `POLICY-3306 <https://jira.onap.org/browse/POLICY-3306>`_ - Fix issue where apex-pdp test is failing in gitlab
1421 | `POLICY-3307 <https://jira.onap.org/browse/POLICY-3307>`_ - Turn off frankfurt CSITs
1422 | `POLICY-3333 <https://jira.onap.org/browse/POLICY-3333>`_ - bean validator should use SerializedName
1423 | `POLICY-3336 <https://jira.onap.org/browse/POLICY-3336>`_ - APEX CLI/Model: multiple outputs for nextState NULL
1424 | `POLICY-3337 <https://jira.onap.org/browse/POLICY-3337>`_ - Move clamp documentation to policy/parent
1425 | `POLICY-3366 <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
1426 | `POLICY-3367 <https://jira.onap.org/browse/POLICY-3367>`_ - oom: policy-clamp-create-tables.sql: add IF NOT EXISTS clauses
1427 | `POLICY-3374 <https://jira.onap.org/browse/POLICY-3374>`_ - Docker registry should be defined in the parent pom
1428 | `POLICY-3378 <https://jira.onap.org/browse/POLICY-3378>`_ - Move groovy scripts to separate/common file
1429 | `POLICY-3382 <https://jira.onap.org/browse/POLICY-3382>`_ - Create document for policy chaining in drools-pdp
1430 | `POLICY-3383 <https://jira.onap.org/browse/POLICY-3383>`_ - Standardize policy deployment vs undeployment count in PdpStatistics
1431 | `POLICY-3388 <https://jira.onap.org/browse/POLICY-3388>`_ - policy/gui merge jobs failing
1432 | `POLICY-3389 <https://jira.onap.org/browse/POLICY-3389>`_ - Use lombok annotations instead of hashCode, equals, toString, get, set
1433 | `POLICY-3404 <https://jira.onap.org/browse/POLICY-3404>`_ - Rolling DB errors in log output for API, PAP, and DB components
1434 | `POLICY-3419 <https://jira.onap.org/browse/POLICY-3419>`_ - Remove operationshistory10 DB
1435 | `POLICY-3450 <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
1436 | `POLICY-3456 <https://jira.onap.org/browse/POLICY-3456>`_ - Use new RestClientParameters class instead of BusTopicParams
1437 | `POLICY-3457 <https://jira.onap.org/browse/POLICY-3457>`_ - Topic source should not go into fast-fail loop when dmaap is unreachable
1438 | `POLICY-3459 <https://jira.onap.org/browse/POLICY-3459>`_ - Document how to turn off collection of PdpStatistics
1439 | `POLICY-3473 <https://jira.onap.org/browse/POLICY-3473>`_ - CSIT for xacml doesn't check dmaap msg status
1440 | `POLICY-3474 <https://jira.onap.org/browse/POLICY-3474>`_ - Delete extra simulators from policy-models
1441 | `POLICY-3486 <https://jira.onap.org/browse/POLICY-3486>`_ - policy-jdk docker image should have at least one up to date image
1442 | `POLICY-3499 <https://jira.onap.org/browse/POLICY-3499>`_ - Improve Apex-PDP logs to avoid printing errors for irrelevant events in multiple policy deployment
1443 | `POLICY-3501 <https://jira.onap.org/browse/POLICY-3501>`_ - Refactor guard actor
1444 | `POLICY-3511 <https://jira.onap.org/browse/POLICY-3511>`_ - Limit statistics record count
1445 | `POLICY-3525 <https://jira.onap.org/browse/POLICY-3525>`_ - Improve policy/pap csit automation test cases
1446 | `POLICY-3528 <https://jira.onap.org/browse/POLICY-3528>`_ - Update documents & postman collection for pdp statistics api's
1447 | `POLICY-3531 <https://jira.onap.org/browse/POLICY-3531>`_ - PDP-X: initialization delays causes liveness checks to be missed under OOM deployment
1448 | `POLICY-3532 <https://jira.onap.org/browse/POLICY-3532>`_ - Add Honolulu Maintenance Release notes to read-the-docs
1449 | `POLICY-3539 <https://jira.onap.org/browse/POLICY-3539>`_ - Use RestServer from policy/common in apex-pdp
1450 | `POLICY-3547 <https://jira.onap.org/browse/POLICY-3547>`_ - METADATA tables for policy/docker db-migrator should be different than counterpart in policy/drools-pdp seed
1451 | `POLICY-3556 <https://jira.onap.org/browse/POLICY-3556>`_ - Document xacml REST server limitations
1452 | `POLICY-3605 <https://jira.onap.org/browse/POLICY-3605>`_ - Enhance dmaap simulator to support ""/topics" endpoint
1453 | `POLICY-3609 <https://jira.onap.org/browse/POLICY-3609>`_ - Add CSIT test case for policy consolidated health check
1454
1455 Bug Fixes
1456 ~~~~~~~~~
1457 | `POLICY-2845 <https://jira.onap.org/browse/POLICY-2845>`_ - Policy dockers contain GPLv3
1458 | `POLICY-3066 <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
1459 | `POLICY-3161 <https://jira.onap.org/browse/POLICY-3161>`_ - OOM clamp BE/FE do not start properly when clamp db exists in the cluster
1460 | `POLICY-3174 <https://jira.onap.org/browse/POLICY-3174>`_ - POLICY-APEX  log does not include the DATE in STDOUT
1461 | `POLICY-3176 <https://jira.onap.org/browse/POLICY-3176>`_ - POLICY-DROOLS  log does not include the DATE in STDOUT
1462 | `POLICY-3177 <https://jira.onap.org/browse/POLICY-3177>`_ - POLICY-PAP log does not include the DATE in STDOUT
1463 | `POLICY-3201 <https://jira.onap.org/browse/POLICY-3201>`_ - fix CRITICAL weak-cryptography issues identified in sonarcloud
1464 | `POLICY-3202 <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
1465 | `POLICY-3203 <https://jira.onap.org/browse/POLICY-3203>`_ - Update the PDP deployment in policy window failure
1466 | `POLICY-3204 <https://jira.onap.org/browse/POLICY-3204>`_ - Clamp UI does not accept to deploy policy to PDP
1467 | `POLICY-3205 <https://jira.onap.org/browse/POLICY-3205>`_ - The submit operation in Clamp cannot be achieved successfully
1468 | `POLICY-3225 <https://jira.onap.org/browse/POLICY-3225>`_ - Clamp policy UI does not send right pdp command
1469 | `POLICY-3226 <https://jira.onap.org/browse/POLICY-3226>`_ - Clamp policy UI does 2 parallel queries to policy list
1470 | `POLICY-3248 <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
1471 | `POLICY-3301 <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
1472 | `POLICY-3322 <https://jira.onap.org/browse/POLICY-3322>`_ - gui-editor-apex doesn't contain webapp correctly
1473 | `POLICY-3332 <https://jira.onap.org/browse/POLICY-3332>`_ - Issues around delta policy deployment in APEX
1474 | `POLICY-3369 <https://jira.onap.org/browse/POLICY-3369>`_ - Modify NSSI closed loop not running
1475 | `POLICY-3445 <https://jira.onap.org/browse/POLICY-3445>`_ - Version conflicts in spring boot dependency jars in CLAMP
1476 | `POLICY-3454 <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
1477 | `POLICY-3468 <https://jira.onap.org/browse/POLICY-3468>`_ - PDPD-CL APPS: Clean up library transitive dependencies conflicts (jackson version) from new CDS libraries
1478 | `POLICY-3507 <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
1479 | `POLICY-3526 <https://jira.onap.org/browse/POLICY-3526>`_ - OOM start of policy-distribution fails (keyStore values)
1480 | `POLICY-3558 <https://jira.onap.org/browse/POLICY-3558>`_ - Delete Instance Properties if Instantiation is Unitialized
1481 | `POLICY-3600 <https://jira.onap.org/browse/POLICY-3600>`_ - Some REST calls in Clamp GUI do not include pathname
1482 | `POLICY-3601 <https://jira.onap.org/browse/POLICY-3601>`_ - Static web resource paths in gui-editor-apex are incorrect
1483 | `POLICY-3602 <https://jira.onap.org/browse/POLICY-3602>`_ - Context schema table is not populated in Apex Editor
1484 | `POLICY-3603 <https://jira.onap.org/browse/POLICY-3603>`_ - gui-pdp-monitoring broken in gui docker image
1485 | `POLICY-3608 <https://jira.onap.org/browse/POLICY-3608>`_ - LASTUPDATE column in pdp table causing Nullpointer Exception in PAP initialization
1486 | `POLICY-3610 <https://jira.onap.org/browse/POLICY-3610>`_ - PDP-D-APPS:  audit and metric logging information is incorrect
1487 | `POLICY-3611 <https://jira.onap.org/browse/POLICY-3611>`_ - "API,PAP: decrease eclipselink verbosity in persistence.xml"
1488 | `POLICY-3625 <https://jira.onap.org/browse/POLICY-3625>`_ - Terminated PDPs are not being removed by PAP
1489 | `POLICY-3637 <https://jira.onap.org/browse/POLICY-3637>`_ - Policy-mariadb connection intermittently fails from PF components
1490 | `POLICY-3639 <https://jira.onap.org/browse/POLICY-3639>`_ - CLAMP_REST_URL environment variable is not needed
1491 | `POLICY-3647 <https://jira.onap.org/browse/POLICY-3647>`_ - Cannot create Instance from Policy GUI
1492 | `POLICY-3649 <https://jira.onap.org/browse/POLICY-3649>`_ - SSL Handshake failure between CL participants and DMaap
1493 | `POLICY-3650 <https://jira.onap.org/browse/POLICY-3650>`_ - Disable apex-editor and pdp-monitoring in gui docker
1494 | `POLICY-3660 <https://jira.onap.org/browse/POLICY-3660>`_ - DB-Migrator job completes even during failed upgrade
1495 | `POLICY-3678 <https://jira.onap.org/browse/POLICY-3678>`_ - K8s participants tests are skipped due to json parsing error.
1496 | `POLICY-3679 <https://jira.onap.org/browse/POLICY-3679>`_ - Modify pdpstatistics to prevent duplicate keys
1497 | `POLICY-3680 <https://jira.onap.org/browse/POLICY-3680>`_ - PDP Monitoring GUI fails to parse JSON from PAP
1498 | `POLICY-3682 <https://jira.onap.org/browse/POLICY-3682>`_ - Unable to list the policies in Policy UI
1499 | `POLICY-3683 <https://jira.onap.org/browse/POLICY-3683>`_ - clamp-fe & policy-gui: useless rolling logs
1500 | `POLICY-3684 <https://jira.onap.org/browse/POLICY-3684>`_ - Unable to select a PDP group & Subgroup when configuring a control loop policy
1501 | `POLICY-3685 <https://jira.onap.org/browse/POLICY-3685>`_ - Fix CL state change issues in runtime and participants
1502 | `POLICY-3686 <https://jira.onap.org/browse/POLICY-3686>`_ - Update Participant Status after Commissioning
1503 | `POLICY-3687 <https://jira.onap.org/browse/POLICY-3687>`_ - Continuous sending CONTROL_LOOP_STATE_CHANGE message
1504 | `POLICY-3688 <https://jira.onap.org/browse/POLICY-3688>`_ - Register participant in ParticipantRegister message
1505 | `POLICY-3689 <https://jira.onap.org/browse/POLICY-3689>`_ - Handle ParticipantRegister
1506 | `POLICY-3691 <https://jira.onap.org/browse/POLICY-3691>`_ - Problems Parsing Service Template
1507 | `POLICY-3695 <https://jira.onap.org/browse/POLICY-3695>`_ - Tosca Constraint "in_range" not supported by policy/models
1508 | `POLICY-3706 <https://jira.onap.org/browse/POLICY-3706>`_ - Telemetry not working in drools-pdp
1509 | `POLICY-3707 <https://jira.onap.org/browse/POLICY-3707>`_ - Cannot delete a loop in design state
1510
1511 References
1512 ==========
1513
1514 For more information on the ONAP Istanbul release, please see:
1515
1516 #. `ONAP Home Page`_
1517 #. `ONAP Documentation`_
1518 #. `ONAP Release Downloads`_
1519 #. `ONAP Wiki Page`_
1520
1521 .. _`ONAP Home Page`: https://www.onap.org
1522 .. _`ONAP Wiki Page`: https://wiki.onap.org
1523 .. _`ONAP Documentation`: https://docs.onap.org
1524 .. _`ONAP Release Downloads`: https://git.onap.org
1525
1526 Quick Links:
1527     - `POLICY project page`_
1528     - `Passing Badge information for POLICY`_
1529
1530 ..      ==========================
1531 ..      * * *    HONOLULU    * * *
1532 ..      ==========================
1533
1534 Version: 8.0.1
1535 --------------
1536
1537 :Release Date: 2021-08-12 (Honolulu Maintenance Release #1)
1538
1539 **Artifacts**
1540
1541 Artifacts released:
1542
1543 .. csv-table::
1544    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1545    :widths: 15,10,10
1546
1547    "policy/parent", "3.3.2", ""
1548    "policy/common", "1.8.2", ""
1549    "policy/models", "2.4.4", ""
1550    "policy/api", "2.4.4", "onap/policy-api:2.4.4"
1551    "policy/pap", "2.4.5", "onap/policy-pap:2.4.5"
1552    "policy/drools-pdp", "1.8.4", "onap/policy-drools:1.8.4"
1553    "policy/apex-pdp", "2.5.4", "onap/policy-apex-pdp:2.5.4"
1554    "policy/xacml-pdp", "2.4.5", "onap/policy-xacml-pdp:2.4.5"
1555    "policy/drools-applications", "1.8.4", "onap/policy-pdpd-cl:1.8.4"
1556    "policy/distribution", "2.5.4", "onap/policy-distribution:2.5.4"
1557    "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
1558
1559
1560 **Bug Fixes and Necessary Enhancements**
1561
1562
1563     * `[POLICY-3062] <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
1564     * `[POLICY-3066] <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
1565     * `[POLICY-3078] <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
1566     * `[POLICY-3173] <https://jira.onap.org/browse/POLICY-3173>`_ - APEX-PDP incorrectly reports successful policy deployment to PAP
1567     * `[POLICY-3202] <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
1568     * `[POLICY-3227] <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
1569     * `[POLICY-3230] <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
1570     * `[POLICY-3248] <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
1571     * `[POLICY-3301] <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
1572     * `[POLICY-3305] <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
1573     * `[POLICY-3331] <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
1574     * `[POLICY-3338] <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
1575     * `[POLICY-3366] <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
1576     * `[POLICY-3450] <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
1577     * `[POLICY-3454] <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
1578     * `[POLICY-3485] <https://jira.onap.org/browse/POLICY-3485>`_ - Limit statistics record count
1579     * `[POLICY-3507] <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
1580     * `[POLICY-3516] <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
1581
1582
1583 Known Limitations
1584 =================
1585
1586 The APIs provided by xacml-pdp (e.g., healthcheck, statistics, decision)
1587 are always active.  While PAP controls which policies are deployed to a
1588 xacml-pdp, it does not control whether or not the APIs are active.
1589 In other words, xacml-pdp will respond to decision requests, regardless
1590 of whether PAP has made it ACTIVE or PASSIVE.
1591
1592
1593 Version: 8.0.0
1594 --------------
1595
1596 :Release Date: 2021-04-29 (Honolulu Release)
1597
1598 New features
1599 ============
1600
1601 Artifacts released:
1602
1603 .. csv-table::
1604    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1605    :widths: 15,10,10
1606
1607    "policy/parent", "3.3.0", ""
1608    "policy/common", "1.8.0", ""
1609    "policy/models", "2.4.2", ""
1610    "policy/api", "2.4.2", "onap/policy-api:2.4.2"
1611    "policy/pap", "2.4.2", "onap/policy-pap:2.4.2"
1612    "policy/drools-pdp", "1.8.2", "onap/policy-drools:1.8.2"
1613    "policy/apex-pdp", "2.5.2", "onap/policy-apex-pdp:2.5.2"
1614    "policy/xacml-pdp", "2.4.2", "onap/policy-xacml-pdp:2.4.2"
1615    "policy/drools-applications", "1.8.2", "onap/policy-pdpd-cl:1.8.2"
1616    "policy/distribution", "2.5.2", "onap/policy-distribution:2.5.2"
1617    "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
1618
1619 Key Updates
1620 ===========
1621
1622 * Enhanced statistics
1623    - PDPs provide statistics, retrievable via PAP REST API
1624 * PDP deployment status
1625    - Policy deployment API enhanced to reflect actual policy deployment status in PDPs
1626    - Make PAP component stateless
1627 * Policy support
1628    - Upgrade XACML 3.0 code to use new Time Extensions
1629    - Enhancements for interoperability between Native Policies and other policy types
1630    - Support for arbitrary policy types on the Drools PDP
1631    - Improve handling of multiple policies in APEX PDP
1632    - Update policy-models TOSCA handling with Control Loop Entities
1633 * Alternative locking mechanisms
1634    - Support NO locking feature in Drools-PDP
1635 * Security
1636    - Remove credentials in code from the Apex JMS plugin
1637 * Actor enhancements
1638    - Actors should give better warnings than NPE when data is missing
1639    - Remove old event-specific actor code
1640 * PDP functional assignments
1641    - Make PDP type configurable in drools-pdp
1642    - Make PDP type configurable in xacml-pdp
1643 * Performance improvements
1644    - Support policy updates between PAP and the PDPs, phase 1
1645 * Maintainability
1646    - Use ONAP base docker image
1647    - Remove GPLv3 components from docker containers
1648    - Move CSITs to Policy repos
1649    - Deprecate server pool feature in drools-pdp
1650 * PoCs
1651    - Merge CLAMP functionality into Policy Framework project
1652    - TOSCA Defined Control Loop
1653
1654
1655 Known Limitations, Issues and Workarounds
1656 =========================================
1657
1658 System Limitations
1659 ~~~~~~~~~~~~~~~~~~
1660
1661 The policy API component requires a fresh new database when migrating to the honolulu release.
1662 Therefore, upgrades require a fresh new database installation.
1663 Please see the
1664 `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.
1665
1666 Known Vulnerabilities
1667 ~~~~~~~~~~~~~~~~~~~~~
1668
1669 Workarounds
1670 ~~~~~~~~~~~
1671
1672 * `POLICY-2998 <https://jira.onap.org/browse/POLICY-2998>`_ - Provide a script to periodically purge the statistics table
1673
1674 Security Notes
1675 ==============
1676
1677 * `POLICY-3005 <https://jira.onap.org/browse/POLICY-3005>`_ - Bump direct dependency versions
1678     - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.12
1679     - Upgrade org.eclipse.persistence to 2.7.8
1680     - Upgrade org.glassfish.jersey.containers to 2.33
1681     - Upgrade com.fasterxml.jackson.module to 2.11.3
1682     - Upgrade com.google.re2j to 1.5
1683     - Upgrade org.mariadb.jdbc to 2.7.1
1684     - Upgrade commons-codec to 1.15
1685     - Upgrade com.thoughtworks.xstream to 1.4.15
1686     - Upgrade org.apache.httpcomponents:httpclient to 4.5.13
1687     - Upgrade org.apache.httpcomponents:httpcore to 4.4.14
1688     - Upgrade org.json to 20201115
1689     - Upgrade org.projectlombok to 1.18.16
1690     - Upgrade org.yaml to 1.27
1691     - Upgrade io.cucumber to 6.9.1
1692     - Upgrade org.apache.commons:commons-lang3 to 3.11
1693     - Upgrade commons-io to 2.8.0
1694 * `POLICY-2943 <https://jira.onap.org/browse/POLICY-2943>`_ - Review license scan issues
1695     - Upgrade com.hazelcast to 4.1.1
1696     - Upgrade io.netty to 4.1.58.Final
1697 * `POLICY-2936 <https://jira.onap.org/browse/POLICY-2936>`_ - Upgrade to latest version of CDS API
1698     - Upgrade io.grpc to 1.35.0
1699     - Upgrade com.google.protobuf to 3.14.0
1700
1701
1702 References
1703 ==========
1704
1705 For more information on the ONAP Honolulu release, please see:
1706
1707 #. `ONAP Home Page`_
1708 #. `ONAP Documentation`_
1709 #. `ONAP Release Downloads`_
1710 #. `ONAP Wiki Page`_
1711
1712
1713 .. _`ONAP Home Page`: https://www.onap.org
1714 .. _`ONAP Wiki Page`: https://wiki.onap.org
1715 .. _`ONAP Documentation`: https://docs.onap.org
1716 .. _`ONAP Release Downloads`: https://git.onap.org
1717
1718 Quick Links:
1719     - `POLICY project page`_
1720     - `Passing Badge information for POLICY`_
1721
1722 ..      ========================
1723 ..      * * *    GUILIN    * * *
1724 ..      ========================
1725
1726 Version: 7.0.0
1727 --------------
1728
1729 :Release Date: 2020-12-03 (Guilin Release)
1730
1731 New features
1732 ============
1733
1734 Artifacts released:
1735
1736 .. csv-table::
1737    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1738    :widths: 15,10,10
1739
1740    "policy/parent", "3.2.0", ""
1741    "policy/common", "1.7.1", ""
1742    "policy/models", "2.3.5", ""
1743    "policy/api", "2.3.3", "onap/policy-api:2.3.3"
1744    "policy/pap", "2.3.3", "onap/policy-pap:2.3.3"
1745    "policy/drools-pdp", "1.7.4", "onap/policy-drools:1.7.4"
1746    "policy/apex-pdp", "2.4.4", "onap/policy-apex-pdp:2.4.4"
1747    "policy/xacml-pdp", "2.3.3", "onap/policy-xacml-pdp:2.3.3"
1748    "policy/drools-applications", "1.7.5", "onap/policy-pdpd-cl:1.7.5"
1749    "policy/distribution", "2.4.3", "onap/policy-distribution:2.4.3"
1750    "policy/docker", "2.1.1", "onap/policy-jdk-alpine:2.1.1, onap/policy-jre-alpine:2.1.1"
1751
1752 Key Updates
1753 ===========
1754
1755 * Kubernetes integration
1756    - All components return with non-zero exit code in case of application failure
1757    - All components log to standard out (i.e., k8s logs) by default
1758    - Continue to write log files inside individual pods, as well
1759 * E2E Network Slicing
1760    - Added ModifyNSSI operation to SO actor
1761 * Consolidated health check
1762    - Indicate failure if there aren’t enough PDPs registered
1763 * Legacy operational policies
1764    - Removed from all components
1765 * OOM helm charts refactoring
1766    - Name standardization
1767    - Automated certificate generation
1768 * Actor Model
1769    - Support various use cases and provide more flexibility to Policy Designers
1770    - Reintroduced the "usecases" controller into drools-pdp, supporting the use cases
1771      under the revised actor architecture
1772 * Guard Application
1773    - Support policy filtering
1774 * Matchable Application
1775   - Support for ONAP or 3rd party components to create matchable policy types out of the box
1776 * Policy Lifecycle & Administration API
1777    - Query/Delete by policy name & version without policy type
1778 * Apex-PDP enhancements
1779    - Support multiple event & response types coming from a single endpoint
1780    - Standalone installation now supports Tosca-based policies
1781    - Legacy policy format has been removed
1782    - Support chaining/handling of gRPC failure responses
1783 * Policy Distribution
1784    - HPA decoders & related classes have been removed
1785 * Policy Engine
1786    - Deprecated
1787
1788 Known Limitations, Issues and Workarounds
1789 =========================================
1790
1791 System Limitations
1792 ~~~~~~~~~~~~~~~~~~
1793
1794 The policy API component requires a fresh new database when migrating to the guilin release.
1795 Therefore, upgrades require a fresh new database installation.
1796 Please see the
1797 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/latest/installation/oom.html#installing-or-upgrading-policy-acm>`__ section for appropriate procedures.
1798
1799 Known Vulnerabilities
1800 ~~~~~~~~~~~~~~~~~~~~~
1801
1802 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
1803
1804 Workarounds
1805 ~~~~~~~~~~~
1806 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Use the stringify method of the execution context
1807
1808 Security Notes
1809 ==============
1810
1811 * `POLICY-2878 <https://jira.onap.org/browse/POLICY-2878>`_ - Dependency upgrades
1812     - Upgrade com.fasterxml.jackson to 2.11.1
1813 * `POLICY-2387 <https://jira.onap.org/browse/POLICY-2387>`_ - Dependency upgrades
1814     - Upgrade org.json to 20200518
1815     - Upgrade com.google.re2j to 1.4
1816     - Upgrade com.thoughtworks.xstream to 1.4.12
1817     - Upgrade org.eclipse.persistence to 2.2.1
1818     - Upgrade org.apache.httpcomponents to 4.5.12
1819     - Upgrade org.projectlombok to 1.18.12
1820     - Upgrade org.slf4j to 1.7.30
1821     - Upgrade org.codehaus.plexus to 3.3.0
1822     - Upgrade com.h2database to 1.4.200
1823     - Upgrade io.cucumber to 6.1.2
1824     - Upgrade org.assertj to 3.16.1
1825     - Upgrade com.openpojo to 0.8.13
1826     - Upgrade org.mockito to 3.3.3
1827     - Upgrade org.awaitility to 4.0.3
1828     - Upgrade org.onap.aaf.authz to 2.1.21
1829 * `POLICY-2668 <https://jira.onap.org/browse/POLICY-2668>`_ - Dependency upgrades
1830     - Upgrade org.java-websocket to 1.5.1
1831 * `POLICY-2623 <https://jira.onap.org/browse/POLICY-2623>`_ - Remove log4j dependency
1832 * `POLICY-1996 <https://jira.onap.org/browse/POLICY-1996>`_ - Dependency upgrades
1833     - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.11
1834
1835
1836 References
1837 ==========
1838
1839 For more information on the ONAP Guilin release, please see:
1840
1841 #. `ONAP Home Page`_
1842 #. `ONAP Documentation`_
1843 #. `ONAP Release Downloads`_
1844 #. `ONAP Wiki Page`_
1845
1846
1847 .. _`ONAP Home Page`: https://www.onap.org
1848 .. _`ONAP Wiki Page`: https://wiki.onap.org
1849 .. _`ONAP Documentation`: https://docs.onap.org
1850 .. _`ONAP Release Downloads`: https://git.onap.org
1851
1852 Quick Links:
1853     - `POLICY project page`_
1854     - `Passing Badge information for POLICY`_
1855
1856
1857 ..      ===========================
1858 ..      * * *    FRANKFURT    * * *
1859 ..      ===========================
1860
1861
1862 Version: 6.0.1
1863 --------------
1864
1865 :Release Date: 2020-08-21 (Frankfurt Maintenance Release #1)
1866
1867 **Artifacts**
1868
1869 Artifacts released:
1870
1871 .. csv-table::
1872    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1873    :widths: 15,10,10
1874
1875    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
1876
1877
1878 **Bug Fixes**
1879
1880
1881     * `[POLICY-2704] <https://jira.onap.org/browse/POLICY-2704>`_ - Legacy PDP-X and PAP stuck in PodIntializing
1882
1883
1884 **Security Notes**
1885
1886 *Fixed Security Issues*
1887
1888
1889     * `[POLICY-2678] <https://jira.onap.org/browse/POLICY-2678>`_ - policy/engine tomcat upgrade for CVE-2020-11996
1890
1891
1892 Version: 6.0.0
1893 --------------
1894
1895 :Release Date: 2020-06-04 (Frankfurt Release)
1896
1897 New features
1898 ============
1899
1900 Artifacts released:
1901
1902 .. csv-table::
1903    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1904    :widths: 15,10,10
1905
1906    "policy/parent", "3.1.3", ""
1907    "policy/common", "1.6.5", ""
1908    "policy/models", "2.2.6", ""
1909    "policy/api", "2.2.4", "onap/policy-api:2.2.4"
1910    "policy/pap", "2.2.3", "onap/policy-pap:2.2.3"
1911    "policy/drools-pdp", "1.6.3", "onap/policy-drools:1.6.3"
1912    "policy/apex-pdp", "2.3.2", "onap/policy-apex-pdp:2.3.2"
1913    "policy/xacml-pdp", "2.2.2", "onap/policy-xacml-pdp:2.2.2"
1914    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
1915    "policy/engine", "1.6.4", "onap/policy-pe:1.6.4"
1916    "policy/distribution", "2.3.2", "onap/policy-distribution:2.3.2"
1917    "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"
1918
1919 Summary
1920 =======
1921
1922 New features include policy update notifications, native policy support, streamlined health check for the Policy Administration Point (PAP),
1923 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.
1924
1925 Common changes in all policy components
1926 =======================================
1927
1928 * Upgraded all policy components to Java 11.
1929 * Logback file can be now loaded using OOM configmap.
1930    - 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.
1931
1932 * TOSCA changes:
1933    - “tosca_definitions_version” is now “tosca_simple_yaml_1_1_0”
1934    - typeVersion→ type_version, int→integer, bool→boolean, String→string, Map→map, List→list
1935 * SupportedPolicyTypes now removed from pdp status message.
1936    - All PDPs now send PdpGroup to which they belong to in the registration message.
1937    - SupportedPolicyTypes are not sent anymore.
1938
1939 * Native Policy Support
1940    - Each PDP engine has its own native policy language. A new Policy Type **onap.policies.Native** was created and supported for each PDP
1941      engine to support native policy types.
1942
1943
1944 POLICY-PAP
1945 ==========
1946
1947 * Policy Update Notifications
1948    - PAP now generates notifications  via the DMaaP Message Router when policies are successfully or unsuccessfully deployed (or undeployed) from all relevant PDPs.
1949
1950 * PAP API to fetch Policy deployment status
1951    - Clients will be able to poll the PAP API to find out when policies have been successfully or unsuccessfully deployed to the PDP's.
1952
1953 * Removing supportedPolicyTypes from PdpStatus
1954    - PDPs are assigned to a PdpGroup based on what group is mentioned in the heartbeat. Earlier this was done based on the supportedPolicyTypes.
1955
1956 * Support policy types with wild-cards, Preload wildcard supported type in PAP
1957
1958 * PAP should NOT make a PDP passive if it cannot deploy a policy.
1959    - 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.
1960    - Also, re-register pdp if not found in the DB during heartbeat processing.
1961
1962 * Consolidated health check in PAP
1963    - 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.
1964    - “healthCheckRestClientParameters” (REST parameters for API and Distribution healthcheck) are added to the startup config file in PAP.
1965
1966 * PDP statistics from PAP
1967    - 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.
1968
1969 * PAP API for Create or Update PdpGroups
1970    - 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
1971
1972 * PAP API to deploy policies to PdpGroups
1973    - 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.
1974
1975 POLICY-API
1976 ==========
1977
1978 * A new simplified API to create one or more policies in one call.
1979    - This simplified API doesn’t require policy type id & policy type version to be part of the URL.
1980    - The simple URI “policy/api/v1/policies” with a POST input body takes in a ToscaServiceTemplate with the policies in it.
1981
1982 * List of Preloaded policy types are made configurable
1983    - 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.
1984
1985 * Preload default policies for ONAP components
1986    - The ability to configure the preloading of initial default policies into the system upon startup.
1987
1988 * A lot of improvements to the API code and validations corresponding to the changes in policy-models.
1989    - Creating same policyType/policy repeatedly without any change in request body will always be successful with 200 response
1990    - 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.
1991
1992 * Known versioning issues are there in Policy Types handling.
1993    - 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.
1994
1995 * Cascaded GET of PolicyTypes and Policies
1996    - Fetching/GET PolicyType now returns all of the referenced/parent policyTypes and dataTypes as well.
1997    - Fetching/GET Policy allows specifying mode now.
1998    - 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.
1999
2000 * The /deployed API is removed from policy/api
2001    - This run time administration job to see the deployment status of a policy is now possible via PAP.
2002
2003 * Changes related to design and support of TOSCA Compliant Policy Types for the operational and guard policy models.
2004
2005 POLICY-DISTRIBUTION
2006 ===================
2007
2008 * 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.
2009    - Note: If “deployPolicies” field in the startup config file is true, then only the policies are deployed using PAP endpoint.
2010
2011 * Policy/engine & apex-pdp dependencies are removed from policy-distribution.
2012
2013
2014 POLICY-APEX-PDP
2015 ===============
2016
2017 * Changed the JavaScript executor from Nashorn to Rhino as part of Java 11 upgrade.
2018    - 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
2019
2020    - 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.
2021
2022 * APEX supports multiple policy deployment in Frankfurt.
2023    - 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.
2024
2025    - 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).
2026
2027    - 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”.
2028
2029 * Context retainment during policy upgrade.
2030    - 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.
2031
2032    - 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.
2033
2034 * APEX-PDP now specifies which PdpGroup it belongs to.
2035    - 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.
2036
2037    - In APEX-PDP, this can be specified in the startup config file(OnapPfConfig.json). "pdpGroup": "<groupName>" is added under “pdpStatusParameters” in the config file.
2038
2039 * APEX-PDP now sends PdpStatistics data in heartbeat.
2040    - 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.
2041
2042 * Removed “content” section from ToscaPolicy properties in APEX.
2043    - 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.
2044
2045 * Passing parameters from ApexConfig to policy logic.
2046    - 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.
2047
2048    - More information about the usage of Task Parameters can be found here: https://docs.onap.org/projects/onap-policy-parent/en/latest/apex/APEX-User-Manual.html#configure-task-parameters
2049
2050    - In the taskLogic, taskParameters can be accessed as  executor.parameters.get("ParameterKey1"))
2051
2052    - More information can be found here: https://docs.onap.org/projects/onap-policy-parent/en/latest/apex/APEX-Policy-Guide.html#accessing-taskparameters
2053
2054 * GRPC support for APEX-CDS interaction.
2055    - 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/latest/apex/APEX-User-Manual.html#grpc-io
2056
2057 POLICY-XACML-PDP
2058 ================
2059
2060 * Added optional Decision API param to Decision API for monitor decisions that returns abbreviated results.
2061    - 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).
2062
2063 * XACML PDP now support PASSIVE_MODE.
2064 * Added support to return status and error if pdp-x failed to load a policy.
2065 * Changed optimization Decision API application to support "closest matches" algorithm.
2066 * Changed Xacml-pdp to report the pdp group defined in XacmlPdpParameters config file as part of heartbeat. Also, removed supportedPolicyType from pdpStatus message.
2067 * 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.
2068 * XACML pdp support for Control Loop Coordination
2069    - Added policies for SON and PCI to support each blocking the other, with test cases and appropriate requests
2070
2071 * Extend PDP-X capabilities so that it can load in and enforce the native XACML policies deployed from PAP.
2072
2073 POLICY-DROOLS-PDP
2074 =================
2075
2076 * Support for PDP-D in offline mode to support locked deployments.   This is the default ONAP installation.
2077 * Parameterize maven repository URLs for easier CI/CD integration.
2078 * Support for Tosca Compliant Operational Policies.
2079 * Support for TOSCA Compliant Native Policies that allows creation and deployment of new drools-applications.
2080 * Validation of Operational and Native Policies against their policy type.
2081 * Support for a generic Drools-PDP docker image to host any type of application.
2082 * Experimental Server Pool feature that supports multiple active Drools PDP hosts.
2083
2084 POLICY-DROOLS-APPLICATIONS
2085 ==========================
2086
2087 * Removal of DCAE ONSET alarm duplicates (with different request IDs).
2088 * Support of a new controller (frankfurt) that supports the ONAP use cases under the new actor architecture.
2089 * Deprecated the "usecases" controller supporting the use cases under the legacy actor architecture.
2090 * Deleted the unsupported "amsterdam" controller related projects.
2091
2092
2093 Known Limitations, Issues and Workarounds
2094 =========================================
2095
2096 System Limitations
2097 ~~~~~~~~~~~~~~~~~~
2098
2099 The policy API component requires a fresh new database when migrating to the frankfurt release.
2100 Therefore, upgrades require a fresh new database installation.
2101 Please see the
2102 `Installing or Upgrading Policy <https://docs.onap.org/projects/onap-policy-parent/en/latest/installation/oom.html#installing-or-upgrading-policy-acm>`__ section for appropriate procedures.
2103
2104 Known Vulnerabilities
2105 ~~~~~~~~~~~~~~~~~~~~~
2106
2107 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
2108 * `POLICY-2487 <https://jira.onap.org/browse/POLICY-2487>`_ - policy/api hangs in loop if preload policy does not exist
2109
2110 Workarounds
2111 ~~~~~~~~~~~
2112 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Parse incoming object using JSON.Parse() or cast the object to a String
2113
2114 Security Notes
2115 ==============
2116
2117 * `POLICY-2221 <https://jira.onap.org/browse/POLICY-2221>`_ - Password removal from helm charts
2118 * `POLICY-2064 <https://jira.onap.org/browse/POLICY-2064>`_ - Allow overriding of keystore and truststore in policy helm charts
2119 * `POLICY-2381 <https://jira.onap.org/browse/POLICY-2381>`_ - Dependency upgrades
2120     - Upgrade drools 7.33.0
2121     - Upgrade jquery to 3.4.1 in jquery-ui
2122     - Upgrade snakeyaml to 1.26
2123     - Upgrade org.infinispan infinispan-core 10.1.5.Final
2124     - upgrade io.netty 4.1.48.Final
2125     - exclude org.glassfish.jersey.media jersey-media-jaxb artifact
2126     - Upgrade com.fasterxml.jackson.core 2.10.0.pr3
2127     - Upgrade org.org.jgroups 4.1.5.Final
2128     - Upgrade commons-codec 20041127.091804
2129     - Upgrade com.github.ben-manes.caffeine 2.8.0
2130
2131 ..      ==========================
2132 ..      * * *     EL ALTO    * * *
2133 ..      ==========================
2134
2135 Version: 5.0.2
2136 --------------
2137
2138 :Release Date: 2020-08-24 (El Alto Maintenance Release #1)
2139
2140 **New Features**
2141
2142 Artifacts released:
2143
2144 .. csv-table::
2145    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
2146    :widths: 15,10,10
2147
2148    "policy/api", "2.1.3", "onap/policy-api:2.1.3"
2149    "policy/pap", "2.1.3", "onap/policy-pap:2.1.3"
2150    "policy/drools-pdp", "1.5.3", "onap/policy-drools:1.5.3"
2151    "policy/apex-pdp", "2.2.3", "onap/policy-apex-pdp:2.2.3"
2152    "policy/xacml-pdp", "2.1.3", "onap/policy-xacml-pdp:2.1.3"
2153    "policy/drools-applications", "1.5.4", "onap/policy-pdpd-cl:1.5.4"
2154    "policy/engine", "1.5.3", "onap/policy-pe:1.5.3"
2155    "policy/distribution", "2.2.2", "onap/policy-distribution:2.2.2"
2156    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0, onap/policy/base-alpine:1.4.0"
2157
2158
2159 **Bug Fixes**
2160
2161
2162     * `[PORTAL-760]  <https://jira.onap.org/browse/PORTAL-760>`_  - Access to Policy portal is impossible
2163     * `[POLICY-2107] <https://jira.onap.org/browse/POLICY-2107>`_ - policy/distribution license issue in resource needs to be removed
2164     * `[POLICY-2169] <https://jira.onap.org/browse/POLICY-2169>`_ - SDC client interface change caused compile error in policy distribution
2165     * `[POLICY-2171] <https://jira.onap.org/browse/POLICY-2171>`_ - Upgrade elalto branch models and drools-applications
2166     * `[POLICY-1509] <https://jira.onap.org/browse/POLICY-1509>`_ - Investigate Apex org.python.jython-standalone.2.7.1
2167     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
2168
2169
2170 **Security Notes**
2171
2172 *Fixed Security Issues*
2173
2174
2175     * `[POLICY-2475] <https://jira.onap.org/browse/POLICY-2475>`_ - Update El Alto component certificates
2176
2177 Version: 5.0.1
2178 --------------
2179
2180 :Release Date: 2019-10-24 (El Alto Release)
2181
2182 **New Features**
2183
2184 Artifacts released:
2185
2186 .. csv-table::
2187    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
2188    :widths: 15,10,10
2189
2190    "policy/parent", "3.0.1", ""
2191    "policy/common", "1.5.2", ""
2192    "policy/models", "2.1.4", ""
2193    "policy/api", "2.1.2", "onap/policy-api:2.1.2"
2194    "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
2195    "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
2196    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
2197    "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
2198    "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
2199    "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
2200    "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
2201    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
2202
2203 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`_.
2204
2205     * [POLICY-1727] - This epic covers technical debt left over from Dublin
2206
2207     - POLICY-969    Docker improvement in policy framwork modules
2208     - POLICY-1074   Fix checkstyle warnings in every repository
2209     - POLICY-1121   RPM build for Apex
2210     - POLICY-1223   CII Silver Badging Requirements
2211     - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
2212     - POLICY-1646   Replace uses of getCanonicalName() with getName()
2213     - POLICY-1652   Move PapRestServer to policy/common
2214     - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
2215     - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
2216     - POLICY-1742   Make HTTP return code handling configurable in APEX
2217     - POLICY-1743   Make URL configurable in REST Requestor and REST Client
2218     - POLICY-1744   Remove topic.properties and incorporate into overall properties
2219     - POLICY-1770   PAP REST API for PDPGroup Healthcheck
2220     - POLICY-1771   Boost policy/api JUnit code coverage
2221     - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
2222     - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
2223     - POLICY-1784   Better Handling of "version" field value with clients
2224     - POLICY-1785   Deploy same policy with a new version simply adds to the list
2225     - POLICY-1786   Create a simple way to populate the guard database for testing
2226     - POLICY-1791   Address Sonar issues in new policy repos
2227     - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
2228     - POLICY-1800   API|PAP components use different version formats
2229     - POLICY-1805   Build up stability test for api component to follow S3P requirements
2230     - POLICY-1806   Build up S3P performance test for api component
2231     - POLICY-1847   Add control loop coordination as a preloaded policy type
2232     - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
2233     - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
2234     - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
2235     - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
2236     - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
2237     - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
2238
2239     * Additional items delivered with the release.
2240
2241     - POLICY-1637   Remove "version" from PdpGroup
2242     - POLICY-1653   Remove isNullVersion() method
2243     - POLICY-1966   Fix more sonar issues in policy drools
2244     - POLICY-1988   Generate El Alto AAF Certificates
2245
2246     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
2247
2248     - POLICY-1762   Create CDS API model implementation
2249     - POLICY-1763   Create CDS Actor
2250     - POLICY-1899   Update optimization xacml application to support more flexible Decision API
2251     - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
2252
2253
2254 **Bug Fixes**
2255
2256 The following bug fixes have been deployed with this release:
2257
2258     * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
2259     * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
2260     * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
2261     * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
2262     * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
2263     * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
2264     * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
2265     * `[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
2266     * `[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
2267     * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
2268     * `[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
2269     * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
2270     * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
2271     * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
2272     * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
2273     * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
2274     * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
2275     * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
2276     * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
2277     * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
2278     * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
2279     * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
2280
2281
2282 **Security Notes**
2283
2284 *Fixed Security Issues*
2285
2286
2287     * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final
2288     * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
2289     * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
2290     * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
2291     * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
2292     * `[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
2293     * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
2294     * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
2295     * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
2296
2297 *Known Security Issues*
2298
2299 *Known Vulnerabilities in Used Modules*
2300
2301 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>`_.
2302
2303 Quick Links:
2304     - `POLICY project page`_
2305     - `Passing Badge information for POLICY`_
2306     - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
2307
2308 **Known Issues**
2309
2310 The following known issues will be addressed in a future release:
2311
2312     * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
2313     * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
2314     * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
2315     * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
2316     * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
2317     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
2318     * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
2319     * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
2320     * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
2321     * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
2322
2323
2324 ..      ==========================
2325 ..      * * *      DUBLIN    * * *
2326 ..      ==========================
2327
2328 Version: 4.0.0
2329 --------------
2330
2331 :Release Date: 2019-06-26 (Dublin Release)
2332
2333 **New Features**
2334
2335 Artifacts released:
2336
2337 .. csv-table::
2338    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
2339    :widths: 15,10,10
2340
2341    "policy/parent", "2.1.0", ""
2342    "policy/common", "1.4.0", ""
2343    "policy/models", "2.0.2", ""
2344    "policy/api", "2.0.1", "onap/policy-api:2.0.1"
2345    "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
2346    "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
2347    "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
2348    "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
2349    "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
2350    "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
2351    "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
2352    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
2353
2354 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`_.
2355
2356     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
2357         - POLICY-1195   Separate model code from drools-applications into other repositories
2358         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
2359         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
2360         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
2361
2362     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
2363         - POLICY-1007   Remove Jackson from policy framework components
2364         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
2365         - POLICY-1250   Fix issues reported by sonar in policy modules
2366         - POLICY-1368   Remove hibernate from policy repos
2367         - POLICY-1457   Use Alpine in base docker images
2368
2369     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
2370         - S3P Performance related items
2371
2372     * [POLICY-1171] - Enhance CLC Facility
2373         - POLICY-1173   High-level specification of coordination directives
2374
2375     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
2376         - POLICY-1538   Upgrade Elasticsearch to 6.4.x to clear security issue
2377
2378     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
2379         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
2380         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
2381         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
2382         - POLICY-1273   Policy Type Application Design Requirements
2383         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
2384         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
2385         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
2386         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
2387         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
2388         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
2389         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
2390         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
2391         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
2392         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
2393         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
2394         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
2395         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
2396         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
2397         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
2398         - POLICY-1456   Policy Architecture and Roadmap Documentation
2399         - POLICY-1458   Create S3P JMeter Tests for Policy API
2400         - POLICY-1460   Create S3P JMeter Tests for PAP
2401         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
2402         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
2403         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
2404         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
2405         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
2406         - POLICY-1516   Prototype the Policy Decision API
2407         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
2408         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
2409
2410     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
2411         - Model drive control loop related items
2412
2413     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
2414         - POLICY-1405   Develop SDNC API for trigger bandwidth
2415
2416     * [POLICY-1408] - This epic covers the work done with the Casablanca release
2417         - POLICY-1410   List Policy API
2418         - POLICY-1413   Dashboard enhancements
2419         - POLICY-1414   Push Policy and DeletePolicy API enhancement
2420         - POLICY-1416   Model enhancements to support CLAMP
2421         - POLICY-1417   Resiliency improvements
2422         - POLICY-1418   PDP APIs - make ClientAuth optional
2423         - POLICY-1419   Better multi-role support
2424         - POLICY-1420   Model enhancement to support embedded JSON
2425         - POLICY-1421   New audit data for push/delete
2426         - POLICY-1422   Enhanced encryption
2427         - POLICY-1423   Save original model file
2428         - POLICY-1427   Controller Logging Feature
2429         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
2430         - POLICY-1499   Mdc Filter Feature
2431
2432     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
2433         - POLICY-1463   Functional code changes in Policy for OOF SON use case
2434         - POLICY-1464   Config related aspects for OOF SON use case
2435
2436     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
2437         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
2438         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
2439
2440     * Additional items delivered with the release.
2441         - POLICY-1159   Move expectException to policy-common/utils-test
2442         - POLICY-1176   Work on technical debt introduced by CLC POC
2443         - POLICY-1266   A&AI Modularity
2444         - POLICY-1274   further improvement in PSSD S3P test
2445         - POLICY-1401   Build onap.policies.Monitoring TOSCA Policy Template
2446         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
2447
2448
2449 **Bug Fixes**
2450
2451 The following bug fixes have been deployed with this release:
2452
2453     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
2454     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
2455     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
2456     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
2457     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
2458
2459 **Security Notes**
2460
2461 *Fixed Security Issues*
2462
2463     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
2464     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
2465     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
2466     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
2467
2468 *Known Security Issues*
2469
2470 *Known Vulnerabilities in Used Modules*
2471
2472 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>`_.
2473
2474 Quick Links:
2475     - `POLICY project page`_
2476     - `Passing Badge information for POLICY`_
2477     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
2478
2479
2480 **Known Issues**
2481
2482 The following known issues will be addressed in a future release:
2483
2484     * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
2485     * `[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.
2486     * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
2487     * `[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
2488     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
2489     * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
2490     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
2491     * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
2492     * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
2493     * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
2494     * `[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
2495     * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
2496     * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
2497     * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
2498     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
2499     * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
2500
2501
2502 ..      ==========================
2503 ..      * * *   CASABLANCA   * * *
2504 ..      ==========================
2505
2506 Version: 3.0.2
2507 --------------
2508
2509 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
2510
2511 The following items were deployed with the Casablanca Maintenance Release:
2512
2513 **Bug Fixes**
2514
2515     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
2516
2517 **Security Fixes**
2518
2519     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
2520
2521 **License Issues**
2522
2523     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
2524
2525 **Known Issues**
2526
2527 The following known issue will be addressed in a future release.
2528
2529     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
2530
2531 A workaround for this issue consists in bypassing the Portal UI when accessing the Policy UI. See the **PAP recipes**
2532 documentation for the specific procedure.
2533
2534
2535 Version: 3.0.1
2536 --------------
2537
2538 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
2539
2540 The following items were deployed with the Casablanca Maintenance Release:
2541
2542 **New Features**
2543
2544     * [POLICY-1221] - Policy distribution application to support HTTPS communication
2545     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
2546
2547 **Bug Fixes**
2548
2549     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
2550     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
2551
2552
2553 Version: 3.0.0
2554 --------------
2555
2556 :Release Date: 2018-11-30 (Casablanca Release)
2557
2558 **New Features**
2559
2560 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).
2561
2562     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
2563
2564     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
2565
2566     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
2567     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
2568     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
2569
2570     The policy team did some forward looking spike work towards re-building the Software Architecture.
2571
2572     * [POLICY-809] - Maintain and implement performance
2573     * [POLICY-814] - 72 hour stability testing (component and platform)
2574
2575     The policy team made enhancements to the Drools PDP to further support S3P Performance.
2576     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
2577     performance standard and performed 72 hour stability tests.
2578
2579     * [POLICY-824] - maintain and implement security
2580
2581     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
2582     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
2583
2584     * [POLICY-840] - Flexible control loop coordination facility.
2585
2586     Work towards a POC for control loop coordination policies were implemented.
2587
2588     * [POLICY-841] - Covers the work required to support HPA
2589
2590     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
2591
2592     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
2593
2594     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
2595
2596     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
2597
2598     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
2599     sonar issues, and checkstyle.
2600
2601     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
2602
2603     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
2604
2605     * [POLICY-1182] - Covers the work to support CCVPN use case
2606
2607     Policy templates changes were submitted that supported the CCVPN use case.
2608
2609 **Bug Fixes**
2610
2611 The following bug fixes have been deployed with this release:
2612
2613     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
2614     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
2615     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
2616     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
2617     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
2618     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
2619     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
2620     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
2621
2622
2623 **Security Notes**
2624
2625 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>`_.
2626
2627 Quick Links:
2628     - `POLICY project page`_
2629     - `Passing Badge information for POLICY`_
2630     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
2631
2632 **Known Issues**
2633
2634     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
2635     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
2636
2637
2638
2639 ..      =======================
2640 ..      * * *   BEIJING   * * *
2641 ..      =======================
2642
2643 Version: 2.0.0
2644 --------------
2645
2646 :Release Date: 2018-06-07 (Beijing Release)
2647
2648 **New Features**
2649
2650 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`_.
2651
2652     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
2653         - POLICY-238    policy/drools-applications: clean up maven structure
2654         - POLICY-336    Address Technical Debt
2655         - POLICY-338    Address JUnit Code Coverage
2656         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
2657         - POLICY-389    Cleanup Jenkin's CI/CD process's
2658         - POLICY-449    Policy API + Console : Common Policy Validation
2659         - POLICY-568    Integration with org.onap AAF project
2660         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
2661
2662     * [POLICY-391] - This epic covers the work to support Release Planning activities
2663         - POLICY-552    ONAP Licensing Scan - Use Restrictions
2664
2665     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
2666         - POLICY-529    Platform Maturity Performance - Drools PDP
2667         - POLICY-567    Platform Maturity Performance - PDP-X
2668
2669     * [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.
2670         - POLICY-488    pap should not add rules to official template provided in drools applications
2671
2672     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
2673         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
2674
2675     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
2676         - POLICY-622    Integrate OOF Policy Model into Policy Platform
2677
2678     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
2679         - POLICY-525    Platform Maturity Stability - Drools PDP
2680         - POLICY-526    Platform Maturity Stability - XACML PDP
2681
2682     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
2683         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
2684         - POLICY-528    Platform Maturity Resiliency - Drools PDP
2685         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
2686         - POLICY-585    Platform Maturity Resiliency - XACML PDP
2687         - POLICY-586    Platform Maturity Resiliency - Planning
2688         - POLICY-681    Regression Test Use Cases
2689
2690     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
2691         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
2692
2693     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
2694         - POLICY-531    Platform Maturity Scalability - XACML PDP
2695         - POLICY-532    Platform Maturity Scalability - Drools PDP
2696         - POLICY-623    Docker image re-design
2697
2698     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
2699         - POLICY-533    Platform Maturity Manageability L1 - Logging
2700         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
2701
2702     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
2703         - POLICY-535    Platform Maturity Usability - User Guide
2704         - POLICY-536    Platform Maturity Usability - Deployment Documentation
2705         - POLICY-537    Platform Maturity Usability - API Documentation
2706
2707     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
2708
2709
2710 **Bug Fixes**
2711
2712 The following bug fixes have been deployed with this release:
2713
2714     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
2715     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
2716     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
2717     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
2718     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
2719     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
2720     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
2721     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
2722     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
2723     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
2724     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
2725     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
2726     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
2727     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
2728     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
2729
2730
2731 **Security Notes**
2732
2733 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>`_.
2734
2735 Quick Links:
2736     - `POLICY project page`_
2737     - `Passing Badge information for POLICY`_
2738     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
2739
2740 **Known Issues**
2741
2742 The following known issues will be addressed in a future release:
2743
2744     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
2745     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
2746     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
2747     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
2748     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
2749     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
2750     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
2751     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
2752
2753
2754
2755
2756 Version: 1.0.2
2757 --------------
2758
2759 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
2760
2761 **Bug Fixes**
2762
2763 The following fixes were deployed with the Amsterdam Maintenance Release:
2764
2765     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
2766
2767
2768 Version: 1.0.1
2769 --------------
2770
2771 :Release Date: 2017-11-16 (Amsterdam Release)
2772
2773 **New Features**
2774
2775 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`_.
2776
2777     * [POLICY-31] - Stabilization of Seed Code
2778         - POLICY-25  Replace any remaining openecomp reference by onap
2779         - POLICY-32  JUnit test code coverage
2780         - POLICY-66  PDP-D Feature mechanism enhancements
2781         - POLICY-67  Rainy Day Decision Policy
2782         - POLICY-93  Notification API
2783         - POLICY-158  policy/engine: SQL injection Mitigation
2784         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
2785
2786     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
2787         - POLICY-40  MSB Integration
2788         - POLICY-124  Integration with oparent
2789         - POLICY-41  OOM Integration
2790         - POLICY-119  PDP-D: noop sinks
2791
2792     * [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.
2793         - POLICY-57  VF-C Actor code development
2794         - POLICY-43  Amsterdam Use Case Template
2795         - POLICY-173  Deployment of Operational Policies Documentation
2796
2797     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
2798         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
2799
2800     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
2801
2802     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
2803         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
2804         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
2805         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
2806         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
2807
2808     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
2809
2810     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
2811         - POLICY-61  vFW Use Case - Runtime
2812         - POLICY-62  vDNS Use Case - Runtime
2813         - POLICY-59  vCPE Use Case - Runtime
2814         - POLICY-60  VOLTE Use Case - Runtime
2815         - POLICY-51  Runtime Policy Update Support
2816         - POLICY-328  vDNS Use Case - Runtime Testing
2817         - POLICY-324  vFW Use Case - Runtime Testing
2818         - POLICY-320  VOLTE Use Case - Runtime Testing
2819         - POLICY-316  vCPE Use Case - Runtime Testing
2820
2821     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
2822         - POLICY-77  Functional Test case definition for Control Loops
2823         - POLICY-387  Deliver the released policy artifacts
2824
2825
2826 **Bug Fixes**
2827     - 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`_.
2828
2829
2830 **Known Issues**
2831     - 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.
2832
2833     - For vLBS Use Case, the following steps are required to setup the service instance:
2834         -  Create a Service Instance via VID.
2835         -  Create a VNF Instance via VID.
2836         -  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.
2837         -  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.
2838         -  Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
2839         -  Populate AAI with a dummy VF module for vDNS scaling.
2840
2841 **Security Issues**
2842     - None at this time
2843
2844 **Other**
2845     - None at this time
2846
2847
2848 .. Links to jira release notes
2849
2850 .. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
2851 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
2852 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
2853 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
2854 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
2855
2856 .. Links to Project related pages
2857
2858 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
2859 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
2860
2861
2862 .. note
2863 ..      CHANGE  HISTORY
2864 ..  09/19/2019 - Updated for El Alto Release.
2865 ..  05/16/2019 - Updated for Dublin Release.
2866 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
2867 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
2868 ..      Changed version number to use ONAP versions.
2869 ..      10/08/2018 - Initial document for Casablanca release.
2870 ..  05/29/2018 - Information for Beijing release.
2871 ..      03/22/2018 - Initial document for Beijing release.
2872 ..      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)
2873 ..      Also, Set up initial information for Beijing.
2874 ..      Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
2875
2876
2877 End of Release Notes
2878
2879 .. How to notes for SS
2880 ..  For initial document: list epic and user stories for each, list user stories with no epics.
2881 ..      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.
2882 ..      For Known issues, list bugs that are slotted for a future release.