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