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