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