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