Update Policy release notes for Guilin
[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 ..      * * *    GUILIN    * * *
19 ..      ========================
20
21 Version: 7.0.0
22 --------------
23
24 :Release Date: 2020-11-19 (Guilin Release)
25
26 New features
27 ============
28
29 Artifacts released:
30
31 .. csv-table::
32    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
33    :widths: 15,10,10
34
35    "policy/parent", "3.2.0", ""
36    "policy/common", "1.7.1", ""
37    "policy/models", "2.3.5", ""
38    "policy/api", "2.3.3", "onap/policy-api:2.3.3"
39    "policy/pap", "2.3.3", "onap/policy-pap:2.3.3"
40    "policy/drools-pdp", "1.7.4", "onap/policy-drools:1.7.4"
41    "policy/apex-pdp", "2.4.4", "onap/policy-apex-pdp:2.4.4"
42    "policy/xacml-pdp", "2.3.3", "onap/policy-xacml-pdp:2.3.3"
43    "policy/drools-applications", "1.7.5", "onap/policy-pdpd-cl:1.7.5"
44    "policy/distribution", "2.4.3", "onap/policy-distribution:2.4.3"
45    "policy/docker", "2.1.1", "onap/policy-jdk-alpine:2.1.1, onap/policy-jre-alpine:2.1.1"
46
47 Key Updates
48 ===========
49
50 * Kubernetes integration
51    - All components return with non-zero exit code in case of application failure
52    - All components log to standard out (i.e., k8s logs) by default
53    - Continue to write log files inside individual pods, as well
54 * Multi-tenancy
55    - Basic initial support using the existing features
56 * E2E Network Slicing
57    - Added ModifyNSSI operation to SO actor
58 * Consolidated health check
59    - Indicate failure if there aren’t enough PDPs registered
60 * Legacy operational policies
61    - Removed from all components
62 * OOM helm charts refactoring
63    - Name standardization
64    - Automated certificate generation
65 * Actor Model
66    - Support various use cases and provide more flexibility to Policy Designers
67 * Guard Application
68    - Support policy filtering
69 * Matchable Application
70   - Support for ONAP or 3rd party components to create matchable policy types out of the box
71 * Policy Lifecycle & Administration API
72    - Query/Delete by policy name & version without policy type
73 * Apex-PDP enhancements
74    - Support multiple event & response types coming from a single endpoint
75    - Standalone installation now supports Tosca-based policies
76    - Legacy policy format has been removed
77    - Support chaining/handling of gRPC failure responses
78 * Policy Distribution
79    - HPA decoders & related classes have been removed
80 * Policy Engine
81    - Deprecated
82
83 Known Limitations, Issues and Workarounds
84 =========================================
85
86 System Limitations
87 ~~~~~~~~~~~~~~~~~~
88
89 The policy API component requires a fresh new database when migrating to the guilin release.
90 Therefore, upgrades require a fresh new database installation.
91 Please see the
92 `Installing or Upgrading Policy <https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
93
94 Known Vulnerabilities
95 ~~~~~~~~~~~~~~~~~~~~~
96
97 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
98
99 Workarounds
100 ~~~~~~~~~~~
101 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Use the stringify method of the execution context
102
103 Security Notes
104 ==============
105
106 * `POLICY-2878 <https://jira.onap.org/browse/POLICY-2878>`_ - Dependency upgrades
107     - Upgrade com.fasterxml.jackson to 2.11.1
108 * `POLICY-2387 <https://jira.onap.org/browse/POLICY-2387>`_ - Dependency upgrades
109     - Upgrade org.json to 20200518
110     - Upgrade com.google.re2j to 1.4
111     - Upgrade com.thoughtworks.xstream to 1.4.12
112     - Upgrade org.eclipse.persistence to 2.2.1
113     - Upgrade org.apache.httpcomponents to 4.5.12
114     - Upgrade org.projectlombok to 1.18.12
115     - Upgrade org.slf4j to 1.7.30
116     - Upgrade org.codehaus.plexus to 3.3.0
117     - Upgrade com.h2database to 1.4.200
118     - Upgrade io.cucumber to 6.1.2
119     - Upgrade org.assertj to 3.16.1
120     - Upgrade com.openpojo to 0.8.13
121     - Upgrade org.mockito to 3.3.3
122     - Upgrade org.awaitility to 4.0.3
123     - Upgrade org.onap.aaf.authz to 2.1.21
124 * `POLICY-2668 <https://jira.onap.org/browse/POLICY-2668>`_ - Dependency upgrades
125     - Upgrade org.java-websocket to 1.5.1
126 * `POLICY-2623 <https://jira.onap.org/browse/POLICY-2623>`_ - Remove log4j dependency
127 * `POLICY-1996 <https://jira.onap.org/browse/POLICY-1996>`_ - Dependency upgrades
128     - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.11
129
130
131 References
132 ==========
133
134 For more information on the ONAP Frankfurt release, please see:
135
136 #. `ONAP Home Page`_
137 #. `ONAP Documentation`_
138 #. `ONAP Release Downloads`_
139 #. `ONAP Wiki Page`_
140
141
142 .. _`ONAP Home Page`: https://www.onap.org
143 .. _`ONAP Wiki Page`: https://wiki.onap.org
144 .. _`ONAP Documentation`: https://docs.onap.org
145 .. _`ONAP Release Downloads`: https://git.onap.org
146
147 Quick Links:
148     - `POLICY project page`_
149     - `Passing Badge information for POLICY`_
150
151
152 ..      ===========================
153 ..      * * *    FRANKFURT    * * *
154 ..      ===========================
155
156
157 Version: 6.0.1
158 --------------
159
160 :Release Date: 2020-08-21 (Frankfurt Maintenance Release #1)
161
162 **Artifacts**
163
164 Artifacts released:
165
166 .. csv-table::
167    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
168    :widths: 15,10,10
169
170    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
171
172
173 **Bug Fixes**
174
175
176     * `[POLICY-2704] <https://jira.onap.org/browse/POLICY-2704>`_ - Legacy PDP-X and PAP stuck in PodIntializing
177
178
179 **Security Notes**
180
181 *Fixed Security Issues*
182
183
184     * `[POLICY-2678] <https://jira.onap.org/browse/POLICY-2678>`_ - policy/engine tomcat upgrade for CVE-2020-11996
185
186
187 Version: 6.0.0
188 --------------
189
190 :Release Date: 2020-06-04 (Frankfurt Release)
191
192 New features
193 ============
194
195 Artifacts released:
196
197 .. csv-table::
198    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
199    :widths: 15,10,10
200
201    "policy/parent", "3.1.3", ""
202    "policy/common", "1.6.5", ""
203    "policy/models", "2.2.6", ""
204    "policy/api", "2.2.4", "onap/policy-api:2.2.4"
205    "policy/pap", "2.2.3", "onap/policy-pap:2.2.3"
206    "policy/drools-pdp", "1.6.3", "onap/policy-drools:1.6.3"
207    "policy/apex-pdp", "2.3.2", "onap/policy-apex-pdp:2.3.2"
208    "policy/xacml-pdp", "2.2.2", "onap/policy-xacml-pdp:2.2.2"
209    "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
210    "policy/engine", "1.6.4", "onap/policy-pe:1.6.4"
211    "policy/distribution", "2.3.2", "onap/policy-distribution:2.3.2"
212    "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"
213
214 Summary
215 =======
216
217 New features include policy update notifications, native policy support, streamlined health check for the Policy Administration Point (PAP),
218 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.
219
220 Common changes in all policy components
221 =======================================
222
223 * Upgraded all policy components to Java 11.
224 * Logback file can be now loaded using OOM configmap.
225    - 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.
226
227 * TOSCA changes:
228    - “tosca_definitions_version” is now “tosca_simple_yaml_1_1_0”
229    - typeVersion→ type_version, int→integer, bool→boolean, String→string, Map→map, List→list
230 * SupportedPolicyTypes now removed from pdp status message.
231    - All PDPs now send PdpGroup to which they belong to in the registration message.
232    - SupportedPolicyTypes are not sent anymore.
233
234 * Native Policy Support
235    - Each PDP engine has its own native policy language. A new Policy Type **onap.policies.Native** was created and supported for each PDP
236      engine to support native policy types.
237
238
239 POLICY-PAP
240 ==========
241
242 * Policy Update Notifications
243    - PAP now generates notifications  via the DMaaP Message Router when policies are successfully or unsuccessfully deployed (or undeployed) from all relevant PDPs.
244
245 * PAP API to fetch Policy deployment status
246    - Clients will be able to poll the PAP API to find out when policies have been successfully or unsuccessfully deployed to the PDP's.
247
248 * Removing supportedPolicyTypes from PdpStatus
249    - PDPs are assigned to a PdpGroup based on what group is mentioned in the heartbeat. Earlier this was done based on the supportedPolicyTypes.
250
251 * Support policy types with wild-cards, Preload wildcard supported type in PAP
252
253 * PAP should NOT make a PDP passive if it cannot deploy a policy.
254    - 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.
255    - Also, re-register pdp if not found in the DB during heartbeat processing.
256
257 * Consolidated health check in PAP
258    - 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.
259    - “healthCheckRestClientParameters” (REST parameters for API and Distribution healthcheck) are added to the startup config file in PAP.
260
261 * PDP statistics from PAP
262    - 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.
263
264 * PAP API for Create or Update PdpGroups
265    - 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
266
267 * PAP API to deploy policies to PdpGroups
268    - 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.
269
270 POLICY-API
271 ==========
272
273 * A new simplified API to create one or more policies in one call.
274    - This simplified API doesn’t require policy type id & policy type version to be part of the URL.
275    - The simple URI “policy/api/v1/policies” with a POST input body takes in a ToscaServiceTemplate with the policies in it.
276
277 * List of Preloaded policy types are made configurable
278    - 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.
279
280 * Preload default policies for ONAP components
281    - The ability to configure the preloading of initial default policies into the system upon startup.
282
283 * A lot of improvements to the API code and validations corresponding to the changes in policy-models.
284    - Creating same policyType/policy repeatedly without any change in request body will always be successful with 200 response
285    - 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.
286
287 * Known versioning issues are there in Policy Types handling.
288    - 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.
289
290 * Cascaded GET of PolicyTypes and Policies
291    - Fetching/GET PolicyType now returns all of the referenced/parent policyTypes and dataTypes as well.
292    - Fetching/GET Policy allows specifying mode now.
293    - 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.
294
295 * The /deployed API is removed from policy/api
296    - This run time administration job to see the deployment status of a policy is now possible via PAP.
297
298 * Changes related to design and support of TOSCA Compliant Policy Types for the operational and guard policy models.
299
300 POLICY-DISTRIBUTION
301 ===================
302
303 * 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.
304    - Note: If “deployPolicies” field in the startup config file is true, then only the policies are deployed using PAP endpoint.
305
306 * Policy/engine & apex-pdp dependencies are removed from policy-distribution.
307
308
309 POLICY-APEX-PDP
310 ===============
311
312 * Changed the JavaScript executor from Nashorn to Rhino as part of Java 11 upgrade.
313    - 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
314
315    - 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.
316
317 * APEX supports multiple policy deployment in Frankfurt.
318    - 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.
319
320    - 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).
321
322    - 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”.
323
324 * Context retainment during policy upgrade.
325    - 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.
326
327    - 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.
328
329 * APEX-PDP now specifies which PdpGroup it belongs to.
330    - 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.
331
332    - In APEX-PDP, this can be specified in the startup config file(OnapPfConfig.json). "pdpGroup": "<groupName>" is added under “pdpStatusParameters” in the config file.
333
334 * APEX-PDP now sends PdpStatistics data in heartbeat.
335    - 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.
336
337 * Removed “content” section from ToscaPolicy properties in APEX.
338    - 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.
339
340 * Passing parameters from ApexConfig to policy logic.
341    - 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.
342
343    - More information about the usage of Task Parameters can be found here: https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-User-Manual.html#configure-task-parameters
344
345    - In the taskLogic, taskParameters can be accessed as  executor.parameters.get("ParameterKey1"))
346
347    - More information can be found here: https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-Policy-Guide.html#accessing-taskparameters
348
349 * GRPC support for APEX-CDS interaction.
350    - 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://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-User-Manual.html#grpc-io
351
352 POLICY-XACML-PDP
353 ================
354
355 * Added optional Decision API param to Decision API for monitor decisions that returns abbreviated results.
356    - 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).
357
358 * XACML PDP now support PASSIVE_MODE.
359 * Added support to return status and error if pdp-x failed to load a policy.
360 * Changed optimization Decision API application to support "closest matches" algorithm.
361 * Changed Xacml-pdp to report the pdp group defined in XacmlPdpParameters config file as part of heartbeat. Also, removed supportedPolicyType from pdpStatus message.
362 * 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.
363 * XACML pdp support for Control Loop Coordination
364    - Added policies for SON and PCI to support each blocking the other, with test cases and appropriate requests
365
366 * Extend PDP-X capabilities so that it can load in and enforce the native XACML policies deployed from PAP.
367
368 POLICY-DROOLS-PDP
369 =================
370
371 * Support for PDP-D in offline mode to support locked deployments.   This is the default ONAP installation.
372 * Parameterize maven repository URLs for easier CI/CD integration.
373 * Support for Tosca Compliant Operational Policies.
374 * Support for TOSCA Compliant Native Policies that allows creation and deployment of new drools-applications.
375 * Validation of Operational and Native Policies against their policy type.
376 * Support for a generic Drools-PDP docker image to host any type of application.
377 * Experimental Server Pool feature that supports multiple active Drools PDP hosts.
378
379 POLICY-DROOLS-APPLICATIONS
380 ==========================
381
382 * Removal of DCAE ONSET alarm duplicates (with different request IDs).
383 * Support of a new controller (frankfurt) that supports the ONAP use cases under the new actor architecture.
384 * Deprecated the "usecases" controller supporting the use cases under the legacy actor architecture.
385 * Deleted the unsupported "amsterdam" controller related projects.
386
387
388 Known Limitations, Issues and Workarounds
389 =========================================
390
391 System Limitations
392 ~~~~~~~~~~~~~~~~~~
393
394 The policy API component requires a fresh new database when migrating to the frankfurt release.
395 Therefore, upgrades require a fresh new database installation.
396 Please see the
397 `Installing or Upgrading Policy <https://onap.readthedocs.io/en/frankfurt/submodules/policy/parent.git/docs/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
398
399 Known Vulnerabilities
400 ~~~~~~~~~~~~~~~~~~~~~
401
402 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
403 * `POLICY-2487 <https://jira.onap.org/browse/POLICY-2487>`_ - policy/api hangs in loop if preload policy does not exist
404
405 Workarounds
406 ~~~~~~~~~~~
407 * `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Parse incoming object using JSON.Parse() or cast the object to a String
408
409 Security Notes
410 ==============
411
412 * `POLICY-2221 <https://jira.onap.org/browse/POLICY-2221>`_ - Password removal from helm charts
413 * `POLICY-2064 <https://jira.onap.org/browse/POLICY-2064>`_ - Allow overriding of keystore and truststore in policy helm charts
414 * `POLICY-2381 <https://jira.onap.org/browse/POLICY-2381>`_ - Dependency upgrades
415     - Upgrade drools 7.33.0
416     - Upgrade jquery to 3.4.1 in jquery-ui
417     - Upgrade snakeyaml to 1.26
418     - Upgrade org.infinispan infinispan-core 10.1.5.Final
419     - upgrade io.netty 4.1.48.Final
420     - exclude org.glassfish.jersey.media jersey-media-jaxb artifact
421     - Upgrade com.fasterxml.jackson.core 2.10.0.pr3
422     - Upgrade org.org.jgroups 4.1.5.Final
423     - Upgrade commons-codec 20041127.091804
424     - Upgrade com.github.ben-manes.caffeine 2.8.0
425
426 ..      ==========================
427 ..      * * *     EL ALTO    * * *
428 ..      ==========================
429
430 Version: 5.0.2
431 --------------
432
433 :Release Date: 2020-08-24 (El Alto Maintenance Release #1)
434
435 **New Features**
436
437 Artifacts released:
438
439 .. csv-table::
440    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
441    :widths: 15,10,10
442
443    "policy/api", "2.1.3", "onap/policy-api:2.1.3"
444    "policy/pap", "2.1.3", "onap/policy-pap:2.1.3"
445    "policy/drools-pdp", "1.5.3", "onap/policy-drools:1.5.3"
446    "policy/apex-pdp", "2.2.3", "onap/policy-apex-pdp:2.2.3"
447    "policy/xacml-pdp", "2.1.3", "onap/policy-xacml-pdp:2.1.3"
448    "policy/drools-applications", "1.5.4", "onap/policy-pdpd-cl:1.5.4"
449    "policy/engine", "1.5.3", "onap/policy-pe:1.5.3"
450    "policy/distribution", "2.2.2", "onap/policy-distribution:2.2.2"
451    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0, onap/policy/base-alpine:1.4.0"
452
453
454 **Bug Fixes**
455
456
457     * `[PORTAL-760]  <https://jira.onap.org/browse/PORTAL-760>`_  - Access to Policy portal is impossible
458     * `[POLICY-2107] <https://jira.onap.org/browse/POLICY-2107>`_ - policy/distribution license issue in resource needs to be removed
459     * `[POLICY-2169] <https://jira.onap.org/browse/POLICY-2169>`_ - SDC client interface change caused compile error in policy distribution
460     * `[POLICY-2171] <https://jira.onap.org/browse/POLICY-2171>`_ - Upgrade elalto branch models and drools-applications
461     * `[POLICY-1509] <https://jira.onap.org/browse/POLICY-1509>`_ - Investigate Apex org.python.jython-standalone.2.7.1
462     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
463
464
465 **Security Notes**
466
467 *Fixed Security Issues*
468
469
470     * `[POLICY-2475] <https://jira.onap.org/browse/POLICY-2475>`_ - Update El Alto component certificates
471
472 Version: 5.0.1
473 --------------
474
475 :Release Date: 2019-10-24 (El Alto Release)
476
477 **New Features**
478
479 Artifacts released:
480
481 .. csv-table::
482    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
483    :widths: 15,10,10
484
485    "policy/parent", "3.0.1", ""
486    "policy/common", "1.5.2", ""
487    "policy/models", "2.1.4", ""
488    "policy/api", "2.1.2", "onap/policy-api:2.1.2"
489    "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
490    "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
491    "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
492    "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
493    "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
494    "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
495    "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
496    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
497
498 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`_.
499
500     * [POLICY-1727] - This epic covers technical debt left over from Dublin
501
502     - POLICY-969    Docker improvement in policy framwork modules
503     - POLICY-1074   Fix checkstyle warnings in every repository
504     - POLICY-1121   RPM build for Apex
505     - POLICY-1223   CII Silver Badging Requirements
506     - POLICY-1600   Clean up hash code equality checks, cloning and copying in policy-models
507     - POLICY-1646   Replace uses of getCanonicalName() with getName()
508     - POLICY-1652   Move PapRestServer to policy/common
509     - POLICY-1732   Enable maven-checkstyle-plugin in apex-pdp
510     - POLICY-1737   Upgrade oParent 2.0.0 - change daily jobs to staging jobs
511     - POLICY-1742   Make HTTP return code handling configurable in APEX
512     - POLICY-1743   Make URL configurable in REST Requestor and REST Client
513     - POLICY-1744   Remove topic.properties and incorporate into overall properties
514     - POLICY-1770   PAP REST API for PDPGroup Healthcheck
515     - POLICY-1771   Boost policy/api JUnit code coverage
516     - POLICY-1772   Boost policy/xacml-pdp JUnit code coverage
517     - POLICY-1773   Enhance the policy/xacml-pdp S3P Stability and Performance tests
518     - POLICY-1784   Better Handling of "version" field value with clients
519     - POLICY-1785   Deploy same policy with a new version simply adds to the list
520     - POLICY-1786   Create a simple way to populate the guard database for testing
521     - POLICY-1791   Address Sonar issues in new policy repos
522     - POLICY-1795   PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
523     - POLICY-1800   API|PAP components use different version formats
524     - POLICY-1805   Build up stability test for api component to follow S3P requirements
525     - POLICY-1806   Build up S3P performance test for api component
526     - POLICY-1847   Add control loop coordination as a preloaded policy type
527     - POLICY-1871   Change policy/distribution to support ToscaPolicyType & ToscaPolicy
528     - POLICY-1881   Upgrade policy/distribution to latest SDC artifacts
529     - POLICY-1885   Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
530     - POLICY-1898   Move apex-pdp & distribution documents to policy/parent
531     - POLICY-1942   Boost policy/apex-pdp JUnit code coverage
532     - POLICY-1953   Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
533
534     * Additional items delivered with the release.
535
536     - POLICY-1637   Remove "version" from PdpGroup
537     - POLICY-1653   Remove isNullVersion() method
538     - POLICY-1966   Fix more sonar issues in policy drools
539     - POLICY-1988   Generate El Alto AAF Certificates
540
541     * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
542
543     - POLICY-1762   Create CDS API model implementation
544     - POLICY-1763   Create CDS Actor
545     - POLICY-1899   Update optimization xacml application to support more flexible Decision API
546     - POLICY-1911   XACML PDP must be able to retrieve Policy Type from API
547
548
549 **Bug Fixes**
550
551 The following bug fixes have been deployed with this release:
552
553     * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
554     * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
555     * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
556     * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
557     * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
558     * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
559     * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
560     * `[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
561     * `[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
562     * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
563     * `[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
564     * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
565     * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
566     * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model  currently needs to be escaped
567     * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
568     * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
569     * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
570     * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
571     * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
572     * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
573     * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
574     * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
575
576
577 **Security Notes**
578
579 *Fixed Security Issues*
580
581
582     * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final
583     * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
584     * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
585     * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
586     * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
587     * `[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
588     * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
589     * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
590     * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
591
592 *Known Security Issues*
593
594 *Known Vulnerabilities in Used Modules*
595
596 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>`_.
597
598 Quick Links:
599     - `POLICY project page`_
600     - `Passing Badge information for POLICY`_
601     - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
602
603 **Known Issues**
604
605 The following known issues will be addressed in a future release:
606
607     * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
608     * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
609     * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
610     * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
611     * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
612     * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
613     * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
614     * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
615     * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
616     * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
617
618
619 ..      ==========================
620 ..      * * *      DUBLIN    * * *
621 ..      ==========================
622
623 Version: 4.0.0
624 --------------
625
626 :Release Date: 2019-06-26 (Dublin Release)
627
628 **New Features**
629
630 Artifacts released:
631
632 .. csv-table::
633    :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
634    :widths: 15,10,10
635
636    "policy/parent", "2.1.0", ""
637    "policy/common", "1.4.0", ""
638    "policy/models", "2.0.2", ""
639    "policy/api", "2.0.1", "onap/policy-api:2.0.1"
640    "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
641    "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
642    "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
643    "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
644    "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
645    "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
646    "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
647    "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
648
649 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`_.
650
651     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
652         - POLICY-1195   Separate model code from drools-applications into other repositories
653         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
654         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
655         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
656
657     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
658         - POLICY-1007   Remove Jackson from policy framework components
659         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
660         - POLICY-1250   Fix issues reported by sonar in policy modules
661         - POLICY-1368   Remove hibernate from policy repos
662         - POLICY-1457   Use Alpine in base docker images
663
664     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
665         - S3P Performance related items
666
667     * [POLICY-1171] - Enhance CLC Facility
668         - POLICY-1173   High-level specification of coordination directives
669
670     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
671         - POLICY-1538   Upgrade Elasticsearch to 6.4.x to clear security issue
672
673     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
674         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
675         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
676         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
677         - POLICY-1273   Policy Type Application Design Requirements
678         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
679         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
680         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
681         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
682         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
683         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
684         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
685         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
686         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
687         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
688         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
689         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
690         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
691         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
692         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
693         - POLICY-1456   Policy Architecture and Roadmap Documentation
694         - POLICY-1458   Create S3P JMeter Tests for Policy API
695         - POLICY-1460   Create S3P JMeter Tests for PAP
696         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
697         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
698         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
699         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
700         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
701         - POLICY-1516   Prototype the Policy Decision API
702         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
703         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
704
705     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
706         - Model drive control loop related items
707
708     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
709         - POLICY-1405   Develop SDNC API for trigger bandwidth
710
711     * [POLICY-1408] - This epic covers the work done with the Casablanca release
712         - POLICY-1410   List Policy API
713         - POLICY-1413   Dashboard enhancements
714         - POLICY-1414   Push Policy and DeletePolicy API enhancement
715         - POLICY-1416   Model enhancements to support CLAMP
716         - POLICY-1417   Resiliency improvements
717         - POLICY-1418   PDP APIs - make ClientAuth optional
718         - POLICY-1419   Better multi-role support
719         - POLICY-1420   Model enhancement to support embedded JSON
720         - POLICY-1421   New audit data for push/delete
721         - POLICY-1422   Enhanced encryption
722         - POLICY-1423   Save original model file
723         - POLICY-1427   Controller Logging Feature
724         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
725         - POLICY-1499   Mdc Filter Feature
726
727     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
728         - POLICY-1463   Functional code changes in Policy for OOF SON use case
729         - POLICY-1464   Config related aspects for OOF SON use case
730
731     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
732         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
733         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
734
735     * Additional items delivered with the release.
736         - POLICY-1159   Move expectException to policy-common/utils-test
737         - POLICY-1176   Work on technical debt introduced by CLC POC
738         - POLICY-1266   A&AI Modularity
739         - POLICY-1274   further improvement in PSSD S3P test
740         - POLICY-1401   Build onap.policies.Monitoring TOSCA Policy Template
741         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
742
743
744 **Bug Fixes**
745
746 The following bug fixes have been deployed with this release:
747
748     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
749     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
750     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
751     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
752     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
753
754 **Security Notes**
755
756 *Fixed Security Issues*
757
758     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
759     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
760     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
761     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
762
763 *Known Security Issues*
764
765 *Known Vulnerabilities in Used Modules*
766
767 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>`_.
768
769 Quick Links:
770     - `POLICY project page`_
771     - `Passing Badge information for POLICY`_
772     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
773
774
775 **Known Issues**
776
777 The following known issues will be addressed in a future release:
778
779     * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
780     * `[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.
781     * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
782     * `[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
783     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
784     * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
785     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
786     * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
787     * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
788     * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
789     * `[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
790     * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
791     * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
792     * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
793     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
794     * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
795
796
797 ..      ==========================
798 ..      * * *   CASABLANCA   * * *
799 ..      ==========================
800
801 Version: 3.0.2
802 --------------
803
804 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
805
806 The following items were deployed with the Casablanca Maintenance Release:
807
808 **Bug Fixes**
809
810     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
811
812 **Security Fixes**
813
814     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
815
816 **License Issues**
817
818     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
819
820 **Known Issues**
821
822 The following known issue will be addressed in a future release.
823
824     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
825
826 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.
827
828
829 Version: 3.0.1
830 --------------
831
832 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
833
834 The following items were deployed with the Casablanca Maintenance Release:
835
836 **New Features**
837
838     * [POLICY-1221] - Policy distribution application to support HTTPS communication
839     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
840
841 **Bug Fixes**
842
843     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
844     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
845
846
847 Version: 3.0.0
848 --------------
849
850 :Release Date: 2018-11-30 (Casablanca Release)
851
852 **New Features**
853
854 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).
855
856     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
857
858     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
859
860     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
861     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
862     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
863
864     The policy team did some forward looking spike work towards re-building the Software Architecture.
865
866     * [POLICY-809] - Maintain and implement performance
867     * [POLICY-814] - 72 hour stability testing (component and platform)
868
869     The policy team made enhancements to the Drools PDP to further support S3P Performance.
870     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
871     performance standard and performed 72 hour stability tests.
872
873     * [POLICY-824] - maintain and implement security
874
875     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
876     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
877
878     * [POLICY-840] - Flexible control loop coordination facility.
879
880     Work towards a POC for control loop coordination policies were implemented.
881
882     * [POLICY-841] - Covers the work required to support HPA
883
884     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
885
886     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
887
888     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
889
890     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
891
892     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
893     sonar issues, and checkstyle.
894
895     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
896
897     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
898
899     * [POLICY-1182] - Covers the work to support CCVPN use case
900
901     Policy templates changes were submitted that supported the CCVPN use case.
902
903 **Bug Fixes**
904
905 The following bug fixes have been deployed with this release:
906
907     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
908     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
909     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
910     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
911     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
912     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
913     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
914     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
915
916
917 **Security Notes**
918
919 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>`_.
920
921 Quick Links:
922     - `POLICY project page`_
923     - `Passing Badge information for POLICY`_
924     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
925
926 **Known Issues**
927
928     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
929     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
930
931
932
933 ..      =======================
934 ..      * * *   BEIJING   * * *
935 ..      =======================
936
937 Version: 2.0.0
938 --------------
939
940 :Release Date: 2018-06-07 (Beijing Release)
941
942 **New Features**
943
944 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`_.
945
946     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
947         - POLICY-238    policy/drools-applications: clean up maven structure
948         - POLICY-336    Address Technical Debt
949         - POLICY-338    Address JUnit Code Coverage
950         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
951         - POLICY-389    Cleanup Jenkin's CI/CD process's
952         - POLICY-449    Policy API + Console : Common Policy Validation
953         - POLICY-568    Integration with org.onap AAF project
954         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
955
956     * [POLICY-391] - This epic covers the work to support Release Planning activities
957         - POLICY-552    ONAP Licensing Scan - Use Restrictions
958
959     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
960         - POLICY-529    Platform Maturity Performance - Drools PDP
961         - POLICY-567    Platform Maturity Performance - PDP-X
962
963     * [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.
964         - POLICY-488    pap should not add rules to official template provided in drools applications
965
966     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
967         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
968
969     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
970         - POLICY-622    Integrate OOF Policy Model into Policy Platform
971
972     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
973         - POLICY-525    Platform Maturity Stability - Drools PDP
974         - POLICY-526    Platform Maturity Stability - XACML PDP
975
976     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
977         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
978         - POLICY-528    Platform Maturity Resiliency - Drools PDP
979         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
980         - POLICY-585    Platform Maturity Resiliency - XACML PDP
981         - POLICY-586    Platform Maturity Resiliency - Planning
982         - POLICY-681    Regression Test Use Cases
983
984     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
985         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
986
987     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
988         - POLICY-531    Platform Maturity Scalability - XACML PDP
989         - POLICY-532    Platform Maturity Scalability - Drools PDP
990         - POLICY-623    Docker image re-design
991
992     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
993         - POLICY-533    Platform Maturity Manageability L1 - Logging
994         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
995
996     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
997         - POLICY-535    Platform Maturity Usability - User Guide
998         - POLICY-536    Platform Maturity Usability - Deployment Documentation
999         - POLICY-537    Platform Maturity Usability - API Documentation
1000
1001     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
1002
1003
1004 **Bug Fixes**
1005
1006 The following bug fixes have been deployed with this release:
1007
1008     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
1009     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
1010     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
1011     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
1012     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
1013     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
1014     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
1015     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
1016     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
1017     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
1018     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
1019     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
1020     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
1021     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
1022     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
1023
1024
1025 **Security Notes**
1026
1027 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>`_.
1028
1029 Quick Links:
1030     - `POLICY project page`_
1031     - `Passing Badge information for POLICY`_
1032     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
1033
1034 **Known Issues**
1035
1036 The following known issues will be addressed in a future release:
1037
1038     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
1039     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
1040     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
1041     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
1042     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1043     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
1044     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1045     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
1046
1047
1048
1049
1050 Version: 1.0.2
1051 --------------
1052
1053 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
1054
1055 **Bug Fixes**
1056
1057 The following fixes were deployed with the Amsterdam Maintenance Release:
1058
1059     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
1060
1061
1062 Version: 1.0.1
1063 --------------
1064
1065 :Release Date: 2017-11-16 (Amsterdam Release)
1066
1067 **New Features**
1068
1069 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`_.
1070
1071     * [POLICY-31] - Stabilization of Seed Code
1072         - POLICY-25  Replace any remaining openecomp reference by onap
1073         - POLICY-32  JUnit test code coverage
1074         - POLICY-66  PDP-D Feature mechanism enhancements
1075         - POLICY-67  Rainy Day Decision Policy
1076         - POLICY-93  Notification API
1077         - POLICY-158  policy/engine: SQL injection Mitigation
1078         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
1079
1080     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
1081         - POLICY-40  MSB Integration
1082         - POLICY-124  Integration with oparent
1083         - POLICY-41  OOM Integration
1084         - POLICY-119  PDP-D: noop sinks
1085
1086     * [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.
1087         - POLICY-57  VF-C Actor code development
1088         - POLICY-43  Amsterdam Use Case Template
1089         - POLICY-173  Deployment of Operational Policies Documentation
1090
1091     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
1092         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
1093
1094     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
1095
1096     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
1097         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
1098         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
1099         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
1100         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
1101
1102     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
1103
1104     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
1105         - POLICY-61  vFW Use Case - Runtime
1106         - POLICY-62  vDNS Use Case - Runtime
1107         - POLICY-59  vCPE Use Case - Runtime
1108         - POLICY-60  VOLTE Use Case - Runtime
1109         - POLICY-51  Runtime Policy Update Support
1110         - POLICY-328  vDNS Use Case - Runtime Testing
1111         - POLICY-324  vFW Use Case - Runtime Testing
1112         - POLICY-320  VOLTE Use Case - Runtime Testing
1113         - POLICY-316  vCPE Use Case - Runtime Testing
1114
1115     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
1116         - POLICY-77  Functional Test case definition for Control Loops
1117         - POLICY-387  Deliver the released policy artifacts
1118
1119
1120 **Bug Fixes**
1121     - 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`_.
1122
1123
1124 **Known Issues**
1125     - 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.
1126
1127     - For vLBS Use Case, the following steps are required to setup the service instance:
1128         -  Create a Service Instance via VID.
1129         -  Create a VNF Instance via VID.
1130         -  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.
1131         -  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.
1132         -  Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
1133         -  Populate AAI with a dummy VF module for vDNS scaling.
1134
1135 **Security Issues**
1136     - None at this time
1137
1138 **Other**
1139     - None at this time
1140
1141
1142 .. Links to jira release notes
1143
1144 .. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
1145 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
1146 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
1147 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
1148 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
1149
1150 .. Links to Project related pages
1151
1152 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
1153 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
1154
1155
1156 .. note
1157 ..      CHANGE  HISTORY
1158 ..  09/19/2019 - Updated for El Alto Release.
1159 ..  05/16/2019 - Updated for Dublin Release.
1160 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
1161 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
1162 ..      Changed version number to use ONAP versions.
1163 ..      10/08/2018 - Initial document for Casablanca release.
1164 ..  05/29/2018 - Information for Beijing release.
1165 ..      03/22/2018 - Initial document for Beijing release.
1166 ..      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)
1167 ..      Also, Set up initial information for Beijing.
1168 ..      Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
1169
1170
1171 End of Release Notes
1172
1173 .. How to notes for SS
1174 ..  For initial document: list epic and user stories for each, list user stories with no epics.
1175 ..      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.
1176 ..      For Known issues, list bugs that are slotted for a future release.