blob: e145fe9cf32ef20a8c41f2e50f6b96cc7504e0da [file] [log] [blame]
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -04002
3.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
4.. _release_notes:
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04005
6Policy Release Notes
Jim Hahn961360a2020-11-10 16:36:00 -05007####################
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04008
9.. note
10.. * This Release Notes must be updated each time the team decides to Release new artifacts.
Pamela Dragoshc1c46402019-05-29 08:10:09 -040011.. * 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
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -040013.. * this Release Notes.
Pamela Dragoshc1c46402019-05-29 08:10:09 -040014.. * 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.
Jim Hahn961360a2020-11-10 16:36:00 -050016
Jim Hahnd2b1a172021-03-24 15:37:45 -040017.. ==========================
liamfallond9f7f242021-10-12 21:40:59 +010018.. * * * ISTANBUL * * *
19.. ==========================
20
liamfallon006a2292022-02-28 21:54:55 +000021Version: 9.0.1
22--------------
23
24:Release Date: 2022-02-17 (Istanbul Maintenance Release #1)
25
26**Artifacts**
27
28Artifacts released:
29
30.. list-table::
31 :widths: 15 10 10
32 :header-rows: 1
33
34 * - Repository
35 - Java Artifact
36 - Docker Image (if applicable)
37 * - policy/parent
38 - 3.4.4
39 - N/A
40 * - policy/docker
41 - 2.3.2
42 - | onap/policy-jdk-alpine:2.3.2
43 | onap/policy-jre-alpine:2.3.2
44 | onap/policy-db-migrator:2.3.2
45 * - policy/common
46 - 1.9.2
47 - N/A
48 * - policy/models
49 - 2.5.2
50 - N/A
51 * - policy/api
52 - 2.5.2
53 - onap/policy-api:2.5.2
54 * - policy/pap
55 - 2.5.2
56 - onap/policy-pap:2.5.2
57 * - policy/drools-pdp
58 - 1.9.2
59 - onap/policy-drools:1.9.2
60 * - policy/apex-pdp
61 - 2.6.2
62 - onap/policy-apex-pdp:2.6.2
63 * - policy/xacml-pdp
64 - 2.5.2
65 - onap/policy-xacml-pdp:2.5.2
66 * - policy/drools-applications
67 - 1.9.2
68 - onap/policy-pdpd-cl:1.9.2
69 * - policy/clamp
70 - 6.1.4
71 - | onap/policy-clamp-backend:6.1.4
72 | onap/policy-clamp-frontend:6.1.4
73 | onap/policy-clamp-cl-pf-ppnt:6.1.4
74 | onap/policy-clamp-cl-k8s-ppnt:6.1.4
75 | onap/policy-clamp-cl-http-ppnt:6.1.4
76 | onap/policy-clamp-cl-runtime:6.1.4
77 * - policy/gui
78 - 2.1.2
79 - onap/policy-gui:2.1.2
80 * - policy/distribution
81 - 2.6.2
82 - onap/policy-distribution:2.6.2
83
84**Bug Fixes and Necessary Enhancements**
85
86 * `[POLICY-3862] <https://jira.onap.org/browse/POLICY-3862>`_
87 - Check all code for Log4J before version 2.15.0 and upgrade if necessary
88
liamfallond9f7f242021-10-12 21:40:59 +010089Version: 9.0.0
90--------------
91
liamfallon14e4c602021-11-02 13:43:05 +000092:Release Date: 2021-11-04 (Istanbul Release)
liamfallond9f7f242021-10-12 21:40:59 +010093
94New features
95============
96
97Artifacts released:
98
liamfallond9f7f242021-10-12 21:40:59 +010099.. list-table::
100 :widths: 15 10 10
101 :header-rows: 1
102
103 * - Repository
104 - Java Artifact
105 - Docker Image (if applicable)
106 * - policy/parent
107 - 3.4.3
108 - N/A
109 * - policy/docker
110 - 2.3.1
111 - | onap/policy-jdk-alpine:2.3.1
112 | onap/policy-jre-alpine:2.3.1
liamfallon017ce882021-11-08 13:38:29 +0000113 | onap/policy-db-migrator:2.3.1
liamfallond9f7f242021-10-12 21:40:59 +0100114 * - policy/common
115 - 1.9.1
116 - N/A
117 * - policy/models
118 - 2.5.1
119 - N/A
120 * - policy/api
121 - 2.5.1
122 - onap/policy-api:2.5.1
123 * - policy/pap
124 - 2.5.1
125 - onap/policy-pap:2.5.1
126 * - policy/drools-pdp
127 - 1.9.1
128 - onap/policy-drools:1.9.1
129 * - policy/apex-pdp
130 - 2.6.1
131 - onap/policy-apex-pdp:2.6.1
132 * - policy/xacml-pdp
133 - 2.5.1
134 - onap/policy-xacml-pdp:2.5.1
135 * - policy/drools-applications
136 - 1.9.1
137 - onap/policy-pdpd-cl:1.9.1
138 * - policy/clamp
139 - 6.1.3
140 - | onap/policy-clamp-backend:6.1.3
141 | onap/policy-clamp-frontend:6.1.3
142 | onap/policy-clamp-cl-pf-ppnt:6.1.3
143 | onap/policy-clamp-cl-k8s-ppnt:6.1.3
144 | onap/policy-clamp-cl-http-ppnt:6.1.3
145 | onap/policy-clamp-cl-runtime:6.1.3
146 * - policy/gui
147 - 2.1.1
148 - onap/policy-gui:2.1.1
149 * - policy/distribution
150 - 2.6.1
151 - onap/policy-distribution:2.6.1
152
153Key Updates
154===========
155
156Clamp -> policy
157Control Loop
158Database
159
160* `REQ-684 <https://jira.onap.org/browse/REQ-684>`_ - Merge CLAMP functionality into Policy Framework project
161 - keep CLAMP functions into ONAP
162 - reduce ONAP footprint
163 - consolidate the UI (Control loop UI and policy)
164 - enables code sharing and common handling for REST and TOSCA
165 - introduces the Spring Framework into the Policy Framework
166 - see `the CLAMP documentation <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp/clamp.html>`_
167
168* `REQ-716 <https://jira.onap.org/browse/REQ-716>`_ - Control Loop in TOSCA LCM
169 - Allows Control Loops to be defined and described in Metadata using TOSCA
170 - Control loops can run on the fly on any component that implements a *participant* API
171 - Control Loops can be commissioned into Policy/CLAMP, they can be parameterized, initiated on arbitrary
172 participants, activated and monitored
173 - See `the CLAMP TOSCA Control Loop documentation
174 <https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/controlloop/controlloop.html>`_
175
176* CLAMP Client Policy and TOSCA Handling
177 - Push existing policy(tree) into pdp
178 - Handling of PDP Groups
179 - Handling of Policy Types
180 - Handling of TOSCA Service Templates
181 - Push of Policies to PDPs
182 - Support multiple PDP Groups per Policy Type
183 - Tree view in Policies list
184 - Integration of new TOSCA Control Loop GUI into CLAMP GUI
185
186* Policy Handling Improvements
187 - Support delta policies in PDPs
188 - Allow XACML rules to specify EventManagerService
189 - Sending of notifications to Kafka & Rest in apex-pdp policies
190 - External configuration of groups other than defaultGroup
191 - XACML Decision support for Multiple Requests
192 - Updated query parameter names and support for wildcards in APIs
193 - Added new APIs for Policy Audit capabilities
194 - Capability to send multiple output events from a state in APEX-PDP
195
196* System Attribute Improvements
197 - Support for upgrade and rollback, starting with upgrade from the Honolulu release to the Istanbul release
198 - Consolidated health check
199 - Phase 1 of Spring Framework introduction
200 - Phase 1 of Prometheus introduction, base Prometheus metrics
201
202Known Limitations, Issues and Workarounds
203=========================================
204
205System Limitations
206~~~~~~~~~~~~~~~~~~
207N/A
208
209Known Vulnerabilities
210~~~~~~~~~~~~~~~~~~~~~
211N/A
212
213Workarounds
214~~~~~~~~~~~
215N/A
216
217Security Notes
218==============
219
220| `POLICY-3169 <https://jira.onap.org/browse/POLICY-3169>`_ - Remove security issues reported by NEXUS-IQ
221| `POLICY-3315 <https://jira.onap.org/browse/POLICY-3315>`_ - Review license scan issues
222| `POLICY-3327 <https://jira.onap.org/browse/POLICY-3327>`_ - OOM AAF generated certificates contain invalid SANs entries
223| `POLICY-3338 <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
224| `POLICY-3384 <https://jira.onap.org/browse/POLICY-3384>`_ - Use signed certificates in the CSITs
225| `POLICY-3431 <https://jira.onap.org/browse/POLICY-3431>`_ - Review license scan issues
226| `POLICY-3516 <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
227| `POLICY-3590 <https://jira.onap.org/browse/POLICY-3590>`_ - Address security vulnerabilities and License issues in Policy Framework
228| `POLICY-3697 <https://jira.onap.org/browse/POLICY-3697>`_ - Review license scan issues
229
230
231Functional Improvements
232=======================
233| `REQ-684 <https://jira.onap.org/browse/REQ-684>`_ - Merge CLAMP functionality into Policy Framework project
234| `REQ-716 <https://jira.onap.org/browse/REQ-716>`_ - Control Loop in TOSCA LCM
235| `POLICY-1787 <https://jira.onap.org/browse/POLICY-1787>`_ - Support mariadb upgrade/rollback functionality
236| `POLICY-2535 <https://jira.onap.org/browse/POLICY-2535>`_ - Query deployed policies by regex on the name, for a given policy type
237| `POLICY-2618 <https://jira.onap.org/browse/POLICY-2618>`_ - PDP-D make legacy configuration interface (used by brmsgw) an optional feature
238| `POLICY-2769 <https://jira.onap.org/browse/POLICY-2769>`_ - Support multiple PAP instances
239| `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
240| `POLICY-2896 <https://jira.onap.org/browse/POLICY-2896>`_ - Improve consolidated health check to include dependencies
241| `POLICY-2920 <https://jira.onap.org/browse/POLICY-2920>`_ - policy-clamp ui is capable to push and existing policy(tree) into pdp
242| `POLICY-2921 <https://jira.onap.org/browse/POLICY-2921>`_ - use the policy-clamp ui to manage pdp groups
243| `POLICY-2923 <https://jira.onap.org/browse/POLICY-2923>`_ - use the policy-clamp ui to manage policy types
244| `POLICY-2930 <https://jira.onap.org/browse/POLICY-2930>`_ - clamp-backend rest api to push policies to pdp
245| `POLICY-2931 <https://jira.onap.org/browse/POLICY-2931>`_ - clamp GUI to push policy to pdp
246| `POLICY-3072 <https://jira.onap.org/browse/POLICY-3072>`_ - clamp ui support multiple pdp group per policy type
247| `POLICY-3107 <https://jira.onap.org/browse/POLICY-3107>`_ - Support delta policies in PDPs
248| `POLICY-3165 <https://jira.onap.org/browse/POLICY-3165>`_ - Implement tree view in policies list
249| `POLICY-3209 <https://jira.onap.org/browse/POLICY-3209>`_ - CLAMP Component Lifecycle Management using Spring Framework
250| `POLICY-3218 <https://jira.onap.org/browse/POLICY-3218>`_ - Integrate CLAMP GUIs (Instantiation/Monitoring) in the policy-gui repo
251| `POLICY-3227 <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
252| `POLICY-3228 <https://jira.onap.org/browse/POLICY-3228>`_ - Implement clamp backend part to add policy models api
253| `POLICY-3229 <https://jira.onap.org/browse/POLICY-3229>`_ - Implement the front end part to add tosca model
254| `POLICY-3230 <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
255| `POLICY-3260 <https://jira.onap.org/browse/POLICY-3260>`_ - Allow rules to specify EventManagerService
256| `POLICY-3324 <https://jira.onap.org/browse/POLICY-3324>`_ - Design a solution for sending notifications to Kafka & Rest in apex-pdp policies
257| `POLICY-3331 <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
258| `POLICY-3340 <https://jira.onap.org/browse/POLICY-3340>`_ - Create REST API's in PAP to fetch the audit information stored in DB
259| `POLICY-3514 <https://jira.onap.org/browse/POLICY-3514>`_ - XACML Decision support for Multiple Requests
260| `POLICY-3524 <https://jira.onap.org/browse/POLICY-3524>`_ - Explore options to integrate prometheus with policy framework components
261| `POLICY-3527 <https://jira.onap.org/browse/POLICY-3527>`_ - Update query parameter names in policy audit api's
262| `POLICY-3533 <https://jira.onap.org/browse/POLICY-3533>`_ - PDP-D: make DB port provisionable
263| `POLICY-3538 <https://jira.onap.org/browse/POLICY-3538>`_ - Export basic metrics from policy components for prometheus
264| `POLICY-3545 <https://jira.onap.org/browse/POLICY-3545>`_ - Use generic create policy url in policy/distribution
265| `POLICY-3557 <https://jira.onap.org/browse/POLICY-3557>`_ - Export basic prometheus metrics from clamp
266
267Necessary Improvements and Bug Fixes
268====================================
269
270Necessary Improvements
271~~~~~~~~~~~~~~~~~~~~~~
272| `POLICY-2418 <https://jira.onap.org/browse/POLICY-2418>`_ - Refactor XACML PDP POJO's into Bean objects in order to perform validation more simply
273| `POLICY-2429 <https://jira.onap.org/browse/POLICY-2429>`_ - Mark policy/engine read-only and remove ci-management jobs for it
274| `POLICY-2542 <https://jira.onap.org/browse/POLICY-2542>`_ - Improve the REST parameter validation for PAP api's
275| `POLICY-2767 <https://jira.onap.org/browse/POLICY-2767>`_ - Improve error handling of drools-pdp when requestID in onset is not valid UUID
276| `POLICY-2899 <https://jira.onap.org/browse/POLICY-2899>`_ - Store basic audit details of deploy/undeploy operations in PAP
277| `POLICY-2996 <https://jira.onap.org/browse/POLICY-2996>`_ - Address technical debt left over from Honolulu
278| `POLICY-3059 <https://jira.onap.org/browse/POLICY-3059>`_ - Fix name of target-database property in persistence.xml files
279| `POLICY-3062 <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
280| `POLICY-3078 <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
281| `POLICY-3087 <https://jira.onap.org/browse/POLICY-3087>`_ - Use sl4fj instead of EELFLogger
282| `POLICY-3089 <https://jira.onap.org/browse/POLICY-3089>`_ - Cleanup logs for success/failure consumers in apex-pdp
283| `POLICY-3096 <https://jira.onap.org/browse/POLICY-3096>`_ - Fix intermittent test failures in APEX
284| `POLICY-3128 <https://jira.onap.org/browse/POLICY-3128>`_ - Use command command-line handler across policy repos
285| `POLICY-3129 <https://jira.onap.org/browse/POLICY-3129>`_ - Refactor command-line handling across policy-repos
286| `POLICY-3132 <https://jira.onap.org/browse/POLICY-3132>`_ - Apex-pdp documentation refers to missing logos.png
287| `POLICY-3134 <https://jira.onap.org/browse/POLICY-3134>`_ - Use base image for policy-jdk docker images
288| `POLICY-3136 <https://jira.onap.org/browse/POLICY-3136>`_ - Ignore jacoco and checkstyle when in eclipse
289| `POLICY-3143 <https://jira.onap.org/browse/POLICY-3143>`_ - Remove keystore files from policy repos
290| `POLICY-3145 <https://jira.onap.org/browse/POLICY-3145>`_ - HTTPS clients should not allow self-signed certificates
291| `POLICY-3147 <https://jira.onap.org/browse/POLICY-3147>`_ - Xacml-pdp should not use RestServerParameters for client parameters
292| `POLICY-3155 <https://jira.onap.org/browse/POLICY-3155>`_ - Use python3 for CSITs
293| `POLICY-3160 <https://jira.onap.org/browse/POLICY-3160>`_ - Use "sh" instead of "ash" where possible
294| `POLICY-3163 <https://jira.onap.org/browse/POLICY-3163>`_ - Remove spaces from xacml file name
295| `POLICY-3166 <https://jira.onap.org/browse/POLICY-3166>`_ - Use newer onap base image in clamp
296| `POLICY-3171 <https://jira.onap.org/browse/POLICY-3171>`_ - Fix sporadic error in models provider junits
297| `POLICY-3175 <https://jira.onap.org/browse/POLICY-3175>`_ - Minor clean-up of drools-apps
298| `POLICY-3182 <https://jira.onap.org/browse/POLICY-3182>`_ - Update npm repo
299| `POLICY-3189 <https://jira.onap.org/browse/POLICY-3189>`_ - Create a new key class which uses the @GeneratedValue annotation
300| `POLICY-3190 <https://jira.onap.org/browse/POLICY-3190>`_ - Investigate handling of context albums in Apex-PDP for failure responses (ex - AAI)
301| `POLICY-3198 <https://jira.onap.org/browse/POLICY-3198>`_ - Remove VirtualControlLoopEvent from OperationsHistory classes
302| `POLICY-3211 <https://jira.onap.org/browse/POLICY-3211>`_ - Parameter Handling and Parameter Validation
303| `POLICY-3214 <https://jira.onap.org/browse/POLICY-3214>`_ - Change Monitoring UI implementation to use React
304| `POLICY-3215 <https://jira.onap.org/browse/POLICY-3215>`_ - Update CLAMP Module structure to Multi Module Maven approach
305| `POLICY-3221 <https://jira.onap.org/browse/POLICY-3221>`_ - wrong lifecycle state information in INFO.yaml for policy/clamp
306| `POLICY-3222 <https://jira.onap.org/browse/POLICY-3222>`_ - Use existing clamp gui to set the parameters during CL instantiation
307| `POLICY-3235 <https://jira.onap.org/browse/POLICY-3235>`_ - gui-editor-apex fails to start
308| `POLICY-3257 <https://jira.onap.org/browse/POLICY-3257>`_ - Update csit test cases to include policy status & statistics api's
309| `POLICY-3261 <https://jira.onap.org/browse/POLICY-3261>`_ - Rules need a way to release locks
310| `POLICY-3262 <https://jira.onap.org/browse/POLICY-3262>`_ - Extract more common code from UsecasesEventManager
311| `POLICY-3292 <https://jira.onap.org/browse/POLICY-3292>`_ - Update the XACML PDP Tutorial docker compose files to point to release Honolulu images
312| `POLICY-3298 <https://jira.onap.org/browse/POLICY-3298>`_ - Add key names to IndexedXxx factory class toString() methods
313| `POLICY-3299 <https://jira.onap.org/browse/POLICY-3299>`_ - Merge policy CSITs into docker/csit
314| `POLICY-3300 <https://jira.onap.org/browse/POLICY-3300>`_ - PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR ISTANBUL
315| `POLICY-3303 <https://jira.onap.org/browse/POLICY-3303>`_ - Update the default logback.xml in APEX to log to STDOUT
316| `POLICY-3305 <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
317| `POLICY-3306 <https://jira.onap.org/browse/POLICY-3306>`_ - Fix issue where apex-pdp test is failing in gitlab
318| `POLICY-3307 <https://jira.onap.org/browse/POLICY-3307>`_ - Turn off frankfurt CSITs
319| `POLICY-3333 <https://jira.onap.org/browse/POLICY-3333>`_ - bean validator should use SerializedName
320| `POLICY-3336 <https://jira.onap.org/browse/POLICY-3336>`_ - APEX CLI/Model: multiple outputs for nextState NULL
321| `POLICY-3337 <https://jira.onap.org/browse/POLICY-3337>`_ - Move clamp documentation to policy/parent
322| `POLICY-3366 <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
323| `POLICY-3367 <https://jira.onap.org/browse/POLICY-3367>`_ - oom: policy-clamp-create-tables.sql: add IF NOT EXISTS clauses
324| `POLICY-3374 <https://jira.onap.org/browse/POLICY-3374>`_ - Docker registry should be defined in the parent pom
325| `POLICY-3378 <https://jira.onap.org/browse/POLICY-3378>`_ - Move groovy scripts to separate/common file
326| `POLICY-3382 <https://jira.onap.org/browse/POLICY-3382>`_ - Create document for policy chaining in drools-pdp
327| `POLICY-3383 <https://jira.onap.org/browse/POLICY-3383>`_ - Standardize policy deployment vs undeployment count in PdpStatistics
328| `POLICY-3388 <https://jira.onap.org/browse/POLICY-3388>`_ - policy/gui merge jobs failing
329| `POLICY-3389 <https://jira.onap.org/browse/POLICY-3389>`_ - Use lombok annotations instead of hashCode, equals, toString, get, set
330| `POLICY-3404 <https://jira.onap.org/browse/POLICY-3404>`_ - Rolling DB errors in log output for API, PAP, and DB components
331| `POLICY-3419 <https://jira.onap.org/browse/POLICY-3419>`_ - Remove operationshistory10 DB
332| `POLICY-3450 <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
333| `POLICY-3456 <https://jira.onap.org/browse/POLICY-3456>`_ - Use new RestClientParameters class instead of BusTopicParams
334| `POLICY-3457 <https://jira.onap.org/browse/POLICY-3457>`_ - Topic source should not go into fast-fail loop when dmaap is unreachable
335| `POLICY-3459 <https://jira.onap.org/browse/POLICY-3459>`_ - Document how to turn off collection of PdpStatistics
336| `POLICY-3473 <https://jira.onap.org/browse/POLICY-3473>`_ - CSIT for xacml doesn't check dmaap msg status
337| `POLICY-3474 <https://jira.onap.org/browse/POLICY-3474>`_ - Delete extra simulators from policy-models
338| `POLICY-3486 <https://jira.onap.org/browse/POLICY-3486>`_ - policy-jdk docker image should have at least one up to date image
339| `POLICY-3499 <https://jira.onap.org/browse/POLICY-3499>`_ - Improve Apex-PDP logs to avoid printing errors for irrelevant events in multiple policy deployment
340| `POLICY-3501 <https://jira.onap.org/browse/POLICY-3501>`_ - Refactor guard actor
341| `POLICY-3511 <https://jira.onap.org/browse/POLICY-3511>`_ - Limit statistics record count
342| `POLICY-3525 <https://jira.onap.org/browse/POLICY-3525>`_ - Improve policy/pap csit automation test cases
343| `POLICY-3528 <https://jira.onap.org/browse/POLICY-3528>`_ - Update documents & postman collection for pdp statistics api's
344| `POLICY-3531 <https://jira.onap.org/browse/POLICY-3531>`_ - PDP-X: initialization delays causes liveness checks to be missed under OOM deployment
345| `POLICY-3532 <https://jira.onap.org/browse/POLICY-3532>`_ - Add Honolulu Maintenance Release notes to read-the-docs
346| `POLICY-3539 <https://jira.onap.org/browse/POLICY-3539>`_ - Use RestServer from policy/common in apex-pdp
347| `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
348| `POLICY-3556 <https://jira.onap.org/browse/POLICY-3556>`_ - Document xacml REST server limitations
349| `POLICY-3605 <https://jira.onap.org/browse/POLICY-3605>`_ - Enhance dmaap simulator to support ""/topics" endpoint
350| `POLICY-3609 <https://jira.onap.org/browse/POLICY-3609>`_ - Add CSIT test case for policy consolidated health check
351
352Bug Fixes
353~~~~~~~~~
354| `POLICY-2845 <https://jira.onap.org/browse/POLICY-2845>`_ - Policy dockers contain GPLv3
355| `POLICY-3066 <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
356| `POLICY-3161 <https://jira.onap.org/browse/POLICY-3161>`_ - OOM clamp BE/FE do not start properly when clamp db exists in the cluster
357| `POLICY-3174 <https://jira.onap.org/browse/POLICY-3174>`_ - POLICY-APEX log does not include the DATE in STDOUT
358| `POLICY-3176 <https://jira.onap.org/browse/POLICY-3176>`_ - POLICY-DROOLS log does not include the DATE in STDOUT
359| `POLICY-3177 <https://jira.onap.org/browse/POLICY-3177>`_ - POLICY-PAP log does not include the DATE in STDOUT
360| `POLICY-3201 <https://jira.onap.org/browse/POLICY-3201>`_ - fix CRITICAL weak-cryptography issues identified in sonarcloud
361| `POLICY-3202 <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
362| `POLICY-3203 <https://jira.onap.org/browse/POLICY-3203>`_ - Update the PDP deployment in policy window failure
363| `POLICY-3204 <https://jira.onap.org/browse/POLICY-3204>`_ - Clamp UI does not accept to deploy policy to PDP
364| `POLICY-3205 <https://jira.onap.org/browse/POLICY-3205>`_ - The submit operation in Clamp cannot be achieved successfully
365| `POLICY-3225 <https://jira.onap.org/browse/POLICY-3225>`_ - Clamp policy UI does not send right pdp command
366| `POLICY-3226 <https://jira.onap.org/browse/POLICY-3226>`_ - Clamp policy UI does 2 parallel queries to policy list
367| `POLICY-3248 <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
368| `POLICY-3301 <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
369| `POLICY-3322 <https://jira.onap.org/browse/POLICY-3322>`_ - gui-editor-apex doesn't contain webapp correctly
370| `POLICY-3332 <https://jira.onap.org/browse/POLICY-3332>`_ - Issues around delta policy deployment in APEX
371| `POLICY-3369 <https://jira.onap.org/browse/POLICY-3369>`_ - Modify NSSI closed loop not running
372| `POLICY-3445 <https://jira.onap.org/browse/POLICY-3445>`_ - Version conflicts in spring boot dependency jars in CLAMP
373| `POLICY-3454 <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
374| `POLICY-3468 <https://jira.onap.org/browse/POLICY-3468>`_ - PDPD-CL APPS: Clean up library transitive dependencies conflicts (jackson version) from new CDS libraries
375| `POLICY-3507 <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
376| `POLICY-3526 <https://jira.onap.org/browse/POLICY-3526>`_ - OOM start of policy-distribution fails (keyStore values)
377| `POLICY-3558 <https://jira.onap.org/browse/POLICY-3558>`_ - Delete Instance Properties if Instantiation is Unitialized
378| `POLICY-3600 <https://jira.onap.org/browse/POLICY-3600>`_ - Some REST calls in Clamp GUI do not include pathname
379| `POLICY-3601 <https://jira.onap.org/browse/POLICY-3601>`_ - Static web resource paths in gui-editor-apex are incorrect
380| `POLICY-3602 <https://jira.onap.org/browse/POLICY-3602>`_ - Context schema table is not populated in Apex Editor
381| `POLICY-3603 <https://jira.onap.org/browse/POLICY-3603>`_ - gui-pdp-monitoring broken in gui docker image
382| `POLICY-3608 <https://jira.onap.org/browse/POLICY-3608>`_ - LASTUPDATE column in pdp table causing Nullpointer Exception in PAP initialization
383| `POLICY-3610 <https://jira.onap.org/browse/POLICY-3610>`_ - PDP-D-APPS: audit and metric logging information is incorrect
384| `POLICY-3611 <https://jira.onap.org/browse/POLICY-3611>`_ - "API,PAP: decrease eclipselink verbosity in persistence.xml"
385| `POLICY-3625 <https://jira.onap.org/browse/POLICY-3625>`_ - Terminated PDPs are not being removed by PAP
386| `POLICY-3637 <https://jira.onap.org/browse/POLICY-3637>`_ - Policy-mariadb connection intermittently fails from PF components
387| `POLICY-3639 <https://jira.onap.org/browse/POLICY-3639>`_ - CLAMP_REST_URL environment variable is not needed
388| `POLICY-3647 <https://jira.onap.org/browse/POLICY-3647>`_ - Cannot create Instance from Policy GUI
389| `POLICY-3649 <https://jira.onap.org/browse/POLICY-3649>`_ - SSL Handshake failure between CL participants and DMaap
390| `POLICY-3650 <https://jira.onap.org/browse/POLICY-3650>`_ - Disable apex-editor and pdp-monitoring in gui docker
391| `POLICY-3660 <https://jira.onap.org/browse/POLICY-3660>`_ - DB-Migrator job completes even during failed upgrade
392| `POLICY-3678 <https://jira.onap.org/browse/POLICY-3678>`_ - K8s participants tests are skipped due to json parsing error.
393| `POLICY-3679 <https://jira.onap.org/browse/POLICY-3679>`_ - Modify pdpstatistics to prevent duplicate keys
394| `POLICY-3680 <https://jira.onap.org/browse/POLICY-3680>`_ - PDP Monitoring GUI fails to parse JSON from PAP
395| `POLICY-3682 <https://jira.onap.org/browse/POLICY-3682>`_ - Unable to list the policies in Policy UI
396| `POLICY-3683 <https://jira.onap.org/browse/POLICY-3683>`_ - clamp-fe & policy-gui: useless rolling logs
397| `POLICY-3684 <https://jira.onap.org/browse/POLICY-3684>`_ - Unable to select a PDP group & Subgroup when configuring a control loop policy
398| `POLICY-3685 <https://jira.onap.org/browse/POLICY-3685>`_ - Fix CL state change issues in runtime and participants
399| `POLICY-3686 <https://jira.onap.org/browse/POLICY-3686>`_ - Update Participant Status after Commissioning
400| `POLICY-3687 <https://jira.onap.org/browse/POLICY-3687>`_ - Continuous sending CONTROL_LOOP_STATE_CHANGE message
401| `POLICY-3688 <https://jira.onap.org/browse/POLICY-3688>`_ - Register participant in ParticipantRegister message
402| `POLICY-3689 <https://jira.onap.org/browse/POLICY-3689>`_ - Handle ParticipantRegister
403| `POLICY-3691 <https://jira.onap.org/browse/POLICY-3691>`_ - Problems Parsing Service Template
404| `POLICY-3695 <https://jira.onap.org/browse/POLICY-3695>`_ - Tosca Constraint "in_range" not supported by policy/models
405| `POLICY-3706 <https://jira.onap.org/browse/POLICY-3706>`_ - Telemetry not working in drools-pdp
406| `POLICY-3707 <https://jira.onap.org/browse/POLICY-3707>`_ - Cannot delete a loop in design state
407
408References
409==========
410
411For more information on the ONAP Istanbul release, please see:
412
413#. `ONAP Home Page`_
414#. `ONAP Documentation`_
415#. `ONAP Release Downloads`_
416#. `ONAP Wiki Page`_
417
418.. _`ONAP Home Page`: https://www.onap.org
419.. _`ONAP Wiki Page`: https://wiki.onap.org
420.. _`ONAP Documentation`: https://docs.onap.org
421.. _`ONAP Release Downloads`: https://git.onap.org
422
423Quick Links:
424 - `POLICY project page`_
425 - `Passing Badge information for POLICY`_
426
427.. ==========================
Jim Hahnd2b1a172021-03-24 15:37:45 -0400428.. * * * HONOLULU * * *
429.. ==========================
430
Jim Hahne057e162021-08-06 10:04:42 -0400431Version: 8.0.1
432--------------
433
434:Release Date: 2021-08-12 (Honolulu Maintenance Release #1)
435
436**Artifacts**
437
438Artifacts released:
439
440.. csv-table::
441 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
442 :widths: 15,10,10
443
444 "policy/parent", "3.3.2", ""
445 "policy/common", "1.8.2", ""
446 "policy/models", "2.4.4", ""
447 "policy/api", "2.4.4", "onap/policy-api:2.4.4"
448 "policy/pap", "2.4.5", "onap/policy-pap:2.4.5"
449 "policy/drools-pdp", "1.8.4", "onap/policy-drools:1.8.4"
450 "policy/apex-pdp", "2.5.4", "onap/policy-apex-pdp:2.5.4"
Jim Hahnce52d632021-08-31 10:06:47 -0400451 "policy/xacml-pdp", "2.4.5", "onap/policy-xacml-pdp:2.4.5"
Jim Hahne057e162021-08-06 10:04:42 -0400452 "policy/drools-applications", "1.8.4", "onap/policy-pdpd-cl:1.8.4"
453 "policy/distribution", "2.5.4", "onap/policy-distribution:2.5.4"
454 "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
455
456
457**Bug Fixes and Necessary Enhancements**
458
459
460 * `[POLICY-3062] <https://jira.onap.org/browse/POLICY-3062>`_ - Update the ENTRYPOINT in APEX-PDP Dockerfile
461 * `[POLICY-3066] <https://jira.onap.org/browse/POLICY-3066>`_ - Stackoverflow error in APEX standalone after changing to onap java image
462 * `[POLICY-3078] <https://jira.onap.org/browse/POLICY-3078>`_ - Support SSL communication in Kafka IO plugin of Apex-PDP
463 * `[POLICY-3173] <https://jira.onap.org/browse/POLICY-3173>`_ - APEX-PDP incorrectly reports successful policy deployment to PAP
464 * `[POLICY-3202] <https://jira.onap.org/browse/POLICY-3202>`_ - PDP-D: no locking feature: service loader not locking the no-lock-manager
465 * `[POLICY-3227] <https://jira.onap.org/browse/POLICY-3227>`_ - Implementation of context album improvements in apex-pdp
466 * `[POLICY-3230] <https://jira.onap.org/browse/POLICY-3230>`_ - Make default PDP-D and PDP-D-APPS work out of the box
467 * `[POLICY-3248] <https://jira.onap.org/browse/POLICY-3248>`_ - PdpHeartbeats are not getting processed by PAP
468 * `[POLICY-3301] <https://jira.onap.org/browse/POLICY-3301>`_ - Apex Avro Event Schemas - Not support for colon ':' character in field names
469 * `[POLICY-3305] <https://jira.onap.org/browse/POLICY-3305>`_ - Ensure XACML PDP application/translator methods are extendable
470 * `[POLICY-3331] <https://jira.onap.org/browse/POLICY-3331>`_ - PAP: should allow for external configuration of groups other than defaultGroup
471 * `[POLICY-3338] <https://jira.onap.org/browse/POLICY-3338>`_ - Upgrade CDS dependency to the latest version
472 * `[POLICY-3366] <https://jira.onap.org/browse/POLICY-3366>`_ - PDP-D: support configuration of overarching DMAAP https flag
473 * `[POLICY-3450] <https://jira.onap.org/browse/POLICY-3450>`_ - PAP should support turning on/off via configuration storing PDP statistics
474 * `[POLICY-3454] <https://jira.onap.org/browse/POLICY-3454>`_ - PDP-D CL APPS: swagger mismatched libraries cause telemetry shell to fail
475 * `[POLICY-3485] <https://jira.onap.org/browse/POLICY-3485>`_ - Limit statistics record count
476 * `[POLICY-3507] <https://jira.onap.org/browse/POLICY-3507>`_ - CDS Operation Policy execution runtime error
477 * `[POLICY-3516] <https://jira.onap.org/browse/POLICY-3516>`_ - Upgrade CDS dependency to the 1.1.5 version
478
479
Jim Hahna7b369a2021-08-30 15:12:29 -0400480Known Limitations
481=================
482
483The APIs provided by xacml-pdp (e.g., healthcheck, statistics, decision)
484are always active. While PAP controls which policies are deployed to a
485xacml-pdp, it does not control whether or not the APIs are active.
486In other words, xacml-pdp will respond to decision requests, regardless
487of whether PAP has made it ACTIVE or PASSIVE.
488
489
Jim Hahnd2b1a172021-03-24 15:37:45 -0400490Version: 8.0.0
491--------------
492
Jim Hahn483d5c02021-04-27 11:14:43 -0400493:Release Date: 2021-04-29 (Honolulu Release)
Jim Hahnd2b1a172021-03-24 15:37:45 -0400494
495New features
496============
497
498Artifacts released:
499
500.. csv-table::
501 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
502 :widths: 15,10,10
503
504 "policy/parent", "3.3.0", ""
505 "policy/common", "1.8.0", ""
506 "policy/models", "2.4.2", ""
507 "policy/api", "2.4.2", "onap/policy-api:2.4.2"
508 "policy/pap", "2.4.2", "onap/policy-pap:2.4.2"
509 "policy/drools-pdp", "1.8.2", "onap/policy-drools:1.8.2"
510 "policy/apex-pdp", "2.5.2", "onap/policy-apex-pdp:2.5.2"
511 "policy/xacml-pdp", "2.4.2", "onap/policy-xacml-pdp:2.4.2"
512 "policy/drools-applications", "1.8.2", "onap/policy-pdpd-cl:1.8.2"
513 "policy/distribution", "2.5.2", "onap/policy-distribution:2.5.2"
514 "policy/docker", "2.2.1", "onap/policy-jdk-alpine:2.2.1, onap/policy-jre-alpine:2.2.1"
515
516Key Updates
517===========
518
519* Enhanced statistics
520 - PDPs provide statistics, retrievable via PAP REST API
521* PDP deployment status
522 - Policy deployment API enhanced to reflect actual policy deployment status in PDPs
523 - Make PAP component stateless
524* Policy support
525 - Upgrade XACML 3.0 code to use new Time Extensions
526 - Enhancements for interoperability between Native Policies and other policy types
527 - Support for arbitrary policy types on the Drools PDP
528 - Improve handling of multiple policies in APEX PDP
529 - Update policy-models TOSCA handling with Control Loop Entities
530* Alternative locking mechanisms
531 - Support NO locking feature in Drools-PDP
532* Security
533 - Remove credentials in code from the Apex JMS plugin
534* Actor enhancements
535 - Actors should give better warnings than NPE when data is missing
536 - Remove old event-specific actor code
537* PDP functional assignments
538 - Make PDP type configurable in drools-pdp
539 - Make PDP type configurable in xacml-pdp
540* Performance improvements
541 - Support policy updates between PAP and the PDPs, phase 1
542* Maintainability
543 - Use ONAP base docker image
544 - Remove GPLv3 components from docker containers
545 - Move CSITs to Policy repos
546 - Deprecate server pool feature in drools-pdp
547* PoCs
548 - Merge CLAMP functionality into Policy Framework project
549 - TOSCA Defined Control Loop
550
551
552Known Limitations, Issues and Workarounds
553=========================================
554
555System Limitations
556~~~~~~~~~~~~~~~~~~
557
558The policy API component requires a fresh new database when migrating to the honolulu release.
559Therefore, upgrades require a fresh new database installation.
560Please see the
Jim Hahn382ceda2021-03-30 15:09:11 -0400561`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.
Jim Hahnd2b1a172021-03-24 15:37:45 -0400562
563Known Vulnerabilities
564~~~~~~~~~~~~~~~~~~~~~
565
566Workarounds
567~~~~~~~~~~~
568
Jim Hahn49e65182021-03-29 14:28:52 -0400569* `POLICY-2998 <https://jira.onap.org/browse/POLICY-2998>`_ - Provide a script to periodically purge the statistics table
570
Jim Hahnd2b1a172021-03-24 15:37:45 -0400571Security Notes
572==============
573
574* `POLICY-3005 <https://jira.onap.org/browse/POLICY-3005>`_ - Bump direct dependency versions
575 - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.12
576 - Upgrade org.eclipse.persistence to 2.7.8
577 - Upgrade org.glassfish.jersey.containers to 2.33
578 - Upgrade com.fasterxml.jackson.module to 2.11.3
579 - Upgrade com.google.re2j to 1.5
580 - Upgrade org.mariadb.jdbc to 2.7.1
581 - Upgrade commons-codec to 1.15
582 - Upgrade com.thoughtworks.xstream to 1.4.15
583 - Upgrade org.apache.httpcomponents:httpclient to 4.5.13
584 - Upgrade org.apache.httpcomponents:httpcore to 4.4.14
585 - Upgrade org.json to 20201115
586 - Upgrade org.projectlombok to 1.18.16
587 - Upgrade org.yaml to 1.27
588 - Upgrade io.cucumber to 6.9.1
589 - Upgrade org.apache.commons:commons-lang3 to 3.11
590 - Upgrade commons-io to 2.8.0
Jim Hahn49e65182021-03-29 14:28:52 -0400591* `POLICY-2943 <https://jira.onap.org/browse/POLICY-2943>`_ - Review license scan issues
592 - Upgrade com.hazelcast to 4.1.1
593 - Upgrade io.netty to 4.1.58.Final
Jim Hahnd2b1a172021-03-24 15:37:45 -0400594* `POLICY-2936 <https://jira.onap.org/browse/POLICY-2936>`_ - Upgrade to latest version of CDS API
595 - Upgrade io.grpc to 1.35.0
596 - Upgrade com.google.protobuf to 3.14.0
597
598
599References
600==========
601
602For more information on the ONAP Honolulu release, please see:
603
604#. `ONAP Home Page`_
605#. `ONAP Documentation`_
606#. `ONAP Release Downloads`_
607#. `ONAP Wiki Page`_
608
609
610.. _`ONAP Home Page`: https://www.onap.org
611.. _`ONAP Wiki Page`: https://wiki.onap.org
612.. _`ONAP Documentation`: https://docs.onap.org
613.. _`ONAP Release Downloads`: https://git.onap.org
614
615Quick Links:
616 - `POLICY project page`_
617 - `Passing Badge information for POLICY`_
618
Jim Hahn961360a2020-11-10 16:36:00 -0500619.. ========================
620.. * * * GUILIN * * *
621.. ========================
622
623Version: 7.0.0
624--------------
625
Jim Hahnfee72972020-11-23 09:49:49 -0500626:Release Date: 2020-12-03 (Guilin Release)
Jim Hahn961360a2020-11-10 16:36:00 -0500627
628New features
629============
630
631Artifacts released:
632
633.. csv-table::
634 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
635 :widths: 15,10,10
636
637 "policy/parent", "3.2.0", ""
638 "policy/common", "1.7.1", ""
639 "policy/models", "2.3.5", ""
640 "policy/api", "2.3.3", "onap/policy-api:2.3.3"
641 "policy/pap", "2.3.3", "onap/policy-pap:2.3.3"
642 "policy/drools-pdp", "1.7.4", "onap/policy-drools:1.7.4"
643 "policy/apex-pdp", "2.4.4", "onap/policy-apex-pdp:2.4.4"
644 "policy/xacml-pdp", "2.3.3", "onap/policy-xacml-pdp:2.3.3"
645 "policy/drools-applications", "1.7.5", "onap/policy-pdpd-cl:1.7.5"
646 "policy/distribution", "2.4.3", "onap/policy-distribution:2.4.3"
647 "policy/docker", "2.1.1", "onap/policy-jdk-alpine:2.1.1, onap/policy-jre-alpine:2.1.1"
648
649Key Updates
650===========
651
652* Kubernetes integration
653 - All components return with non-zero exit code in case of application failure
654 - All components log to standard out (i.e., k8s logs) by default
655 - Continue to write log files inside individual pods, as well
Jim Hahn961360a2020-11-10 16:36:00 -0500656* E2E Network Slicing
657 - Added ModifyNSSI operation to SO actor
658* Consolidated health check
659 - Indicate failure if there aren’t enough PDPs registered
660* Legacy operational policies
661 - Removed from all components
662* OOM helm charts refactoring
663 - Name standardization
664 - Automated certificate generation
665* Actor Model
666 - Support various use cases and provide more flexibility to Policy Designers
Jim Hahne5734752020-11-16 11:12:10 -0500667 - Reintroduced the "usecases" controller into drools-pdp, supporting the use cases
668 under the revised actor architecture
Jim Hahn961360a2020-11-10 16:36:00 -0500669* Guard Application
670 - Support policy filtering
671* Matchable Application
672 - Support for ONAP or 3rd party components to create matchable policy types out of the box
673* Policy Lifecycle & Administration API
674 - Query/Delete by policy name & version without policy type
675* Apex-PDP enhancements
676 - Support multiple event & response types coming from a single endpoint
677 - Standalone installation now supports Tosca-based policies
678 - Legacy policy format has been removed
679 - Support chaining/handling of gRPC failure responses
680* Policy Distribution
681 - HPA decoders & related classes have been removed
682* Policy Engine
683 - Deprecated
684
685Known Limitations, Issues and Workarounds
686=========================================
687
688System Limitations
689~~~~~~~~~~~~~~~~~~
690
691The policy API component requires a fresh new database when migrating to the guilin release.
692Therefore, upgrades require a fresh new database installation.
693Please see the
Jim Hahn382ceda2021-03-30 15:09:11 -0400694`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.
Jim Hahn961360a2020-11-10 16:36:00 -0500695
696Known Vulnerabilities
697~~~~~~~~~~~~~~~~~~~~~
698
699* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
700
701Workarounds
702~~~~~~~~~~~
703* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Use the stringify method of the execution context
704
705Security Notes
706==============
707
708* `POLICY-2878 <https://jira.onap.org/browse/POLICY-2878>`_ - Dependency upgrades
709 - Upgrade com.fasterxml.jackson to 2.11.1
710* `POLICY-2387 <https://jira.onap.org/browse/POLICY-2387>`_ - Dependency upgrades
711 - Upgrade org.json to 20200518
712 - Upgrade com.google.re2j to 1.4
713 - Upgrade com.thoughtworks.xstream to 1.4.12
714 - Upgrade org.eclipse.persistence to 2.2.1
715 - Upgrade org.apache.httpcomponents to 4.5.12
716 - Upgrade org.projectlombok to 1.18.12
717 - Upgrade org.slf4j to 1.7.30
718 - Upgrade org.codehaus.plexus to 3.3.0
719 - Upgrade com.h2database to 1.4.200
720 - Upgrade io.cucumber to 6.1.2
721 - Upgrade org.assertj to 3.16.1
722 - Upgrade com.openpojo to 0.8.13
723 - Upgrade org.mockito to 3.3.3
724 - Upgrade org.awaitility to 4.0.3
725 - Upgrade org.onap.aaf.authz to 2.1.21
726* `POLICY-2668 <https://jira.onap.org/browse/POLICY-2668>`_ - Dependency upgrades
727 - Upgrade org.java-websocket to 1.5.1
728* `POLICY-2623 <https://jira.onap.org/browse/POLICY-2623>`_ - Remove log4j dependency
729* `POLICY-1996 <https://jira.onap.org/browse/POLICY-1996>`_ - Dependency upgrades
730 - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.11
731
732
733References
734==========
735
Jim Hahnd2b1a172021-03-24 15:37:45 -0400736For more information on the ONAP Guilin release, please see:
Jim Hahn961360a2020-11-10 16:36:00 -0500737
738#. `ONAP Home Page`_
739#. `ONAP Documentation`_
740#. `ONAP Release Downloads`_
741#. `ONAP Wiki Page`_
742
743
744.. _`ONAP Home Page`: https://www.onap.org
745.. _`ONAP Wiki Page`: https://wiki.onap.org
746.. _`ONAP Documentation`: https://docs.onap.org
747.. _`ONAP Release Downloads`: https://git.onap.org
748
749Quick Links:
750 - `POLICY project page`_
751 - `Passing Badge information for POLICY`_
752
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400753
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400754.. ===========================
755.. * * * FRANKFURT * * *
756.. ===========================
757
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400758
Jim Hahn087f4fc2020-08-19 11:54:57 -0400759Version: 6.0.1
760--------------
761
Jim Hahn9b4f2c42020-08-19 23:05:33 -0400762:Release Date: 2020-08-21 (Frankfurt Maintenance Release #1)
Jim Hahn087f4fc2020-08-19 11:54:57 -0400763
764**Artifacts**
765
766Artifacts released:
767
768.. csv-table::
769 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
770 :widths: 15,10,10
771
772 "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
773
774
775**Bug Fixes**
776
777
778 * `[POLICY-2704] <https://jira.onap.org/browse/POLICY-2704>`_ - Legacy PDP-X and PAP stuck in PodIntializing
779
780
781**Security Notes**
782
783*Fixed Security Issues*
784
785
786 * `[POLICY-2678] <https://jira.onap.org/browse/POLICY-2678>`_ - policy/engine tomcat upgrade for CVE-2020-11996
787
788
789Version: 6.0.0
790--------------
791
792:Release Date: 2020-06-04 (Frankfurt Release)
793
794New features
Jim Hahn961360a2020-11-10 16:36:00 -0500795============
Jim Hahn087f4fc2020-08-19 11:54:57 -0400796
797Artifacts released:
798
799.. csv-table::
800 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
801 :widths: 15,10,10
802
803 "policy/parent", "3.1.3", ""
804 "policy/common", "1.6.5", ""
805 "policy/models", "2.2.6", ""
806 "policy/api", "2.2.4", "onap/policy-api:2.2.4"
807 "policy/pap", "2.2.3", "onap/policy-pap:2.2.3"
808 "policy/drools-pdp", "1.6.3", "onap/policy-drools:1.6.3"
809 "policy/apex-pdp", "2.3.2", "onap/policy-apex-pdp:2.3.2"
810 "policy/xacml-pdp", "2.2.2", "onap/policy-xacml-pdp:2.2.2"
811 "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
812 "policy/engine", "1.6.4", "onap/policy-pe:1.6.4"
813 "policy/distribution", "2.3.2", "onap/policy-distribution:2.3.2"
814 "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"
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400815
816Summary
817=======
818
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400819New features include policy update notifications, native policy support, streamlined health check for the Policy Administration Point (PAP),
820configurable 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.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400821
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400822Common changes in all policy components
Jim Hahn961360a2020-11-10 16:36:00 -0500823=======================================
824
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400825* Upgraded all policy components to Java 11.
826* Logback file can be now loaded using OOM configmap.
Jim Hahn961360a2020-11-10 16:36:00 -0500827 - 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.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400828
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400829* TOSCA changes:
Jim Hahn961360a2020-11-10 16:36:00 -0500830 - “tosca_definitions_version” is now “tosca_simple_yaml_1_1_0”
831 - typeVersion→ type_version, int→integer, bool→boolean, String→string, Map→map, List→list
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400832* SupportedPolicyTypes now removed from pdp status message.
Jim Hahn961360a2020-11-10 16:36:00 -0500833 - All PDPs now send PdpGroup to which they belong to in the registration message.
834 - SupportedPolicyTypes are not sent anymore.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400835
836* Native Policy Support
Jim Hahn961360a2020-11-10 16:36:00 -0500837 - Each PDP engine has its own native policy language. A new Policy Type **onap.policies.Native** was created and supported for each PDP
838 engine to support native policy types.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400839
840
841POLICY-PAP
Jim Hahn961360a2020-11-10 16:36:00 -0500842==========
843
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400844* Policy Update Notifications
Jim Hahn961360a2020-11-10 16:36:00 -0500845 - PAP now generates notifications via the DMaaP Message Router when policies are successfully or unsuccessfully deployed (or undeployed) from all relevant PDPs.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400846
847* PAP API to fetch Policy deployment status
Jim Hahn961360a2020-11-10 16:36:00 -0500848 - Clients will be able to poll the PAP API to find out when policies have been successfully or unsuccessfully deployed to the PDP's.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400849
850* Removing supportedPolicyTypes from PdpStatus
Jim Hahn961360a2020-11-10 16:36:00 -0500851 - PDPs are assigned to a PdpGroup based on what group is mentioned in the heartbeat. Earlier this was done based on the supportedPolicyTypes.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400852
853* Support policy types with wild-cards, Preload wildcard supported type in PAP
854
855* PAP should NOT make a PDP passive if it cannot deploy a policy.
Jim Hahn961360a2020-11-10 16:36:00 -0500856 - 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.
857 - Also, re-register pdp if not found in the DB during heartbeat processing.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400858
859* Consolidated health check in PAP
Jim Hahn961360a2020-11-10 16:36:00 -0500860 - 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.
861 - “healthCheckRestClientParameters” (REST parameters for API and Distribution healthcheck) are added to the startup config file in PAP.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400862
863* PDP statistics from PAP
Jim Hahn961360a2020-11-10 16:36:00 -0500864 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400865
866* PAP API for Create or Update PdpGroups
Jim Hahn961360a2020-11-10 16:36:00 -0500867 - 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
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400868
869* PAP API to deploy policies to PdpGroups
Jim Hahn961360a2020-11-10 16:36:00 -0500870 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400871
872POLICY-API
Jim Hahn961360a2020-11-10 16:36:00 -0500873==========
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400874
875* A new simplified API to create one or more policies in one call.
Jim Hahn961360a2020-11-10 16:36:00 -0500876 - This simplified API doesn’t require policy type id & policy type version to be part of the URL.
877 - The simple URI “policy/api/v1/policies” with a POST input body takes in a ToscaServiceTemplate with the policies in it.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400878
879* List of Preloaded policy types are made configurable
Jim Hahn961360a2020-11-10 16:36:00 -0500880 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400881
882* Preload default policies for ONAP components
Jim Hahn961360a2020-11-10 16:36:00 -0500883 - The ability to configure the preloading of initial default policies into the system upon startup.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400884
885* A lot of improvements to the API code and validations corresponding to the changes in policy-models.
Jim Hahn961360a2020-11-10 16:36:00 -0500886 - Creating same policyType/policy repeatedly without any change in request body will always be successful with 200 response
887 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400888
889* Known versioning issues are there in Policy Types handling.
Jim Hahn961360a2020-11-10 16:36:00 -0500890 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400891
892* Cascaded GET of PolicyTypes and Policies
Jim Hahn961360a2020-11-10 16:36:00 -0500893 - Fetching/GET PolicyType now returns all of the referenced/parent policyTypes and dataTypes as well.
894 - Fetching/GET Policy allows specifying mode now.
895 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400896
897* The /deployed API is removed from policy/api
Jim Hahn961360a2020-11-10 16:36:00 -0500898 - This run time administration job to see the deployment status of a policy is now possible via PAP.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400899
900* Changes related to design and support of TOSCA Compliant Policy Types for the operational and guard policy models.
901
902POLICY-DISTRIBUTION
Jim Hahn961360a2020-11-10 16:36:00 -0500903===================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400904
905* 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.
Jim Hahn961360a2020-11-10 16:36:00 -0500906 - Note: If “deployPolicies” field in the startup config file is true, then only the policies are deployed using PAP endpoint.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400907
908* Policy/engine & apex-pdp dependencies are removed from policy-distribution.
909
910
Jim Hahn961360a2020-11-10 16:36:00 -0500911POLICY-APEX-PDP
912===============
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400913
914* Changed the JavaScript executor from Nashorn to Rhino as part of Java 11 upgrade.
Jim Hahn961360a2020-11-10 16:36:00 -0500915 - 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
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400916
Jim Hahn961360a2020-11-10 16:36:00 -0500917 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400918
919* APEX supports multiple policy deployment in Frankfurt.
Jim Hahn961360a2020-11-10 16:36:00 -0500920 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400921
Jim Hahn961360a2020-11-10 16:36:00 -0500922 - 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).
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400923
Jim Hahn961360a2020-11-10 16:36:00 -0500924 - 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”.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400925
926* Context retainment during policy upgrade.
Jim Hahn961360a2020-11-10 16:36:00 -0500927 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400928
Jim Hahn961360a2020-11-10 16:36:00 -0500929 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400930
931* APEX-PDP now specifies which PdpGroup it belongs to.
Jim Hahn961360a2020-11-10 16:36:00 -0500932 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400933
Jim Hahn961360a2020-11-10 16:36:00 -0500934 - In APEX-PDP, this can be specified in the startup config file(OnapPfConfig.json). "pdpGroup": "<groupName>" is added under “pdpStatusParameters” in the config file.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400935
936* APEX-PDP now sends PdpStatistics data in heartbeat.
Jim Hahn961360a2020-11-10 16:36:00 -0500937 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400938
939* Removed “content” section from ToscaPolicy properties in APEX.
Jim Hahn961360a2020-11-10 16:36:00 -0500940 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400941
942* Passing parameters from ApexConfig to policy logic.
Jim Hahn961360a2020-11-10 16:36:00 -0500943 - 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.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400944
Jim Hahn382ceda2021-03-30 15:09:11 -0400945 - 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
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400946
Jim Hahn961360a2020-11-10 16:36:00 -0500947 - In the taskLogic, taskParameters can be accessed as executor.parameters.get("ParameterKey1"))
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400948
Jim Hahn382ceda2021-03-30 15:09:11 -0400949 - More information can be found here: https://docs.onap.org/projects/onap-policy-parent/en/frankfurt/apex/APEX-Policy-Guide.html#accessing-taskparameters
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400950
951* GRPC support for APEX-CDS interaction.
Jim Hahn382ceda2021-03-30 15:09:11 -0400952 - 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
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400953
Jim Hahn961360a2020-11-10 16:36:00 -0500954POLICY-XACML-PDP
955================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400956
957* Added optional Decision API param to Decision API for monitor decisions that returns abbreviated results.
Jim Hahn961360a2020-11-10 16:36:00 -0500958 - 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).
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400959
960* XACML PDP now support PASSIVE_MODE.
961* Added support to return status and error if pdp-x failed to load a policy.
962* Changed optimization Decision API application to support "closest matches" algorithm.
963* Changed Xacml-pdp to report the pdp group defined in XacmlPdpParameters config file as part of heartbeat. Also, removed supportedPolicyType from pdpStatus message.
964* 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.
965* XACML pdp support for Control Loop Coordination
Jim Hahn961360a2020-11-10 16:36:00 -0500966 - Added policies for SON and PCI to support each blocking the other, with test cases and appropriate requests
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400967
968* Extend PDP-X capabilities so that it can load in and enforce the native XACML policies deployed from PAP.
969
970POLICY-DROOLS-PDP
Jim Hahn961360a2020-11-10 16:36:00 -0500971=================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400972
jhh4efa6f42020-06-09 11:28:08 -0500973* Support for PDP-D in offline mode to support locked deployments. This is the default ONAP installation.
974* Parameterize maven repository URLs for easier CI/CD integration.
975* Support for Tosca Compliant Operational Policies.
976* Support for TOSCA Compliant Native Policies that allows creation and deployment of new drools-applications.
977* Validation of Operational and Native Policies against their policy type.
978* Support for a generic Drools-PDP docker image to host any type of application.
979* Experimental Server Pool feature that supports multiple active Drools PDP hosts.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400980
981POLICY-DROOLS-APPLICATIONS
Jim Hahn961360a2020-11-10 16:36:00 -0500982==========================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400983
jhh4efa6f42020-06-09 11:28:08 -0500984* Removal of DCAE ONSET alarm duplicates (with different request IDs).
985* Support of a new controller (frankfurt) that supports the ONAP use cases under the new actor architecture.
986* Deprecated the "usecases" controller supporting the use cases under the legacy actor architecture.
987* Deleted the unsupported "amsterdam" controller related projects.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400988
Jim Hahn961360a2020-11-10 16:36:00 -0500989
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400990Known Limitations, Issues and Workarounds
991=========================================
992
993System Limitations
Jim Hahn961360a2020-11-10 16:36:00 -0500994~~~~~~~~~~~~~~~~~~
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400995
jhh4efa6f42020-06-09 11:28:08 -0500996The policy API component requires a fresh new database when migrating to the frankfurt release.
997Therefore, upgrades require a fresh new database installation.
998Please see the
Jim Hahn382ceda2021-03-30 15:09:11 -0400999`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.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -04001000
1001Known Vulnerabilities
Jim Hahn961360a2020-11-10 16:36:00 -05001002~~~~~~~~~~~~~~~~~~~~~
Pamela Dragoshdb60fd22020-04-01 12:34:41 -04001003
Pamela Dragoshd5ff9882020-05-11 15:18:01 -04001004* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
1005* `POLICY-2487 <https://jira.onap.org/browse/POLICY-2487>`_ - policy/api hangs in loop if preload policy does not exist
Pamela Dragoshdb60fd22020-04-01 12:34:41 -04001006
1007Workarounds
Jim Hahn961360a2020-11-10 16:36:00 -05001008~~~~~~~~~~~
RossCf949be42020-06-09 12:54:50 +01001009* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Parse incoming object using JSON.Parse() or cast the object to a String
Pamela Dragoshdb60fd22020-04-01 12:34:41 -04001010
1011Security Notes
Jim Hahn961360a2020-11-10 16:36:00 -05001012==============
Pamela Dragoshdb60fd22020-04-01 12:34:41 -04001013
Pamela Dragoshd5ff9882020-05-11 15:18:01 -04001014* `POLICY-2221 <https://jira.onap.org/browse/POLICY-2221>`_ - Password removal from helm charts
1015* `POLICY-2064 <https://jira.onap.org/browse/POLICY-2064>`_ - Allow overriding of keystore and truststore in policy helm charts
1016* `POLICY-2381 <https://jira.onap.org/browse/POLICY-2381>`_ - Dependency upgrades
1017 - Upgrade drools 7.33.0
1018 - Upgrade jquery to 3.4.1 in jquery-ui
1019 - Upgrade snakeyaml to 1.26
1020 - Upgrade org.infinispan infinispan-core 10.1.5.Final
1021 - upgrade io.netty 4.1.48.Final
1022 - exclude org.glassfish.jersey.media jersey-media-jaxb artifact
1023 - Upgrade com.fasterxml.jackson.core 2.10.0.pr3
1024 - Upgrade org.org.jgroups 4.1.5.Final
1025 - Upgrade commons-codec 20041127.091804
1026 - Upgrade com.github.ben-manes.caffeine 2.8.0
1027
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001028.. ==========================
1029.. * * * EL ALTO * * *
1030.. ==========================
1031
Jim Hahn087f4fc2020-08-19 11:54:57 -04001032Version: 5.0.2
1033--------------
1034
Jim Hahn9b4f2c42020-08-19 23:05:33 -04001035:Release Date: 2020-08-24 (El Alto Maintenance Release #1)
Jim Hahn087f4fc2020-08-19 11:54:57 -04001036
1037**New Features**
1038
1039Artifacts released:
1040
1041.. csv-table::
1042 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1043 :widths: 15,10,10
1044
1045 "policy/api", "2.1.3", "onap/policy-api:2.1.3"
1046 "policy/pap", "2.1.3", "onap/policy-pap:2.1.3"
1047 "policy/drools-pdp", "1.5.3", "onap/policy-drools:1.5.3"
1048 "policy/apex-pdp", "2.2.3", "onap/policy-apex-pdp:2.2.3"
1049 "policy/xacml-pdp", "2.1.3", "onap/policy-xacml-pdp:2.1.3"
1050 "policy/drools-applications", "1.5.4", "onap/policy-pdpd-cl:1.5.4"
1051 "policy/engine", "1.5.3", "onap/policy-pe:1.5.3"
1052 "policy/distribution", "2.2.2", "onap/policy-distribution:2.2.2"
1053 "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0, onap/policy/base-alpine:1.4.0"
1054
1055
1056**Bug Fixes**
1057
1058
1059 * `[PORTAL-760] <https://jira.onap.org/browse/PORTAL-760>`_ - Access to Policy portal is impossible
1060 * `[POLICY-2107] <https://jira.onap.org/browse/POLICY-2107>`_ - policy/distribution license issue in resource needs to be removed
1061 * `[POLICY-2169] <https://jira.onap.org/browse/POLICY-2169>`_ - SDC client interface change caused compile error in policy distribution
1062 * `[POLICY-2171] <https://jira.onap.org/browse/POLICY-2171>`_ - Upgrade elalto branch models and drools-applications
1063 * `[POLICY-1509] <https://jira.onap.org/browse/POLICY-1509>`_ - Investigate Apex org.python.jython-standalone.2.7.1
1064 * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
1065
1066
1067**Security Notes**
1068
1069*Fixed Security Issues*
1070
1071
1072 * `[POLICY-2475] <https://jira.onap.org/browse/POLICY-2475>`_ - Update El Alto component certificates
1073
Pamela Dragosh8b0f5cc2019-09-16 07:48:20 -04001074Version: 5.0.1
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001075--------------
1076
Pamela Dragosh8bc72232019-10-11 18:42:17 -04001077:Release Date: 2019-10-24 (El Alto Release)
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001078
1079**New Features**
1080
1081Artifacts released:
1082
1083.. csv-table::
1084 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1085 :widths: 15,10,10
1086
Pamela Dragosh8bc72232019-10-11 18:42:17 -04001087 "policy/parent", "3.0.1", ""
1088 "policy/common", "1.5.2", ""
1089 "policy/models", "2.1.4", ""
1090 "policy/api", "2.1.2", "onap/policy-api:2.1.2"
1091 "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
1092 "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001093 "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
Pamela Dragosh8bc72232019-10-11 18:42:17 -04001094 "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
1095 "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
1096 "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
1097 "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001098 "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
1099
1100The 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`_.
1101
1102 * [POLICY-1727] - This epic covers technical debt left over from Dublin
Jim Hahn961360a2020-11-10 16:36:00 -05001103
Jim Hahn087f4fc2020-08-19 11:54:57 -04001104 - POLICY-969 Docker improvement in policy framwork modules
1105 - POLICY-1074 Fix checkstyle warnings in every repository
1106 - POLICY-1121 RPM build for Apex
1107 - POLICY-1223 CII Silver Badging Requirements
1108 - POLICY-1600 Clean up hash code equality checks, cloning and copying in policy-models
1109 - POLICY-1646 Replace uses of getCanonicalName() with getName()
1110 - POLICY-1652 Move PapRestServer to policy/common
1111 - POLICY-1732 Enable maven-checkstyle-plugin in apex-pdp
1112 - POLICY-1737 Upgrade oParent 2.0.0 - change daily jobs to staging jobs
1113 - POLICY-1742 Make HTTP return code handling configurable in APEX
1114 - POLICY-1743 Make URL configurable in REST Requestor and REST Client
1115 - POLICY-1744 Remove topic.properties and incorporate into overall properties
1116 - POLICY-1770 PAP REST API for PDPGroup Healthcheck
1117 - POLICY-1771 Boost policy/api JUnit code coverage
1118 - POLICY-1772 Boost policy/xacml-pdp JUnit code coverage
1119 - POLICY-1773 Enhance the policy/xacml-pdp S3P Stability and Performance tests
1120 - POLICY-1784 Better Handling of "version" field value with clients
1121 - POLICY-1785 Deploy same policy with a new version simply adds to the list
1122 - POLICY-1786 Create a simple way to populate the guard database for testing
1123 - POLICY-1791 Address Sonar issues in new policy repos
1124 - POLICY-1795 PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
1125 - POLICY-1800 API|PAP components use different version formats
1126 - POLICY-1805 Build up stability test for api component to follow S3P requirements
1127 - POLICY-1806 Build up S3P performance test for api component
1128 - POLICY-1847 Add control loop coordination as a preloaded policy type
1129 - POLICY-1871 Change policy/distribution to support ToscaPolicyType & ToscaPolicy
1130 - POLICY-1881 Upgrade policy/distribution to latest SDC artifacts
1131 - POLICY-1885 Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
1132 - POLICY-1898 Move apex-pdp & distribution documents to policy/parent
1133 - POLICY-1942 Boost policy/apex-pdp JUnit code coverage
1134 - POLICY-1953 Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
Saryu Shahad44df22019-09-19 22:27:26 +00001135
1136 * Additional items delivered with the release.
Jim Hahn961360a2020-11-10 16:36:00 -05001137
Jim Hahn087f4fc2020-08-19 11:54:57 -04001138 - POLICY-1637 Remove "version" from PdpGroup
1139 - POLICY-1653 Remove isNullVersion() method
1140 - POLICY-1966 Fix more sonar issues in policy drools
1141 - POLICY-1988 Generate El Alto AAF Certificates
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001142
1143 * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
Jim Hahn961360a2020-11-10 16:36:00 -05001144
Jim Hahn087f4fc2020-08-19 11:54:57 -04001145 - POLICY-1762 Create CDS API model implementation
1146 - POLICY-1763 Create CDS Actor
1147 - POLICY-1899 Update optimization xacml application to support more flexible Decision API
1148 - POLICY-1911 XACML PDP must be able to retrieve Policy Type from API
Saryu Shahad44df22019-09-19 22:27:26 +00001149
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001150
1151**Bug Fixes**
1152
1153The following bug fixes have been deployed with this release:
1154
Saryu Shahad44df22019-09-19 22:27:26 +00001155 * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
1156 * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
1157 * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
Jim Hahn087f4fc2020-08-19 11:54:57 -04001158 * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
Saryu Shahad44df22019-09-19 22:27:26 +00001159 * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
1160 * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
1161 * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
Jim Hahn087f4fc2020-08-19 11:54:57 -04001162 * `[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
1163 * `[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
Saryu Shahad44df22019-09-19 22:27:26 +00001164 * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
1165 * `[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
1166 * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
1167 * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
1168 * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model currently needs to be escaped
1169 * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
1170 * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
1171 * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
1172 * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
1173 * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
1174 * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
1175 * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
Pamela Dragosh8bc72232019-10-11 18:42:17 -04001176 * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
Saryu Shahad44df22019-09-19 22:27:26 +00001177
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001178
1179**Security Notes**
1180
1181*Fixed Security Issues*
1182
Pamela Dragosh8a593002019-10-14 10:47:43 -04001183
Jim Hahn087f4fc2020-08-19 11:54:57 -04001184 * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final
Pamela Dragosh8a593002019-10-14 10:47:43 -04001185 * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
1186 * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
1187 * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
1188 * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
1189 * `[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
1190 * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
1191 * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
1192 * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
1193
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001194*Known Security Issues*
1195
1196*Known Vulnerabilities in Used Modules*
1197
1198POLICY 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>`_.
1199
1200Quick Links:
1201 - `POLICY project page`_
1202 - `Passing Badge information for POLICY`_
1203 - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
1204
1205**Known Issues**
1206
1207The following known issues will be addressed in a future release:
1208
Saryu Shahad44df22019-09-19 22:27:26 +00001209 * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
1210 * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
1211 * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
1212 * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
1213 * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
1214 * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
1215 * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
Pamela Dragosh8bc72232019-10-11 18:42:17 -04001216 * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
1217 * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
1218 * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001219
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001220
1221.. ==========================
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001222.. * * * DUBLIN * * *
1223.. ==========================
1224
1225Version: 4.0.0
1226--------------
1227
Pamela Dragoshdd17aa12019-06-24 09:48:58 -04001228:Release Date: 2019-06-26 (Dublin Release)
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001229
1230**New Features**
1231
Pamela Dragoshdd17aa12019-06-24 09:48:58 -04001232Artifacts released:
1233
1234.. csv-table::
1235 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
1236 :widths: 15,10,10
1237
1238 "policy/parent", "2.1.0", ""
1239 "policy/common", "1.4.0", ""
1240 "policy/models", "2.0.2", ""
1241 "policy/api", "2.0.1", "onap/policy-api:2.0.1"
1242 "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
1243 "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
1244 "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
1245 "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
1246 "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
1247 "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
1248 "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
1249 "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
1250
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001251The Dublin release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Dublin release, refer to `JiraPolicyDublin`_.
1252
1253 * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001254 - POLICY-1195 Separate model code from drools-applications into other repositories
1255 - POLICY-1367 Spike - Experimentation for management of Drools templates and Operational Policies
1256 - POLICY-1397 PDP-D: NOOP Endpoints Support to test Operational Policies.
1257 - POLICY-1459 PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001258
1259 * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001260 - POLICY-1007 Remove Jackson from policy framework components
1261 - POLICY-1202 policy-engine & apex-pdp are using different version of eclipselink
1262 - POLICY-1250 Fix issues reported by sonar in policy modules
1263 - POLICY-1368 Remove hibernate from policy repos
1264 - POLICY-1457 Use Alpine in base docker images
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001265
1266 * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
Saryu Shah1000b602019-06-02 03:59:49 +00001267 - S3P Performance related items
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001268
1269 * [POLICY-1171] - Enhance CLC Facility
Jim Hahn087f4fc2020-08-19 11:54:57 -04001270 - POLICY-1173 High-level specification of coordination directives
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001271
1272 * [POLICY-1220] - This epic covers the work to support S3P Security criteria
Jim Hahn087f4fc2020-08-19 11:54:57 -04001273 - POLICY-1538 Upgrade Elasticsearch to 6.4.x to clear security issue
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001274
1275 * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
Jim Hahn087f4fc2020-08-19 11:54:57 -04001276 - POLICY-1270 Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
1277 - POLICY-1271 PAP RESTful HealthCheck/Statistics Main Entry Point
1278 - POLICY-1272 Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
1279 - POLICY-1273 Policy Type Application Design Requirements
1280 - POLICY-1436 XACML PDP RESTful HealthCheck/Statistics Main Entry Point
1281 - POLICY-1440 XACML PDP RESTful Decision API Main Entry Point
1282 - POLICY-1441 Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
1283 - POLICY-1442 Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
1284 - POLICY-1443 PAP Dmaap PDP Register/UnRegister Main Entry Point
1285 - POLICY-1444 PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
1286 - POLICY-1445 XACML PDP upgrade to xacml 2.0.0
1287 - POLICY-1446 Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
1288 - POLICY-1447 Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
1289 - POLICY-1449 XACML PDP Dmaap Register/UnRegister Functionality
1290 - POLICY-1451 XACML PDP Dmaap Deploy/UnDeploy Functionality
1291 - POLICY-1452 Apex PDP Dmaap Register/UnRegister Functionality
1292 - POLICY-1453 Apex PDP Dmaap Deploy/UnDeploy Functionality
1293 - POLICY-1454 Drools PDP Dmaap Register/UnRegister Functionality
1294 - POLICY-1455 Drools PDP Dmaap Deploy/UnDeploy Functionality
1295 - POLICY-1456 Policy Architecture and Roadmap Documentation
1296 - POLICY-1458 Create S3P JMeter Tests for Policy API
1297 - POLICY-1460 Create S3P JMeter Tests for PAP
1298 - POLICY-1461 Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
1299 - POLICY-1462 Create S3P JMeter Tests for Policy SDC Distribution
1300 - POLICY-1471 Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
1301 - POLICY-1474 Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
1302 - POLICY-1515 Prototype Policy Lifecycle API Swagger Entry Points
1303 - POLICY-1516 Prototype the Policy Decision API
1304 - POLICY-1541 PAP REST API for PDPGroup Query, Statistics & Delete
1305 - POLICY-1542 PAP REST API for PDPGroup Deployment, State Management & Health Check
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001306
1307 * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
Saryu Shah1000b602019-06-02 03:59:49 +00001308 - Model drive control loop related items
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001309
1310 * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
Jim Hahn087f4fc2020-08-19 11:54:57 -04001311 - POLICY-1405 Develop SDNC API for trigger bandwidth
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001312
1313 * [POLICY-1408] - This epic covers the work done with the Casablanca release
Jim Hahn087f4fc2020-08-19 11:54:57 -04001314 - POLICY-1410 List Policy API
1315 - POLICY-1413 Dashboard enhancements
1316 - POLICY-1414 Push Policy and DeletePolicy API enhancement
1317 - POLICY-1416 Model enhancements to support CLAMP
1318 - POLICY-1417 Resiliency improvements
1319 - POLICY-1418 PDP APIs - make ClientAuth optional
1320 - POLICY-1419 Better multi-role support
1321 - POLICY-1420 Model enhancement to support embedded JSON
1322 - POLICY-1421 New audit data for push/delete
1323 - POLICY-1422 Enhanced encryption
1324 - POLICY-1423 Save original model file
1325 - POLICY-1427 Controller Logging Feature
1326 - POLICY-1489 PDP-D: Nested JSON Event Filtering support with JsonPath
1327 - POLICY-1499 Mdc Filter Feature
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001328
1329 * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
Jim Hahn087f4fc2020-08-19 11:54:57 -04001330 - POLICY-1463 Functional code changes in Policy for OOF SON use case
1331 - POLICY-1464 Config related aspects for OOF SON use case
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001332
1333 * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001334 - POLICY-1278 AAI named-queries are being deprecated and should be replaced with custom-queries
1335 - POLICY-1545 E2E Automation - Parse the newly added model ids from operation policy
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001336
1337 * Additional items delivered with the release.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001338 - POLICY-1159 Move expectException to policy-common/utils-test
1339 - POLICY-1176 Work on technical debt introduced by CLC POC
1340 - POLICY-1266 A&AI Modularity
1341 - POLICY-1274 further improvement in PSSD S3P test
1342 - POLICY-1401 Build onap.policies.Monitoring TOSCA Policy Template
1343 - POLICY-1465 Support configurable Heap Memory Settings for JVM processes
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001344
1345
1346**Bug Fixes**
1347
1348The following bug fixes have been deployed with this release:
1349
Saryu Shah1000b602019-06-02 03:59:49 +00001350 * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001351 * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
1352 * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
1353 * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
Saryu Shah1000b602019-06-02 03:59:49 +00001354 * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001355
1356**Security Notes**
1357
1358*Fixed Security Issues*
1359
1360 * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
1361 * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
1362 * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
1363 * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
1364
1365*Known Security Issues*
1366
1367*Known Vulnerabilities in Used Modules*
1368
1369POLICY 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>`_.
1370
1371Quick Links:
1372 - `POLICY project page`_
1373 - `Passing Badge information for POLICY`_
1374 - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
1375
1376
1377**Known Issues**
1378
1379The following known issues will be addressed in a future release:
1380
Jim Hahn087f4fc2020-08-19 11:54:57 -04001381 * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
Saryu Shah1000b602019-06-02 03:59:49 +00001382 * `[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.
1383 * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
1384 * `[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
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001385 * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
Saryu Shah1000b602019-06-02 03:59:49 +00001386 * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001387 * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
Saryu Shah1000b602019-06-02 03:59:49 +00001388 * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
1389 * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
1390 * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
Jim Hahn087f4fc2020-08-19 11:54:57 -04001391 * `[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
Saryu Shah1000b602019-06-02 03:59:49 +00001392 * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
1393 * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
1394 * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
1395 * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
Pamela Dragoshf9f78d12019-06-28 08:17:38 -04001396 * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001397
1398
1399.. ==========================
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001400.. * * * CASABLANCA * * *
1401.. ==========================
1402
1403Version: 3.0.2
1404--------------
1405
1406:Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
1407
1408The following items were deployed with the Casablanca Maintenance Release:
1409
1410**Bug Fixes**
1411
1412 * [POLICY-1522] - Policy doesn't send "payload" field to APPC
1413
1414**Security Fixes**
1415
1416 * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001417
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001418**License Issues**
1419
1420 * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
1421
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001422**Known Issues**
1423
1424The following known issue will be addressed in a future release.
1425
1426 * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
1427
1428A 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.
1429
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001430
1431Version: 3.0.1
1432--------------
1433
1434:Release Date: 2019-01-31 (Casablanca Maintenance Release)
1435
1436The following items were deployed with the Casablanca Maintenance Release:
1437
1438**New Features**
1439
1440 * [POLICY-1221] - Policy distribution application to support HTTPS communication
1441 * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
1442
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001443**Bug Fixes**
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001444
1445 * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
1446 * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
1447
1448
1449Version: 3.0.0
1450--------------
1451
1452:Release Date: 2018-11-30 (Casablanca Release)
1453
1454**New Features**
1455
1456The 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).
1457
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001458 * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
1459
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001460 The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001461
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001462 * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
1463 * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
1464 * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001465
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001466 The policy team did some forward looking spike work towards re-building the Software Architecture.
1467
1468 * [POLICY-809] - Maintain and implement performance
1469 * [POLICY-814] - 72 hour stability testing (component and platform)
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001470
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001471 The policy team made enhancements to the Drools PDP to further support S3P Performance.
1472 For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
1473 performance standard and performed 72 hour stability tests.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001474
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001475 * [POLICY-824] - maintain and implement security
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001476
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001477 The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
1478 MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001479
1480 * [POLICY-840] - Flexible control loop coordination facility.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001481
1482 Work towards a POC for control loop coordination policies were implemented.
1483
1484 * [POLICY-841] - Covers the work required to support HPA
1485
1486 Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
1487
1488 * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001489
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001490 Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
1491
1492 * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001493
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001494 A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
1495 sonar issues, and checkstyle.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001496
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001497 * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
1498
1499 Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
1500
1501 * [POLICY-1182] - Covers the work to support CCVPN use case
1502
1503 Policy templates changes were submitted that supported the CCVPN use case.
1504
1505**Bug Fixes**
1506
1507The following bug fixes have been deployed with this release:
1508
1509 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1510 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1511 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
1512 * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
1513 * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
1514 * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
1515 * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
1516 * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
1517
1518
1519**Security Notes**
1520
1521POLICY 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>`_.
1522
1523Quick Links:
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001524 - `POLICY project page`_
1525 - `Passing Badge information for POLICY`_
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001526 - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
1527
1528**Known Issues**
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001529
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001530 * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
1531 * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
1532
1533
1534
1535.. =======================
1536.. * * * BEIJING * * *
1537.. =======================
1538
1539Version: 2.0.0
1540--------------
1541
1542:Release Date: 2018-06-07 (Beijing Release)
1543
1544**New Features**
1545
1546The Beijing release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Beijing release, refer to `JiraPolicyBeijing`_.
1547
1548 * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
Jim Hahn087f4fc2020-08-19 11:54:57 -04001549 - POLICY-238 policy/drools-applications: clean up maven structure
1550 - POLICY-336 Address Technical Debt
1551 - POLICY-338 Address JUnit Code Coverage
1552 - POLICY-377 Policy Create API should validate input matches DCAE microservice template
1553 - POLICY-389 Cleanup Jenkin's CI/CD process's
1554 - POLICY-449 Policy API + Console : Common Policy Validation
1555 - POLICY-568 Integration with org.onap AAF project
1556 - POLICY-610 Support vDNS scale out for multiple times in Beijing release
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001557
1558 * [POLICY-391] - This epic covers the work to support Release Planning activities
Jim Hahn087f4fc2020-08-19 11:54:57 -04001559 - POLICY-552 ONAP Licensing Scan - Use Restrictions
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001560
1561 * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -04001562 - POLICY-529 Platform Maturity Performance - Drools PDP
1563 - POLICY-567 Platform Maturity Performance - PDP-X
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001564
1565 * [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.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001566 - POLICY-488 pap should not add rules to official template provided in drools applications
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001567
1568 * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001569 - POLICY-434 need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001570
1571 * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
Jim Hahn087f4fc2020-08-19 11:54:57 -04001572 - POLICY-622 Integrate OOF Policy Model into Policy Platform
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001573
1574 * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -04001575 - POLICY-525 Platform Maturity Stability - Drools PDP
1576 - POLICY-526 Platform Maturity Stability - XACML PDP
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001577
1578 * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
Jim Hahn087f4fc2020-08-19 11:54:57 -04001579 - POLICY-527 Platform Maturity Resiliency - Policy Engine GUI and PAP
1580 - POLICY-528 Platform Maturity Resiliency - Drools PDP
1581 - POLICY-569 Platform Maturity Resiliency - BRMS Gateway
1582 - POLICY-585 Platform Maturity Resiliency - XACML PDP
1583 - POLICY-586 Platform Maturity Resiliency - Planning
1584 - POLICY-681 Regression Test Use Cases
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001585
1586 * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -04001587 - POLICY-523 Platform Maturity Security - CII Badging - Project Website
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001588
1589 * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -04001590 - POLICY-531 Platform Maturity Scalability - XACML PDP
1591 - POLICY-532 Platform Maturity Scalability - Drools PDP
1592 - POLICY-623 Docker image re-design
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001593
1594 * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -04001595 - POLICY-533 Platform Maturity Manageability L1 - Logging
1596 - POLICY-534 Platform Maturity Manageability - Instantiation < 1 hour
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001597
1598 * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -04001599 - POLICY-535 Platform Maturity Usability - User Guide
1600 - POLICY-536 Platform Maturity Usability - Deployment Documentation
1601 - POLICY-537 Platform Maturity Usability - API Documentation
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001602
1603 * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
1604
1605
1606**Bug Fixes**
1607
1608The following bug fixes have been deployed with this release:
1609
1610 * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
1611 * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
1612 * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
1613 * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
1614 * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
1615 * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
1616 * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
1617 * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
1618 * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001619 * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001620 * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
1621 * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
1622 * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
1623 * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
1624 * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
1625
1626
1627**Security Notes**
1628
1629POLICY 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>`_.
1630
1631Quick Links:
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001632 - `POLICY project page`_
1633 - `Passing Badge information for POLICY`_
1634 - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001635
1636**Known Issues**
1637
1638The following known issues will be addressed in a future release:
1639
1640 * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
1641 * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
1642 * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
1643 * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
1644 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1645 * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
1646 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1647 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
1648
1649
1650
1651
1652Version: 1.0.2
1653--------------
1654
1655:Release Date: 2018-01-18 (Amsterdam Maintenance Release)
1656
1657**Bug Fixes**
1658
1659The following fixes were deployed with the Amsterdam Maintenance Release:
1660
1661 * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
1662
1663
1664Version: 1.0.1
1665--------------
1666
1667:Release Date: 2017-11-16 (Amsterdam Release)
1668
1669**New Features**
1670
1671The 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`_.
1672
1673 * [POLICY-31] - Stabilization of Seed Code
1674 - POLICY-25 Replace any remaining openecomp reference by onap
1675 - POLICY-32 JUnit test code coverage
1676 - POLICY-66 PDP-D Feature mechanism enhancements
1677 - POLICY-67 Rainy Day Decision Policy
1678 - POLICY-93 Notification API
1679 - POLICY-158 policy/engine: SQL injection Mitigation
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001680 - POLICY-269 Policy API Support for Rainy Day Decision Policy and Dictionaries
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001681
1682 * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001683 - POLICY-40 MSB Integration
1684 - POLICY-124 Integration with oparent
1685 - POLICY-41 OOM Integration
1686 - POLICY-119 PDP-D: noop sinks
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001687
1688 * [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.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001689 - POLICY-57 VF-C Actor code development
1690 - POLICY-43 Amsterdam Use Case Template
1691 - POLICY-173 Deployment of Operational Policies Documentation
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001692
1693 * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001694 - POLICY-68 TOSCA Parsing for nested objects for Microservice Policies
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001695
1696 * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
1697
1698 * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001699 - POLICY-64 CLAMP Configuration and Operation Policies for vFW Use Case
1700 - POLICY-65 CLAMP Configuration and Operation Policies for vDNS Use Case
1701 - POLICY-48 CLAMP Configuration and Operation Policies for vCPE Use Case
1702 - POLICY-63 CLAMP Configuration and Operation Policies for VOLTE Use Case
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001703
1704 * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
1705
1706 * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001707 - POLICY-61 vFW Use Case - Runtime
1708 - POLICY-62 vDNS Use Case - Runtime
1709 - POLICY-59 vCPE Use Case - Runtime
1710 - POLICY-60 VOLTE Use Case - Runtime
1711 - POLICY-51 Runtime Policy Update Support
1712 - POLICY-328 vDNS Use Case - Runtime Testing
1713 - POLICY-324 vFW Use Case - Runtime Testing
1714 - POLICY-320 VOLTE Use Case - Runtime Testing
1715 - POLICY-316 vCPE Use Case - Runtime Testing
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001716
1717 * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001718 - POLICY-77 Functional Test case definition for Control Loops
1719 - POLICY-387 Deliver the released policy artifacts
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001720
1721
1722**Bug Fixes**
1723 - 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`_.
1724
1725
1726**Known Issues**
1727 - 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.
1728
1729 - For vLBS Use Case, the following steps are required to setup the service instance:
Jim Hahn087f4fc2020-08-19 11:54:57 -04001730 - Create a Service Instance via VID.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001731 - Create a VNF Instance via VID.
LF Jenkins CI59166422020-04-07 20:34:27 +00001732 - 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.
1733 - 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.
1734 - Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001735 - Populate AAI with a dummy VF module for vDNS scaling.
1736
1737**Security Issues**
1738 - None at this time
1739
1740**Other**
1741 - None at this time
1742
1743
1744.. Links to jira release notes
1745
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001746.. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001747.. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001748.. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
1749.. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
1750.. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
1751
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001752.. Links to Project related pages
1753
1754.. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
1755.. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
1756
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001757
1758.. note
1759.. CHANGE HISTORY
Jim Hahn087f4fc2020-08-19 11:54:57 -04001760.. 09/19/2019 - Updated for El Alto Release.
1761.. 05/16/2019 - Updated for Dublin Release.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001762.. 01/17/2019 - Updated for Casablanca Maintenance Release.
1763.. 11/19/2018 - Updated for Casablanca. Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001764.. Changed version number to use ONAP versions.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001765.. 10/08/2018 - Initial document for Casablanca release.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001766.. 05/29/2018 - Information for Beijing release.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001767.. 03/22/2018 - Initial document for Beijing release.
1768.. 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)
Jim Hahn087f4fc2020-08-19 11:54:57 -04001769.. Also, Set up initial information for Beijing.
1770.. Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001771
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001772
1773End of Release Notes
1774
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001775.. How to notes for SS
Jim Hahn087f4fc2020-08-19 11:54:57 -04001776.. For initial document: list epic and user stories for each, list user stories with no epics.
1777.. 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.
1778.. For Known issues, list bugs that are slotted for a future release.