blob: a8f6d00aac0332bf3448022b195b588719a228c2 [file] [log] [blame]
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -04002
3.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
4.. _release_notes:
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04005
6Policy Release Notes
Jim Hahn961360a2020-11-10 16:36:00 -05007####################
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04008
9.. note
10.. * This Release Notes must be updated each time the team decides to Release new artifacts.
Pamela Dragoshc1c46402019-05-29 08:10:09 -040011.. * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes.
12.. * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -040013.. * this Release Notes.
Pamela Dragoshc1c46402019-05-29 08:10:09 -040014.. * Except the date and the version number, all the other sections are optional but there must be at least
15.. * one section describing the purpose of this new release.
Jim Hahn961360a2020-11-10 16:36:00 -050016
17.. ========================
18.. * * * GUILIN * * *
19.. ========================
20
21Version: 7.0.0
22--------------
23
Jim Hahnfee72972020-11-23 09:49:49 -050024:Release Date: 2020-12-03 (Guilin Release)
Jim Hahn961360a2020-11-10 16:36:00 -050025
26New features
27============
28
29Artifacts 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
47Key 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 arent 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
Jim Hahne5734752020-11-16 11:12:10 -050067 - Reintroduced the "usecases" controller into drools-pdp, supporting the use cases
68 under the revised actor architecture
Jim Hahn961360a2020-11-10 16:36:00 -050069* Guard Application
70 - Support policy filtering
71* Matchable Application
72 - Support for ONAP or 3rd party components to create matchable policy types out of the box
73* Policy Lifecycle & Administration API
74 - Query/Delete by policy name & version without policy type
75* Apex-PDP enhancements
76 - Support multiple event & response types coming from a single endpoint
77 - Standalone installation now supports Tosca-based policies
78 - Legacy policy format has been removed
79 - Support chaining/handling of gRPC failure responses
80* Policy Distribution
81 - HPA decoders & related classes have been removed
82* Policy Engine
83 - Deprecated
84
85Known Limitations, Issues and Workarounds
86=========================================
87
88System Limitations
89~~~~~~~~~~~~~~~~~~
90
91The policy API component requires a fresh new database when migrating to the guilin release.
92Therefore, upgrades require a fresh new database installation.
93Please see the
94`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.
95
96Known Vulnerabilities
97~~~~~~~~~~~~~~~~~~~~~
98
99* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
100
101Workarounds
102~~~~~~~~~~~
103* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Use the stringify method of the execution context
104
105Security Notes
106==============
107
108* `POLICY-2878 <https://jira.onap.org/browse/POLICY-2878>`_ - Dependency upgrades
109 - Upgrade com.fasterxml.jackson to 2.11.1
110* `POLICY-2387 <https://jira.onap.org/browse/POLICY-2387>`_ - Dependency upgrades
111 - Upgrade org.json to 20200518
112 - Upgrade com.google.re2j to 1.4
113 - Upgrade com.thoughtworks.xstream to 1.4.12
114 - Upgrade org.eclipse.persistence to 2.2.1
115 - Upgrade org.apache.httpcomponents to 4.5.12
116 - Upgrade org.projectlombok to 1.18.12
117 - Upgrade org.slf4j to 1.7.30
118 - Upgrade org.codehaus.plexus to 3.3.0
119 - Upgrade com.h2database to 1.4.200
120 - Upgrade io.cucumber to 6.1.2
121 - Upgrade org.assertj to 3.16.1
122 - Upgrade com.openpojo to 0.8.13
123 - Upgrade org.mockito to 3.3.3
124 - Upgrade org.awaitility to 4.0.3
125 - Upgrade org.onap.aaf.authz to 2.1.21
126* `POLICY-2668 <https://jira.onap.org/browse/POLICY-2668>`_ - Dependency upgrades
127 - Upgrade org.java-websocket to 1.5.1
128* `POLICY-2623 <https://jira.onap.org/browse/POLICY-2623>`_ - Remove log4j dependency
129* `POLICY-1996 <https://jira.onap.org/browse/POLICY-1996>`_ - Dependency upgrades
130 - Upgrade org.onap.dmaap.messagerouter.dmaapclient to 1.1.11
131
132
133References
134==========
135
136For more information on the ONAP Frankfurt release, please see:
137
138#. `ONAP Home Page`_
139#. `ONAP Documentation`_
140#. `ONAP Release Downloads`_
141#. `ONAP Wiki Page`_
142
143
144.. _`ONAP Home Page`: https://www.onap.org
145.. _`ONAP Wiki Page`: https://wiki.onap.org
146.. _`ONAP Documentation`: https://docs.onap.org
147.. _`ONAP Release Downloads`: https://git.onap.org
148
149Quick Links:
150 - `POLICY project page`_
151 - `Passing Badge information for POLICY`_
152
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400153
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400154.. ===========================
155.. * * * FRANKFURT * * *
156.. ===========================
157
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400158
Jim Hahn087f4fc2020-08-19 11:54:57 -0400159Version: 6.0.1
160--------------
161
Jim Hahn9b4f2c42020-08-19 23:05:33 -0400162:Release Date: 2020-08-21 (Frankfurt Maintenance Release #1)
Jim Hahn087f4fc2020-08-19 11:54:57 -0400163
164**Artifacts**
165
166Artifacts released:
167
168.. csv-table::
169 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
170 :widths: 15,10,10
171
172 "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
173
174
175**Bug Fixes**
176
177
178 * `[POLICY-2704] <https://jira.onap.org/browse/POLICY-2704>`_ - Legacy PDP-X and PAP stuck in PodIntializing
179
180
181**Security Notes**
182
183*Fixed Security Issues*
184
185
186 * `[POLICY-2678] <https://jira.onap.org/browse/POLICY-2678>`_ - policy/engine tomcat upgrade for CVE-2020-11996
187
188
189Version: 6.0.0
190--------------
191
192:Release Date: 2020-06-04 (Frankfurt Release)
193
194New features
Jim Hahn961360a2020-11-10 16:36:00 -0500195============
Jim Hahn087f4fc2020-08-19 11:54:57 -0400196
197Artifacts released:
198
199.. csv-table::
200 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
201 :widths: 15,10,10
202
203 "policy/parent", "3.1.3", ""
204 "policy/common", "1.6.5", ""
205 "policy/models", "2.2.6", ""
206 "policy/api", "2.2.4", "onap/policy-api:2.2.4"
207 "policy/pap", "2.2.3", "onap/policy-pap:2.2.3"
208 "policy/drools-pdp", "1.6.3", "onap/policy-drools:1.6.3"
209 "policy/apex-pdp", "2.3.2", "onap/policy-apex-pdp:2.3.2"
210 "policy/xacml-pdp", "2.2.2", "onap/policy-xacml-pdp:2.2.2"
211 "policy/drools-applications", "1.6.4", "onap/policy-pdpd-cl:1.6.4"
212 "policy/engine", "1.6.4", "onap/policy-pe:1.6.4"
213 "policy/distribution", "2.3.2", "onap/policy-distribution:2.3.2"
214 "policy/docker", "2.0.1", "onap/policy-jdk-alpine:2.0.1, onap/policy-jre-alpine:2.0.1, onap/policy-jdk-debian:2.0.1, onap/policy-jre-debian:2.0.1"
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400215
216Summary
217=======
218
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400219New features include policy update notifications, native policy support, streamlined health check for the Policy Administration Point (PAP),
220configurable pre-loading/pre-deployment of policies, new APIs (e.g. to create one or more Policies with a single call), new experimental PDP monitoring GUI, and enhancements to all three PDPs: XACML, Drools, APEX.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400221
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400222Common changes in all policy components
Jim Hahn961360a2020-11-10 16:36:00 -0500223=======================================
224
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400225* Upgraded all policy components to Java 11.
226* Logback file can be now loaded using OOM configmap.
Jim Hahn961360a2020-11-10 16:36:00 -0500227 - If needed, logback file can be loaded as a configmap during the OOM deployment. For this, just put the logback.xml file in corresponding config directory in OOM charts.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400228
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400229* TOSCA changes:
Jim Hahn961360a2020-11-10 16:36:00 -0500230 - tosca_definitions_version is now tosca_simple_yaml_1_1_0
231 - typeVersion type_version, intinteger, boolboolean, Stringstring, Mapmap, Listlist
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400232* SupportedPolicyTypes now removed from pdp status message.
Jim Hahn961360a2020-11-10 16:36:00 -0500233 - All PDPs now send PdpGroup to which they belong to in the registration message.
234 - SupportedPolicyTypes are not sent anymore.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400235
236* Native Policy Support
Jim Hahn961360a2020-11-10 16:36:00 -0500237 - Each PDP engine has its own native policy language. A new Policy Type **onap.policies.Native** was created and supported for each PDP
238 engine to support native policy types.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400239
240
241POLICY-PAP
Jim Hahn961360a2020-11-10 16:36:00 -0500242==========
243
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400244* Policy Update Notifications
Jim Hahn961360a2020-11-10 16:36:00 -0500245 - PAP now generates notifications via the DMaaP Message Router when policies are successfully or unsuccessfully deployed (or undeployed) from all relevant PDPs.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400246
247* PAP API to fetch Policy deployment status
Jim Hahn961360a2020-11-10 16:36:00 -0500248 - Clients will be able to poll the PAP API to find out when policies have been successfully or unsuccessfully deployed to the PDP's.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400249
250* Removing supportedPolicyTypes from PdpStatus
Jim Hahn961360a2020-11-10 16:36:00 -0500251 - PDPs are assigned to a PdpGroup based on what group is mentioned in the heartbeat. Earlier this was done based on the supportedPolicyTypes.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400252
253* Support policy types with wild-cards, Preload wildcard supported type in PAP
254
255* PAP should NOT make a PDP passive if it cannot deploy a policy.
Jim Hahn961360a2020-11-10 16:36:00 -0500256 - 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.
257 - Also, re-register pdp if not found in the DB during heartbeat processing.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400258
259* Consolidated health check in PAP
Jim Hahn961360a2020-11-10 16:36:00 -0500260 - 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.
261 - “healthCheckRestClientParameters” (REST parameters for API and Distribution healthcheck) are added to the startup config file in PAP.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400262
263* PDP statistics from PAP
Jim Hahn961360a2020-11-10 16:36:00 -0500264 - All PDPs send statistics data as part of the heartbeat. PAP reads this and saves this data to the database, and this statistics data can be accessed from the monitoring GUI.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400265
266* PAP API for Create or Update PdpGroups
Jim Hahn961360a2020-11-10 16:36:00 -0500267 - A new API is now available just for creating/updating PDP Groups. Policies cannot be added/updated during PDP Group create/update operations. There is another API for this. So, if provided in the create/update group request, they are ignored. Supported policy types are defined during PDP Group creation. They cannot be updated once they are created. Refer to this for details: https://github.com/onap/policy-parent/blob/master/docs/pap/pap.rst#id8
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400268
269* PAP API to deploy policies to PdpGroups
Jim Hahn961360a2020-11-10 16:36:00 -0500270 - A new API is introduced to deploy policies on specific PDPGroups. Each subgroup includes an "action" property, which is used to indicate that the policies are being added (POST) to the subgroup, deleted (DELETE) from the subgroup, or that the subgroup's entire set of policies is being replaced (PATCH) by a new set of policies.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400271
272POLICY-API
Jim Hahn961360a2020-11-10 16:36:00 -0500273==========
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400274
275* A new simplified API to create one or more policies in one call.
Jim Hahn961360a2020-11-10 16:36:00 -0500276 - This simplified API doesnt require policy type id & policy type version to be part of the URL.
277 - The simple URI policy/api/v1/policies with a POST input body takes in a ToscaServiceTemplate with the policies in it.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400278
279* List of Preloaded policy types are made configurable
Jim Hahn961360a2020-11-10 16:36:00 -0500280 - Until El Alto, the list of pre-loaded policy types are hardcoded in the code. Now, this is made configurable, and the list can be specified in the startup config file for the API component under preloadPolicyTypes”. The list is ignored if the DB already contains one or more policy types.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400281
282* Preload default policies for ONAP components
Jim Hahn961360a2020-11-10 16:36:00 -0500283 - The ability to configure the preloading of initial default policies into the system upon startup.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400284
285* A lot of improvements to the API code and validations corresponding to the changes in policy-models.
Jim Hahn961360a2020-11-10 16:36:00 -0500286 - Creating same policyType/policy repeatedly without any change in request body will always be successful with 200 response
287 - If there is any change in the request body, then that should be a new version. If any change is posted without a version change, then 406 error response is returned.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400288
289* Known versioning issues are there in Policy Types handling.
Jim Hahn961360a2020-11-10 16:36:00 -0500290 - https://jira.onap.org/browse/POLICY-2377 covers the versioning issues in Policy. Basically, multiple versions of a Policy Type cannot be handled in TOSCA. So, in Frankfurt, the latest version of the policy type is examined. This will be further looked into in Guilin.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400291
292* Cascaded GET of PolicyTypes and Policies
Jim Hahn961360a2020-11-10 16:36:00 -0500293 - Fetching/GET PolicyType now returns all of the referenced/parent policyTypes and dataTypes as well.
294 - Fetching/GET Policy allows specifying mode now.
295 - By default the mode is BARE”, which returns only the requested Policy in response. If mode is specified as REFERENCED”, all of the referenced/parent policyTypes and dataTypes are returned as well.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400296
297* The /deployed API is removed from policy/api
Jim Hahn961360a2020-11-10 16:36:00 -0500298 - This run time administration job to see the deployment status of a policy is now possible via PAP.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400299
300* Changes related to design and support of TOSCA Compliant Policy Types for the operational and guard policy models.
301
302POLICY-DISTRIBUTION
Jim Hahn961360a2020-11-10 16:36:00 -0500303===================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400304
305* From Frankfurt release, policy-distribution component uses APIs provided by Policy-API and Policy-PAP for creation of policy types and policies, and deployment of policies.
Jim Hahn961360a2020-11-10 16:36:00 -0500306 - Note: If deployPolicies field in the startup config file is true, then only the policies are deployed using PAP endpoint.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400307
308* Policy/engine & apex-pdp dependencies are removed from policy-distribution.
309
310
Jim Hahn961360a2020-11-10 16:36:00 -0500311POLICY-APEX-PDP
312===============
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400313
314* Changed the JavaScript executor from Nashorn to Rhino as part of Java 11 upgrade.
Jim Hahn961360a2020-11-10 16:36:00 -0500315 - There are minor changes in the JavaScript task logic files associated with this Rhino migration. An example for this change can be seen here: https://gerrit.onap.org/r/c/policy/apex-pdp/+/103546/2/examples/examples-onap-bbs/src/main/resources/logic/SdncResourceUpdateTask.js
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400316
Jim Hahn961360a2020-11-10 16:36:00 -0500317 - There is a known issue in Rhino javascript related to the usage of JSON.stringify. This is captured in this JIRA https://jira.onap.org/browse/POLICY-2463.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400318
319* APEX supports multiple policy deployment in Frankfurt.
Jim Hahn961360a2020-11-10 16:36:00 -0500320 - Up through El Alto APEX-PDP had the capability to take in only a single ToscaPolicy. When PAP sends a list of Tosca Policies in PdpUpdate, only the first one is taken and only that single Policy is deployed in APEX. This is fixed in Frankfurt. Now, APEX can deploy a list of Tosca Policies altogether into the engine.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400321
Jim Hahn961360a2020-11-10 16:36:00 -0500322 - Note: There shouldnt be any duplicates in the deployed policies (for e.g. same input/output parameter names, or same event/task names etc).
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400323
Jim Hahn961360a2020-11-10 16:36:00 -0500324 - For example, when 3 policies are deployed and one has duplicates, say same input/task or any such concept is used in the 2nd and 3rd policy, then APEX-PDP ignores the 3rd policy and executes only the 1st and 2nd policies. APEX-PDP also respond back to PAP with the message saying that only Policy 1 and 2 are deployed. Others failed due to duplicate concept”.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400325
326* Context retainment during policy upgrade.
Jim Hahn961360a2020-11-10 16:36:00 -0500327 - In APEX-PDP, context is referred by the apex concept contextAlbum’. When there is no major version change in the upgraded policy to be deployed, the existing context of the currently running policy is retained. When the upgraded policy starts running, it will have access to this context as well.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400328
Jim Hahn961360a2020-11-10 16:36:00 -0500329 - For example, Policy A v1.1 is currently deployed to APEX. It has a contextAlbum named HeartbeatContext and heartbeats are currently added to the HeartbeatContext based on events coming in to the policy execution. Now, when Policy A v1.2 (with some other changes and same HeartbeatContext) is deployed, Policy Av1.1 is replaced by Policy A1.2 in the APEX engine, but the content in HeartbeatContext is retained for Policy A1.2.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400330
331* APEX-PDP now specifies which PdpGroup it belongs to.
Jim Hahn961360a2020-11-10 16:36:00 -0500332 - Up through El Alto, PAP assigned each PDP to a PDP group based on the supportedPolicyTypes it sends in the heartbeat. But in Frankfurt, each PDP comes up saying which PdpGroup they belong to, and this is sent to PAP in the heartbeat. PAP then registers the PDP the PdpGroup specified by the PDP. If no group name is specified like this, then PAP assigns the PDP to defaultGroup by default. SupportedPolicyTypes are not sent to PAP by the PDP now.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400333
Jim Hahn961360a2020-11-10 16:36:00 -0500334 - In APEX-PDP, this can be specified in the startup config file(OnapPfConfig.json). "pdpGroup": "<groupName>" is added under pdpStatusParameters in the config file.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400335
336* APEX-PDP now sends PdpStatistics data in heartbeat.
Jim Hahn961360a2020-11-10 16:36:00 -0500337 - Apex now sends the PdpStatistics data in every heartbeat sent to PAP. PAP saves this data to the database, and this statistics data can be accessed from the monitoring GUI.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400338
339* Removed content section from ToscaPolicy properties in APEX.
Jim Hahn961360a2020-11-10 16:36:00 -0500340 - Up through El Alto, APEX specific policy information was placed under properties|content in ToscaPolicy. Avoid placing under "content" and keep the information directly under properties. So, the ToscaPolicy structure will have apex specific policy information in properties|engineServiceParameters, properties|eventInputParameters, properties|eventOutputParameters.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400341
342* Passing parameters from ApexConfig to policy logic.
Jim Hahn961360a2020-11-10 16:36:00 -0500343 - TaskParameters can be used to pass parameters from ApexConfig to the policy logic. Consider a scenario where from CLAMP, serviceId or closedLoopId has to be passed to the policy, and this should be available to perform some logic or action within the policy. In the CLAMP UI, while configuring the APEX Policy, specifying taskParameters with these will enable this.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400344
Jim Hahn961360a2020-11-10 16:36:00 -0500345 - 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
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400346
Jim Hahn961360a2020-11-10 16:36:00 -0500347 - In the taskLogic, taskParameters can be accessed as executor.parameters.get("ParameterKey1"))
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400348
Jim Hahn961360a2020-11-10 16:36:00 -0500349 - More information can be found here: https://onap.readthedocs.io/en/latest/submodules/policy/parent.git/docs/apex/APEX-Policy-Guide.html#accessing-taskparameters
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400350
351* GRPC support for APEX-CDS interaction.
Jim Hahn961360a2020-11-10 16:36:00 -0500352 - 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
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400353
Jim Hahn961360a2020-11-10 16:36:00 -0500354POLICY-XACML-PDP
355================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400356
357* Added optional Decision API param to Decision API for monitor decisions that returns abbreviated results.
Jim Hahn961360a2020-11-10 16:36:00 -0500358 - Return only an abbreviated list of policies (e.g. metadata Policy Id and Version) without the actual contents of the policies (e.g. the Properties).
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400359
360* XACML PDP now support PASSIVE_MODE.
361* Added support to return status and error if pdp-x failed to load a policy.
362* Changed optimization Decision API application to support "closest matches" algorithm.
363* Changed Xacml-pdp to report the pdp group defined in XacmlPdpParameters config file as part of heartbeat. Also, removed supportedPolicyType from pdpStatus message.
364* 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.
365* XACML pdp support for Control Loop Coordination
Jim Hahn961360a2020-11-10 16:36:00 -0500366 - Added policies for SON and PCI to support each blocking the other, with test cases and appropriate requests
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400367
368* Extend PDP-X capabilities so that it can load in and enforce the native XACML policies deployed from PAP.
369
370POLICY-DROOLS-PDP
Jim Hahn961360a2020-11-10 16:36:00 -0500371=================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400372
jhh4efa6f42020-06-09 11:28:08 -0500373* Support for PDP-D in offline mode to support locked deployments. This is the default ONAP installation.
374* Parameterize maven repository URLs for easier CI/CD integration.
375* Support for Tosca Compliant Operational Policies.
376* Support for TOSCA Compliant Native Policies that allows creation and deployment of new drools-applications.
377* Validation of Operational and Native Policies against their policy type.
378* Support for a generic Drools-PDP docker image to host any type of application.
379* Experimental Server Pool feature that supports multiple active Drools PDP hosts.
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400380
381POLICY-DROOLS-APPLICATIONS
Jim Hahn961360a2020-11-10 16:36:00 -0500382==========================
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400383
jhh4efa6f42020-06-09 11:28:08 -0500384* Removal of DCAE ONSET alarm duplicates (with different request IDs).
385* Support of a new controller (frankfurt) that supports the ONAP use cases under the new actor architecture.
386* Deprecated the "usecases" controller supporting the use cases under the legacy actor architecture.
387* Deleted the unsupported "amsterdam" controller related projects.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400388
Jim Hahn961360a2020-11-10 16:36:00 -0500389
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400390Known Limitations, Issues and Workarounds
391=========================================
392
393System Limitations
Jim Hahn961360a2020-11-10 16:36:00 -0500394~~~~~~~~~~~~~~~~~~
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400395
jhh4efa6f42020-06-09 11:28:08 -0500396The policy API component requires a fresh new database when migrating to the frankfurt release.
397Therefore, upgrades require a fresh new database installation.
398Please see the
399`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.
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400400
401Known Vulnerabilities
Jim Hahn961360a2020-11-10 16:36:00 -0500402~~~~~~~~~~~~~~~~~~~~~
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400403
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400404* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - In APEX Policy javascript task logic, JSON.stringify causing stackoverflow exceptions
405* `POLICY-2487 <https://jira.onap.org/browse/POLICY-2487>`_ - policy/api hangs in loop if preload policy does not exist
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400406
407Workarounds
Jim Hahn961360a2020-11-10 16:36:00 -0500408~~~~~~~~~~~
RossCf949be42020-06-09 12:54:50 +0100409* `POLICY-2463 <https://jira.onap.org/browse/POLICY-2463>`_ - Parse incoming object using JSON.Parse() or cast the object to a String
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400410
411Security Notes
Jim Hahn961360a2020-11-10 16:36:00 -0500412==============
Pamela Dragoshdb60fd22020-04-01 12:34:41 -0400413
Pamela Dragoshd5ff9882020-05-11 15:18:01 -0400414* `POLICY-2221 <https://jira.onap.org/browse/POLICY-2221>`_ - Password removal from helm charts
415* `POLICY-2064 <https://jira.onap.org/browse/POLICY-2064>`_ - Allow overriding of keystore and truststore in policy helm charts
416* `POLICY-2381 <https://jira.onap.org/browse/POLICY-2381>`_ - Dependency upgrades
417 - Upgrade drools 7.33.0
418 - Upgrade jquery to 3.4.1 in jquery-ui
419 - Upgrade snakeyaml to 1.26
420 - Upgrade org.infinispan infinispan-core 10.1.5.Final
421 - upgrade io.netty 4.1.48.Final
422 - exclude org.glassfish.jersey.media jersey-media-jaxb artifact
423 - Upgrade com.fasterxml.jackson.core 2.10.0.pr3
424 - Upgrade org.org.jgroups 4.1.5.Final
425 - Upgrade commons-codec 20041127.091804
426 - Upgrade com.github.ben-manes.caffeine 2.8.0
427
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400428.. ==========================
429.. * * * EL ALTO * * *
430.. ==========================
431
Jim Hahn087f4fc2020-08-19 11:54:57 -0400432Version: 5.0.2
433--------------
434
Jim Hahn9b4f2c42020-08-19 23:05:33 -0400435:Release Date: 2020-08-24 (El Alto Maintenance Release #1)
Jim Hahn087f4fc2020-08-19 11:54:57 -0400436
437**New Features**
438
439Artifacts released:
440
441.. csv-table::
442 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
443 :widths: 15,10,10
444
445 "policy/api", "2.1.3", "onap/policy-api:2.1.3"
446 "policy/pap", "2.1.3", "onap/policy-pap:2.1.3"
447 "policy/drools-pdp", "1.5.3", "onap/policy-drools:1.5.3"
448 "policy/apex-pdp", "2.2.3", "onap/policy-apex-pdp:2.2.3"
449 "policy/xacml-pdp", "2.1.3", "onap/policy-xacml-pdp:2.1.3"
450 "policy/drools-applications", "1.5.4", "onap/policy-pdpd-cl:1.5.4"
451 "policy/engine", "1.5.3", "onap/policy-pe:1.5.3"
452 "policy/distribution", "2.2.2", "onap/policy-distribution:2.2.2"
453 "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0, onap/policy/base-alpine:1.4.0"
454
455
456**Bug Fixes**
457
458
459 * `[PORTAL-760] <https://jira.onap.org/browse/PORTAL-760>`_ - Access to Policy portal is impossible
460 * `[POLICY-2107] <https://jira.onap.org/browse/POLICY-2107>`_ - policy/distribution license issue in resource needs to be removed
461 * `[POLICY-2169] <https://jira.onap.org/browse/POLICY-2169>`_ - SDC client interface change caused compile error in policy distribution
462 * `[POLICY-2171] <https://jira.onap.org/browse/POLICY-2171>`_ - Upgrade elalto branch models and drools-applications
463 * `[POLICY-1509] <https://jira.onap.org/browse/POLICY-1509>`_ - Investigate Apex org.python.jython-standalone.2.7.1
464 * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
465
466
467**Security Notes**
468
469*Fixed Security Issues*
470
471
472 * `[POLICY-2475] <https://jira.onap.org/browse/POLICY-2475>`_ - Update El Alto component certificates
473
Pamela Dragosh8b0f5cc2019-09-16 07:48:20 -0400474Version: 5.0.1
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400475--------------
476
Pamela Dragosh8bc72232019-10-11 18:42:17 -0400477:Release Date: 2019-10-24 (El Alto Release)
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400478
479**New Features**
480
481Artifacts released:
482
483.. csv-table::
484 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
485 :widths: 15,10,10
486
Pamela Dragosh8bc72232019-10-11 18:42:17 -0400487 "policy/parent", "3.0.1", ""
488 "policy/common", "1.5.2", ""
489 "policy/models", "2.1.4", ""
490 "policy/api", "2.1.2", "onap/policy-api:2.1.2"
491 "policy/pap", "2.1.2", "onap/policy-pap:2.1.2"
492 "policy/drools-pdp", "1.5.2", "onap/policy-drools:1.5.2"
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400493 "policy/apex-pdp", "2.2.1", "onap/policy-apex-pdp:2.2.1"
Pamela Dragosh8bc72232019-10-11 18:42:17 -0400494 "policy/xacml-pdp", "2.1.2", "onap/policy-xacml-pdp:2.1.2"
495 "policy/drools-applications", "1.5.3", "onap/policy-pdpd-cl:1.5.3"
496 "policy/engine", "1.5.2", "onap/policy-pe:1.5.2"
497 "policy/distribution", "2.2.1", "onap/policy-distribution:2.2.1"
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400498 "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
499
500The 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`_.
501
502 * [POLICY-1727] - This epic covers technical debt left over from Dublin
Jim Hahn961360a2020-11-10 16:36:00 -0500503
Jim Hahn087f4fc2020-08-19 11:54:57 -0400504 - POLICY-969 Docker improvement in policy framwork modules
505 - POLICY-1074 Fix checkstyle warnings in every repository
506 - POLICY-1121 RPM build for Apex
507 - POLICY-1223 CII Silver Badging Requirements
508 - POLICY-1600 Clean up hash code equality checks, cloning and copying in policy-models
509 - POLICY-1646 Replace uses of getCanonicalName() with getName()
510 - POLICY-1652 Move PapRestServer to policy/common
511 - POLICY-1732 Enable maven-checkstyle-plugin in apex-pdp
512 - POLICY-1737 Upgrade oParent 2.0.0 - change daily jobs to staging jobs
513 - POLICY-1742 Make HTTP return code handling configurable in APEX
514 - POLICY-1743 Make URL configurable in REST Requestor and REST Client
515 - POLICY-1744 Remove topic.properties and incorporate into overall properties
516 - POLICY-1770 PAP REST API for PDPGroup Healthcheck
517 - POLICY-1771 Boost policy/api JUnit code coverage
518 - POLICY-1772 Boost policy/xacml-pdp JUnit code coverage
519 - POLICY-1773 Enhance the policy/xacml-pdp S3P Stability and Performance tests
520 - POLICY-1784 Better Handling of "version" field value with clients
521 - POLICY-1785 Deploy same policy with a new version simply adds to the list
522 - POLICY-1786 Create a simple way to populate the guard database for testing
523 - POLICY-1791 Address Sonar issues in new policy repos
524 - POLICY-1795 PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
525 - POLICY-1800 API|PAP components use different version formats
526 - POLICY-1805 Build up stability test for api component to follow S3P requirements
527 - POLICY-1806 Build up S3P performance test for api component
528 - POLICY-1847 Add control loop coordination as a preloaded policy type
529 - POLICY-1871 Change policy/distribution to support ToscaPolicyType & ToscaPolicy
530 - POLICY-1881 Upgrade policy/distribution to latest SDC artifacts
531 - POLICY-1885 Apex-pdp: Extend CLIEditor to generate policy in ToscaServiceTemplate format
532 - POLICY-1898 Move apex-pdp & distribution documents to policy/parent
533 - POLICY-1942 Boost policy/apex-pdp JUnit code coverage
534 - POLICY-1953 Create addTopic taking BusTopicParams instead of Properties in policy/endpoints
Saryu Shahad44df22019-09-19 22:27:26 +0000535
536 * Additional items delivered with the release.
Jim Hahn961360a2020-11-10 16:36:00 -0500537
Jim Hahn087f4fc2020-08-19 11:54:57 -0400538 - POLICY-1637 Remove "version" from PdpGroup
539 - POLICY-1653 Remove isNullVersion() method
540 - POLICY-1966 Fix more sonar issues in policy drools
541 - POLICY-1988 Generate El Alto AAF Certificates
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400542
543 * [POLICY-1823] - This epic covers the work to develop features that will be deployed dark in El Alto.
Jim Hahn961360a2020-11-10 16:36:00 -0500544
Jim Hahn087f4fc2020-08-19 11:54:57 -0400545 - POLICY-1762 Create CDS API model implementation
546 - POLICY-1763 Create CDS Actor
547 - POLICY-1899 Update optimization xacml application to support more flexible Decision API
548 - POLICY-1911 XACML PDP must be able to retrieve Policy Type from API
Saryu Shahad44df22019-09-19 22:27:26 +0000549
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400550
551**Bug Fixes**
552
553The following bug fixes have been deployed with this release:
554
Saryu Shahad44df22019-09-19 22:27:26 +0000555 * `[POLICY-1671] <https://jira.onap.org/browse/POLICY-1671>`_ - policy/engine JUnit tests now take over 30 minutes to run
556 * `[POLICY-1725] <https://jira.onap.org/browse/POLICY-1725>`_ - XACML PDP returns 500 vs 400 for bad syntax JSON
557 * `[POLICY-1793] <https://jira.onap.org/browse/POLICY-1793>`_ - API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
Jim Hahn087f4fc2020-08-19 11:54:57 -0400558 * `[POLICY-1795] <https://jira.onap.org/browse/POLICY-1795>`_ - PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
Saryu Shahad44df22019-09-19 22:27:26 +0000559 * `[POLICY-1800] <https://jira.onap.org/browse/POLICY-1800>`_ - API|PAP components use different version formats
560 * `[POLICY-1802] <https://jira.onap.org/browse/POLICY-1802>`_ - Apex-pdp: context album is mandatory for policy model to compile
561 * `[POLICY-1803] <https://jira.onap.org/browse/POLICY-1803>`_ - PAP should undeploy policies when subgroup is deleted
Jim Hahn087f4fc2020-08-19 11:54:57 -0400562 * `[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
563 * `[POLICY-1808] <https://jira.onap.org/browse/POLICY-1808>`_ - API|PAP|PDP-X [new] should publish docker images with the following tag X.Y-SNAPSHOT-latest
Saryu Shahad44df22019-09-19 22:27:26 +0000564 * `[POLICY-1810] <https://jira.onap.org/browse/POLICY-1810>`_ - API: support "../deployed" REST API (URLs) for legacy policies
565 * `[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
566 * `[POLICY-1818] <https://jira.onap.org/browse/POLICY-1818>`_ - APEX does not allow arbitrary Kafka parameters to be specified
567 * `[POLICY-1838] <https://jira.onap.org/browse/POLICY-1838>`_ - Drools-pdp error log is missing data in ErrorDescription field
568 * `[POLICY-1839] <https://jira.onap.org/browse/POLICY-1839>`_ - Policy Model currently needs to be escaped
569 * `[POLICY-1843] <https://jira.onap.org/browse/POLICY-1843>`_ - Decision API not returning monitoring policies when calling api with policy-type
570 * `[POLICY-1844] <https://jira.onap.org/browse/POLICY-1844>`_ - XACML PDP does not update policy statistics
571 * `[POLICY-1858] <https://jira.onap.org/browse/POLICY-1858>`_ - Usecase DRL - named query should not be invoked
572 * `[POLICY-1859] <https://jira.onap.org/browse/POLICY-1859>`_ - Drools rules should not timeout when given timeout=0 - should be treated as infinite
573 * `[POLICY-1872] <https://jira.onap.org/browse/POLICY-1872>`_ - brmsgw fails building a jar - trafficgenerator dependency does not exist
574 * `[POLICY-2047] <https://jira.onap.org/browse/POLICY-2047>`_ - TOSCA Policy Types should be map not a list
575 * `[POLICY-2060] <https://jira.onap.org/browse/POLICY-2060>`_ - ToscaProperties object is missing metadata field
Pamela Dragosh8bc72232019-10-11 18:42:17 -0400576 * `[POLICY-2156] <https://jira.onap.org/browse/POLICY-2156>`_ - missing field in create VF module request to SO
Saryu Shahad44df22019-09-19 22:27:26 +0000577
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400578
579**Security Notes**
580
581*Fixed Security Issues*
582
Pamela Dragosh8a593002019-10-14 10:47:43 -0400583
Jim Hahn087f4fc2020-08-19 11:54:57 -0400584 * `[POLICY-2115] <https://jira.onap.org/browse/POLICY-2115>`_ - Upgrade org.jgroups : jgroups : 4.0.12.Final
Pamela Dragosh8a593002019-10-14 10:47:43 -0400585 * `[POLICY-2084] <https://jira.onap.org/browse/POLICY-2084>`_ - Investigate pip (py2.py3-none-any) 9.0.1 (.whl) in apex-pdp
586 * `[POLICY-2072] <https://jira.onap.org/browse/POLICY-2072>`_ - Upgrade io.netty : netty-codec-http2 and netty-common to 4.1.39.Final
587 * `[POLICY-2005] <https://jira.onap.org/browse/POLICY-2005>`_ - Upgrade elastic search to 6.8.2
588 * `[POLICY-2001] <https://jira.onap.org/browse/POLICY-2001>`_ - Upgrade com.thoughtworks.xstream to 1.4.11.1
589 * `[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
590 * `[POLICY-1999] <https://jira.onap.org/browse/POLICY-1999>`_ - Upgrade to httpcomponents httpclient 4.5.9
591 * `[POLICY-1598] <https://jira.onap.org/browse/POLICY-1598>`_ - mariadb container is outdated
592 * `[POLICY-1597] <https://jira.onap.org/browse/POLICY-1597>`_ - nexus container is outdated
593
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400594*Known Security Issues*
595
596*Known Vulnerabilities in Used Modules*
597
598POLICY 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>`_.
599
600Quick Links:
601 - `POLICY project page`_
602 - `Passing Badge information for POLICY`_
603 - `Project Vulnerability Review Table for POLICY (El Alto Release) <https://wiki.onap.org/pages/viewpage.action?pageId=68541992>`_
604
605**Known Issues**
606
607The following known issues will be addressed in a future release:
608
Saryu Shahad44df22019-09-19 22:27:26 +0000609 * `[POLICY-1276] <https://jira.onap.org/browse/POLICY-1276>`_ - JRuby interpreter shutdown fails on second and subsequent runs
610 * `[POLICY-1291] <https://jira.onap.org/browse/POLICY-1291>`_ - Maven Error when building Apex documentation in Windows
611 * `[POLICY-1578] <https://jira.onap.org/browse/POLICY-1578>`_ - PAP pushPolicies.sh in startup fails due to race condition in some environments
612 * `[POLICY-1832] <https://jira.onap.org/browse/POLICY-1832>`_ - API|PAP: data race condition seem to appear sometimes when creating and deploying policy
613 * `[POLICY-2103] <https://jira.onap.org/browse/POLICY-2103>`_ - policy/distribution may need to re-synch if SDC gets reinstalled
614 * `[POLICY-2062] <https://jira.onap.org/browse/POLICY-2062>`_ - APEX PDP logs > 4G filled local storage
615 * `[POLICY-2080] <https://jira.onap.org/browse/POLICY-2080>`_ - drools-pdp JUnit fails intermittently in feature-active-standby-management
Pamela Dragosh8bc72232019-10-11 18:42:17 -0400616 * `[POLICY-2111] <https://jira.onap.org/browse/POLICY-2111>`_ - PDP-D APPS: AAF Cadi conflicts with Aether libraries
617 * `[POLICY-2158] <https://jira.onap.org/browse/POLICY-2158>`_ - PAP loses synchronization with PDPs
618 * `[POLICY-2159] <https://jira.onap.org/browse/POLICY-2159>`_ - PAP console (legacy): cannot edit policies with GUI
Pamela Dragoshe47eb662019-08-16 13:37:44 -0400619
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400620
621.. ==========================
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400622.. * * * DUBLIN * * *
623.. ==========================
624
625Version: 4.0.0
626--------------
627
Pamela Dragoshdd17aa12019-06-24 09:48:58 -0400628:Release Date: 2019-06-26 (Dublin Release)
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400629
630**New Features**
631
Pamela Dragoshdd17aa12019-06-24 09:48:58 -0400632Artifacts released:
633
634.. csv-table::
635 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
636 :widths: 15,10,10
637
638 "policy/parent", "2.1.0", ""
639 "policy/common", "1.4.0", ""
640 "policy/models", "2.0.2", ""
641 "policy/api", "2.0.1", "onap/policy-api:2.0.1"
642 "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
643 "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
644 "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
645 "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
646 "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
647 "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
648 "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
649 "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
650
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400651The Dublin release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Dublin release, refer to `JiraPolicyDublin`_.
652
653 * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
Jim Hahn087f4fc2020-08-19 11:54:57 -0400654 - POLICY-1195 Separate model code from drools-applications into other repositories
655 - POLICY-1367 Spike - Experimentation for management of Drools templates and Operational Policies
656 - POLICY-1397 PDP-D: NOOP Endpoints Support to test Operational Policies.
657 - POLICY-1459 PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400658
659 * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
Jim Hahn087f4fc2020-08-19 11:54:57 -0400660 - POLICY-1007 Remove Jackson from policy framework components
661 - POLICY-1202 policy-engine & apex-pdp are using different version of eclipselink
662 - POLICY-1250 Fix issues reported by sonar in policy modules
663 - POLICY-1368 Remove hibernate from policy repos
664 - POLICY-1457 Use Alpine in base docker images
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400665
666 * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
Saryu Shah1000b602019-06-02 03:59:49 +0000667 - S3P Performance related items
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400668
669 * [POLICY-1171] - Enhance CLC Facility
Jim Hahn087f4fc2020-08-19 11:54:57 -0400670 - POLICY-1173 High-level specification of coordination directives
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400671
672 * [POLICY-1220] - This epic covers the work to support S3P Security criteria
Jim Hahn087f4fc2020-08-19 11:54:57 -0400673 - POLICY-1538 Upgrade Elasticsearch to 6.4.x to clear security issue
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400674
675 * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
Jim Hahn087f4fc2020-08-19 11:54:57 -0400676 - POLICY-1270 Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
677 - POLICY-1271 PAP RESTful HealthCheck/Statistics Main Entry Point
678 - POLICY-1272 Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
679 - POLICY-1273 Policy Type Application Design Requirements
680 - POLICY-1436 XACML PDP RESTful HealthCheck/Statistics Main Entry Point
681 - POLICY-1440 XACML PDP RESTful Decision API Main Entry Point
682 - POLICY-1441 Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
683 - POLICY-1442 Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
684 - POLICY-1443 PAP Dmaap PDP Register/UnRegister Main Entry Point
685 - POLICY-1444 PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
686 - POLICY-1445 XACML PDP upgrade to xacml 2.0.0
687 - POLICY-1446 Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
688 - POLICY-1447 Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
689 - POLICY-1449 XACML PDP Dmaap Register/UnRegister Functionality
690 - POLICY-1451 XACML PDP Dmaap Deploy/UnDeploy Functionality
691 - POLICY-1452 Apex PDP Dmaap Register/UnRegister Functionality
692 - POLICY-1453 Apex PDP Dmaap Deploy/UnDeploy Functionality
693 - POLICY-1454 Drools PDP Dmaap Register/UnRegister Functionality
694 - POLICY-1455 Drools PDP Dmaap Deploy/UnDeploy Functionality
695 - POLICY-1456 Policy Architecture and Roadmap Documentation
696 - POLICY-1458 Create S3P JMeter Tests for Policy API
697 - POLICY-1460 Create S3P JMeter Tests for PAP
698 - POLICY-1461 Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
699 - POLICY-1462 Create S3P JMeter Tests for Policy SDC Distribution
700 - POLICY-1471 Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
701 - POLICY-1474 Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
702 - POLICY-1515 Prototype Policy Lifecycle API Swagger Entry Points
703 - POLICY-1516 Prototype the Policy Decision API
704 - POLICY-1541 PAP REST API for PDPGroup Query, Statistics & Delete
705 - POLICY-1542 PAP REST API for PDPGroup Deployment, State Management & Health Check
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400706
707 * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
Saryu Shah1000b602019-06-02 03:59:49 +0000708 - Model drive control loop related items
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400709
710 * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
Jim Hahn087f4fc2020-08-19 11:54:57 -0400711 - POLICY-1405 Develop SDNC API for trigger bandwidth
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400712
713 * [POLICY-1408] - This epic covers the work done with the Casablanca release
Jim Hahn087f4fc2020-08-19 11:54:57 -0400714 - POLICY-1410 List Policy API
715 - POLICY-1413 Dashboard enhancements
716 - POLICY-1414 Push Policy and DeletePolicy API enhancement
717 - POLICY-1416 Model enhancements to support CLAMP
718 - POLICY-1417 Resiliency improvements
719 - POLICY-1418 PDP APIs - make ClientAuth optional
720 - POLICY-1419 Better multi-role support
721 - POLICY-1420 Model enhancement to support embedded JSON
722 - POLICY-1421 New audit data for push/delete
723 - POLICY-1422 Enhanced encryption
724 - POLICY-1423 Save original model file
725 - POLICY-1427 Controller Logging Feature
726 - POLICY-1489 PDP-D: Nested JSON Event Filtering support with JsonPath
727 - POLICY-1499 Mdc Filter Feature
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400728
729 * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
Jim Hahn087f4fc2020-08-19 11:54:57 -0400730 - POLICY-1463 Functional code changes in Policy for OOF SON use case
731 - POLICY-1464 Config related aspects for OOF SON use case
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400732
733 * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
Jim Hahn087f4fc2020-08-19 11:54:57 -0400734 - POLICY-1278 AAI named-queries are being deprecated and should be replaced with custom-queries
735 - POLICY-1545 E2E Automation - Parse the newly added model ids from operation policy
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400736
737 * Additional items delivered with the release.
Jim Hahn087f4fc2020-08-19 11:54:57 -0400738 - POLICY-1159 Move expectException to policy-common/utils-test
739 - POLICY-1176 Work on technical debt introduced by CLC POC
740 - POLICY-1266 A&AI Modularity
741 - POLICY-1274 further improvement in PSSD S3P test
742 - POLICY-1401 Build onap.policies.Monitoring TOSCA Policy Template
743 - POLICY-1465 Support configurable Heap Memory Settings for JVM processes
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400744
745
746**Bug Fixes**
747
748The following bug fixes have been deployed with this release:
749
Saryu Shah1000b602019-06-02 03:59:49 +0000750 * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400751 * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
752 * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
753 * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
Saryu Shah1000b602019-06-02 03:59:49 +0000754 * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400755
756**Security Notes**
757
758*Fixed Security Issues*
759
760 * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
761 * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
762 * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
763 * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
764
765*Known Security Issues*
766
767*Known Vulnerabilities in Used Modules*
768
769POLICY 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>`_.
770
771Quick Links:
772 - `POLICY project page`_
773 - `Passing Badge information for POLICY`_
774 - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
775
776
777**Known Issues**
778
779The following known issues will be addressed in a future release:
780
Jim Hahn087f4fc2020-08-19 11:54:57 -0400781 * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
Saryu Shah1000b602019-06-02 03:59:49 +0000782 * `[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.
783 * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
784 * `[POLICY-1378] - <https://jira.onap.org/browse/POLICY-1378>`_ add support to append value into policyScope while one policy could be used by several services
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400785 * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
Saryu Shah1000b602019-06-02 03:59:49 +0000786 * `[POLICY-1671] - <https://jira.onap.org/browse/POLICY-1671>`_ policy/engine JUnit tests now take over 30 minutes to run
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400787 * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
Saryu Shah1000b602019-06-02 03:59:49 +0000788 * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
789 * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
790 * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
Jim Hahn087f4fc2020-08-19 11:54:57 -0400791 * `[POLICY-1808] - <https://jira.onap.org/browse/POLICY-1808>`_ API|PAP|PDP-X [new] should publish docker images with the following tag X.Y-SNAPSHOT-latest
Saryu Shah1000b602019-06-02 03:59:49 +0000792 * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
793 * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
794 * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
795 * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
Pamela Dragoshf9f78d12019-06-28 08:17:38 -0400796 * `[POLICY-1872] - <https://jira.onap.org/browse/POLICY-1872>`_ brmsgw fails building a jar - trafficgenerator dependency does not exist
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400797
798
799.. ==========================
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400800.. * * * CASABLANCA * * *
801.. ==========================
802
803Version: 3.0.2
804--------------
805
806:Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
807
808The following items were deployed with the Casablanca Maintenance Release:
809
810**Bug Fixes**
811
812 * [POLICY-1522] - Policy doesn't send "payload" field to APPC
813
814**Security Fixes**
815
816 * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400817
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400818**License Issues**
819
820 * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
821
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400822**Known Issues**
823
824The following known issue will be addressed in a future release.
825
826 * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
827
828A 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.
829
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400830
831Version: 3.0.1
832--------------
833
834:Release Date: 2019-01-31 (Casablanca Maintenance Release)
835
836The following items were deployed with the Casablanca Maintenance Release:
837
838**New Features**
839
840 * [POLICY-1221] - Policy distribution application to support HTTPS communication
841 * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
842
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400843**Bug Fixes**
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400844
845 * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
846 * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
847
848
849Version: 3.0.0
850--------------
851
852:Release Date: 2018-11-30 (Casablanca Release)
853
854**New Features**
855
856The 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).
857
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400858 * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
859
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400860 The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400861
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400862 * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
863 * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
864 * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400865
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400866 The policy team did some forward looking spike work towards re-building the Software Architecture.
867
868 * [POLICY-809] - Maintain and implement performance
869 * [POLICY-814] - 72 hour stability testing (component and platform)
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400870
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400871 The policy team made enhancements to the Drools PDP to further support S3P Performance.
872 For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
873 performance standard and performed 72 hour stability tests.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400874
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400875 * [POLICY-824] - maintain and implement security
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400876
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400877 The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
878 MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400879
880 * [POLICY-840] - Flexible control loop coordination facility.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400881
882 Work towards a POC for control loop coordination policies were implemented.
883
884 * [POLICY-841] - Covers the work required to support HPA
885
886 Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
887
888 * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400889
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400890 Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
891
892 * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400893
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400894 A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
895 sonar issues, and checkstyle.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400896
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400897 * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
898
899 Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
900
901 * [POLICY-1182] - Covers the work to support CCVPN use case
902
903 Policy templates changes were submitted that supported the CCVPN use case.
904
905**Bug Fixes**
906
907The following bug fixes have been deployed with this release:
908
909 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
910 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
911 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
912 * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
913 * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
914 * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
915 * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
916 * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
917
918
919**Security Notes**
920
921POLICY 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>`_.
922
923Quick Links:
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400924 - `POLICY project page`_
925 - `Passing Badge information for POLICY`_
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400926 - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
927
928**Known Issues**
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400929
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400930 * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
931 * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
932
933
934
935.. =======================
936.. * * * BEIJING * * *
937.. =======================
938
939Version: 2.0.0
940--------------
941
942:Release Date: 2018-06-07 (Beijing Release)
943
944**New Features**
945
946The Beijing release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Beijing release, refer to `JiraPolicyBeijing`_.
947
948 * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
Jim Hahn087f4fc2020-08-19 11:54:57 -0400949 - POLICY-238 policy/drools-applications: clean up maven structure
950 - POLICY-336 Address Technical Debt
951 - POLICY-338 Address JUnit Code Coverage
952 - POLICY-377 Policy Create API should validate input matches DCAE microservice template
953 - POLICY-389 Cleanup Jenkin's CI/CD process's
954 - POLICY-449 Policy API + Console : Common Policy Validation
955 - POLICY-568 Integration with org.onap AAF project
956 - POLICY-610 Support vDNS scale out for multiple times in Beijing release
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400957
958 * [POLICY-391] - This epic covers the work to support Release Planning activities
Jim Hahn087f4fc2020-08-19 11:54:57 -0400959 - POLICY-552 ONAP Licensing Scan - Use Restrictions
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400960
961 * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -0400962 - POLICY-529 Platform Maturity Performance - Drools PDP
963 - POLICY-567 Platform Maturity Performance - PDP-X
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400964
965 * [POLICY-394] - This epic covers the work required to support a Policy developer environment in which Policy Developers can create, update policy templates/rules separate from the policy Platform runtime platform.
Jim Hahn087f4fc2020-08-19 11:54:57 -0400966 - POLICY-488 pap should not add rules to official template provided in drools applications
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400967
968 * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
Jim Hahn087f4fc2020-08-19 11:54:57 -0400969 - POLICY-434 need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400970
971 * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
Jim Hahn087f4fc2020-08-19 11:54:57 -0400972 - POLICY-622 Integrate OOF Policy Model into Policy Platform
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400973
974 * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -0400975 - POLICY-525 Platform Maturity Stability - Drools PDP
976 - POLICY-526 Platform Maturity Stability - XACML PDP
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400977
978 * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
Jim Hahn087f4fc2020-08-19 11:54:57 -0400979 - POLICY-527 Platform Maturity Resiliency - Policy Engine GUI and PAP
980 - POLICY-528 Platform Maturity Resiliency - Drools PDP
981 - POLICY-569 Platform Maturity Resiliency - BRMS Gateway
982 - POLICY-585 Platform Maturity Resiliency - XACML PDP
983 - POLICY-586 Platform Maturity Resiliency - Planning
984 - POLICY-681 Regression Test Use Cases
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400985
986 * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -0400987 - POLICY-523 Platform Maturity Security - CII Badging - Project Website
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400988
989 * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -0400990 - POLICY-531 Platform Maturity Scalability - XACML PDP
991 - POLICY-532 Platform Maturity Scalability - Drools PDP
992 - POLICY-623 Docker image re-design
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400993
994 * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -0400995 - POLICY-533 Platform Maturity Manageability L1 - Logging
996 - POLICY-534 Platform Maturity Manageability - Instantiation < 1 hour
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400997
998 * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
Jim Hahn087f4fc2020-08-19 11:54:57 -0400999 - POLICY-535 Platform Maturity Usability - User Guide
1000 - POLICY-536 Platform Maturity Usability - Deployment Documentation
1001 - POLICY-537 Platform Maturity Usability - API Documentation
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001002
1003 * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
1004
1005
1006**Bug Fixes**
1007
1008The following bug fixes have been deployed with this release:
1009
1010 * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
1011 * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
1012 * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
1013 * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
1014 * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
1015 * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
1016 * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
1017 * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
1018 * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001019 * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001020 * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
1021 * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
1022 * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
1023 * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
1024 * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
1025
1026
1027**Security Notes**
1028
1029POLICY 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>`_.
1030
1031Quick Links:
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001032 - `POLICY project page`_
1033 - `Passing Badge information for POLICY`_
1034 - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001035
1036**Known Issues**
1037
1038The following known issues will be addressed in a future release:
1039
1040 * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
1041 * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
1042 * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
1043 * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
1044 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
1045 * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
1046 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
1047 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
1048
1049
1050
1051
1052Version: 1.0.2
1053--------------
1054
1055:Release Date: 2018-01-18 (Amsterdam Maintenance Release)
1056
1057**Bug Fixes**
1058
1059The following fixes were deployed with the Amsterdam Maintenance Release:
1060
1061 * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
1062
1063
1064Version: 1.0.1
1065--------------
1066
1067:Release Date: 2017-11-16 (Amsterdam Release)
1068
1069**New Features**
1070
1071The 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`_.
1072
1073 * [POLICY-31] - Stabilization of Seed Code
1074 - POLICY-25 Replace any remaining openecomp reference by onap
1075 - POLICY-32 JUnit test code coverage
1076 - POLICY-66 PDP-D Feature mechanism enhancements
1077 - POLICY-67 Rainy Day Decision Policy
1078 - POLICY-93 Notification API
1079 - POLICY-158 policy/engine: SQL injection Mitigation
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001080 - POLICY-269 Policy API Support for Rainy Day Decision Policy and Dictionaries
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001081
1082 * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001083 - POLICY-40 MSB Integration
1084 - POLICY-124 Integration with oparent
1085 - POLICY-41 OOM Integration
1086 - POLICY-119 PDP-D: noop sinks
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001087
1088 * [POLICY-34] - This epic covers the work required to support a Policy developer environment in which Policy Developers can create, update policy templates/rules separate from the policy Platform runtime platform.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001089 - POLICY-57 VF-C Actor code development
1090 - POLICY-43 Amsterdam Use Case Template
1091 - POLICY-173 Deployment of Operational Policies Documentation
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001092
1093 * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001094 - POLICY-68 TOSCA Parsing for nested objects for Microservice Policies
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001095
1096 * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
1097
1098 * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001099 - POLICY-64 CLAMP Configuration and Operation Policies for vFW Use Case
1100 - POLICY-65 CLAMP Configuration and Operation Policies for vDNS Use Case
1101 - POLICY-48 CLAMP Configuration and Operation Policies for vCPE Use Case
1102 - POLICY-63 CLAMP Configuration and Operation Policies for VOLTE Use Case
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001103
1104 * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
1105
1106 * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001107 - POLICY-61 vFW Use Case - Runtime
1108 - POLICY-62 vDNS Use Case - Runtime
1109 - POLICY-59 vCPE Use Case - Runtime
1110 - POLICY-60 VOLTE Use Case - Runtime
1111 - POLICY-51 Runtime Policy Update Support
1112 - POLICY-328 vDNS Use Case - Runtime Testing
1113 - POLICY-324 vFW Use Case - Runtime Testing
1114 - POLICY-320 VOLTE Use Case - Runtime Testing
1115 - POLICY-316 vCPE Use Case - Runtime Testing
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001116
1117 * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001118 - POLICY-77 Functional Test case definition for Control Loops
1119 - POLICY-387 Deliver the released policy artifacts
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001120
1121
1122**Bug Fixes**
1123 - 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`_.
1124
1125
1126**Known Issues**
1127 - 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.
1128
1129 - For vLBS Use Case, the following steps are required to setup the service instance:
Jim Hahn087f4fc2020-08-19 11:54:57 -04001130 - Create a Service Instance via VID.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001131 - Create a VNF Instance via VID.
LF Jenkins CI59166422020-04-07 20:34:27 +00001132 - 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.
1133 - 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.
1134 - Run heatbridge from the Robot VM using ``Vfmodule_`` _ as stack name (it is the actual stack name in OpenStack)
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001135 - Populate AAI with a dummy VF module for vDNS scaling.
1136
1137**Security Issues**
1138 - None at this time
1139
1140**Other**
1141 - None at this time
1142
1143
1144.. Links to jira release notes
1145
Pamela Dragoshe47eb662019-08-16 13:37:44 -04001146.. _JiraPolicyElAlto: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10728
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001147.. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001148.. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
1149.. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
1150.. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
1151
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001152.. Links to Project related pages
1153
1154.. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
1155.. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
1156
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001157
1158.. note
1159.. CHANGE HISTORY
Jim Hahn087f4fc2020-08-19 11:54:57 -04001160.. 09/19/2019 - Updated for El Alto Release.
1161.. 05/16/2019 - Updated for Dublin Release.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001162.. 01/17/2019 - Updated for Casablanca Maintenance Release.
1163.. 11/19/2018 - Updated for Casablanca. Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001164.. Changed version number to use ONAP versions.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001165.. 10/08/2018 - Initial document for Casablanca release.
Jim Hahn087f4fc2020-08-19 11:54:57 -04001166.. 05/29/2018 - Information for Beijing release.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001167.. 03/22/2018 - Initial document for Beijing release.
1168.. 01/15/2018 - Added change for version 1.1.3 to the Amsterdam branch. Also corrected prior version (1.2.0) to (1.1.1)
Jim Hahn087f4fc2020-08-19 11:54:57 -04001169.. Also, Set up initial information for Beijing.
1170.. Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001171
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001172
1173End of Release Notes
1174
Pamela Dragoshc1c46402019-05-29 08:10:09 -04001175.. How to notes for SS
Jim Hahn087f4fc2020-08-19 11:54:57 -04001176.. For initial document: list epic and user stories for each, list user stories with no epics.
1177.. 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.
1178.. For Known issues, list bugs that are slotted for a future release.