blob: 66c847c1ca8adb1e1dbd59b5db6d9abd9a2a78c6 [file] [log] [blame]
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -04001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3Policy Release Notes
4====================
5
6.. note
7.. * This Release Notes must be updated each time the team decides to Release new artifacts.
Pamela Dragoshc1c46402019-05-29 08:10:09 -04008.. * The scope of these Release Notes are for ONAP POLICY. In other words, each ONAP component has its Release Notes.
9.. * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -040010.. * this Release Notes.
Pamela Dragoshc1c46402019-05-29 08:10:09 -040011.. * Except the date and the version number, all the other sections are optional but there must be at least
12.. * one section describing the purpose of this new release.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -040013.. * This note must be removed after content has been added.
14
15
16.. ==========================
Pamela Dragoshc1c46402019-05-29 08:10:09 -040017.. * * * DUBLIN * * *
18.. ==========================
19
20Version: 4.0.0
21--------------
22
Pamela Dragoshdd17aa12019-06-24 09:48:58 -040023:Release Date: 2019-06-26 (Dublin Release)
Pamela Dragoshc1c46402019-05-29 08:10:09 -040024
25**New Features**
26
Pamela Dragoshdd17aa12019-06-24 09:48:58 -040027Artifacts released:
28
29.. csv-table::
30 :header: "Repository", "Java Artifact", "Docker Image (if applicable)"
31 :widths: 15,10,10
32
33 "policy/parent", "2.1.0", ""
34 "policy/common", "1.4.0", ""
35 "policy/models", "2.0.2", ""
36 "policy/api", "2.0.1", "onap/policy-api:2.0.1"
37 "policy/pap", "2.0.1", "onap/policy-pap:2.0.1"
38 "policy/drools-pdp", "1.4.0", "onap/policy-drools:1.4.0"
39 "policy/apex-pdp", "2.1.0", "onap/policy-apex-pdp:2.1.0"
40 "policy/xacml-pdp", "2.1.0", "onap/policy-xacml-pdp:2.1.0"
41 "policy/drools-applications", "1.4.2", "onap/policy-pdpd-cl:1.4.2"
42 "policy/engine", "1.4.1", "onap/policy-pe:1.4.1"
43 "policy/distribution", "2.1.0", "onap/policy-distribution:2.1.0"
44 "policy/docker", "1.4.0", "onap/policy-common-alpine:1.4.0 onap/policy/base-alpine:1.4.0"
45
Pamela Dragoshc1c46402019-05-29 08:10:09 -040046The Dublin release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Dublin release, refer to `JiraPolicyDublin`_.
47
48 * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
Pamela Dragoshc1c46402019-05-29 08:10:09 -040049 - POLICY-1195 Separate model code from drools-applications into other repositories
50 - POLICY-1367 Spike - Experimentation for management of Drools templates and Operational Policies
Saryu Shah1000b602019-06-02 03:59:49 +000051 - POLICY-1397 PDP-D: NOOP Endpoints Support to test Operational Policies.
52 - POLICY-1459 PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
Pamela Dragoshc1c46402019-05-29 08:10:09 -040053
54 * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
Pamela Dragoshc1c46402019-05-29 08:10:09 -040055 - POLICY-1007 Remove Jackson from policy framework components
Saryu Shah1000b602019-06-02 03:59:49 +000056 - POLICY-1202 policy-engine & apex-pdp are using different version of eclipselink
57 - POLICY-1250 Fix issues reported by sonar in policy modules
58 - POLICY-1368 Remove hibernate from policy repos
Pamela Dragoshc1c46402019-05-29 08:10:09 -040059 - POLICY-1457 Use Alpine in base docker images
60
61 * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
Saryu Shah1000b602019-06-02 03:59:49 +000062 - S3P Performance related items
Pamela Dragoshc1c46402019-05-29 08:10:09 -040063
64 * [POLICY-1171] - Enhance CLC Facility
65 - POLICY-1173 High-level specification of coordination directives
66
67 * [POLICY-1220] - This epic covers the work to support S3P Security criteria
Saryu Shah1000b602019-06-02 03:59:49 +000068 - POLICY-1538 Upgrade Elasticsearch to 6.4.x to clear security issue
Pamela Dragoshc1c46402019-05-29 08:10:09 -040069
70 * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
Saryu Shah1000b602019-06-02 03:59:49 +000071 - POLICY-1270 Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
72 - POLICY-1271 PAP RESTful HealthCheck/Statistics Main Entry Point
Pamela Dragoshc1c46402019-05-29 08:10:09 -040073 - POLICY-1272 Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
Saryu Shah1000b602019-06-02 03:59:49 +000074 - POLICY-1273 Policy Type Application Design Requirements
75 - POLICY-1436 XACML PDP RESTful HealthCheck/Statistics Main Entry Point
76 - POLICY-1440 XACML PDP RESTful Decision API Main Entry Point
77 - POLICY-1441 Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
78 - POLICY-1442 Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
Pamela Dragoshc1c46402019-05-29 08:10:09 -040079 - POLICY-1443 PAP Dmaap PDP Register/UnRegister Main Entry Point
80 - POLICY-1444 PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
Saryu Shah1000b602019-06-02 03:59:49 +000081 - POLICY-1445 XACML PDP upgrade to xacml 2.0.0
Pamela Dragoshc1c46402019-05-29 08:10:09 -040082 - POLICY-1446 Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
Saryu Shah1000b602019-06-02 03:59:49 +000083 - POLICY-1447 Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
84 - POLICY-1449 XACML PDP Dmaap Register/UnRegister Functionality
85 - POLICY-1451 XACML PDP Dmaap Deploy/UnDeploy Functionality
86 - POLICY-1452 Apex PDP Dmaap Register/UnRegister Functionality
87 - POLICY-1453 Apex PDP Dmaap Deploy/UnDeploy Functionality
88 - POLICY-1454 Drools PDP Dmaap Register/UnRegister Functionality
89 - POLICY-1455 Drools PDP Dmaap Deploy/UnDeploy Functionality
90 - POLICY-1456 Policy Architecture and Roadmap Documentation
91 - POLICY-1458 Create S3P JMeter Tests for Policy API
92 - POLICY-1460 Create S3P JMeter Tests for PAP
93 - POLICY-1461 Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
94 - POLICY-1462 Create S3P JMeter Tests for Policy SDC Distribution
95 - POLICY-1471 Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
96 - POLICY-1474 Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
Pamela Dragoshc1c46402019-05-29 08:10:09 -040097 - POLICY-1515 Prototype Policy Lifecycle API Swagger Entry Points
98 - POLICY-1516 Prototype the Policy Decision API
Saryu Shah1000b602019-06-02 03:59:49 +000099 - POLICY-1541 PAP REST API for PDPGroup Query, Statistics & Delete
100 - POLICY-1542 PAP REST API for PDPGroup Deployment, State Management & Health Check
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400101
102 * [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 +0000103 - Model drive control loop related items
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400104
105 * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
106 - POLICY-1405 Develop SDNC API for trigger bandwidth
107
108 * [POLICY-1408] - This epic covers the work done with the Casablanca release
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400109 - POLICY-1410 List Policy API
Saryu Shah1000b602019-06-02 03:59:49 +0000110 - POLICY-1413 Dashboard enhancements
111 - POLICY-1414 Push Policy and DeletePolicy API enhancement
112 - POLICY-1416 Model enhancements to support CLAMP
113 - POLICY-1417 Resiliency improvements
114 - POLICY-1418 PDP APIs - make ClientAuth optional
115 - POLICY-1419 Better multi-role support
116 - POLICY-1420 Model enhancement to support embedded JSON
117 - POLICY-1421 New audit data for push/delete
118 - POLICY-1422 Enhanced encryption
119 - POLICY-1423 Save original model file
120 - POLICY-1427 Controller Logging Feature
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400121 - POLICY-1489 PDP-D: Nested JSON Event Filtering support with JsonPath
Saryu Shah1000b602019-06-02 03:59:49 +0000122 - POLICY-1499 Mdc Filter Feature
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400123
124 * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400125 - POLICY-1463 Functional code changes in Policy for OOF SON use case
Saryu Shah1000b602019-06-02 03:59:49 +0000126 - POLICY-1464 Config related aspects for OOF SON use case
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400127
128 * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
129 - POLICY-1278 AAI named-queries are being deprecated and should be replaced with custom-queries
130 - POLICY-1545 E2E Automation - Parse the newly added model ids from operation policy
131
132 * Additional items delivered with the release.
Saryu Shah1000b602019-06-02 03:59:49 +0000133 - POLICY-1159 Move expectException to policy-common/utils-test
134 - POLICY-1176 Work on technical debt introduced by CLC POC
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400135 - POLICY-1266 A&AI Modularity
136 - POLICY-1274 further improvement in PSSD S3P test
Saryu Shah1000b602019-06-02 03:59:49 +0000137 - POLICY-1401 Build onap.policies.Monitoring TOSCA Policy Template
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400138 - POLICY-1465 Support configurable Heap Memory Settings for JVM processes
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400139
140
141**Bug Fixes**
142
143The following bug fixes have been deployed with this release:
144
Saryu Shah1000b602019-06-02 03:59:49 +0000145 * `[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 -0400146 * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
147 * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
148 * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
Saryu Shah1000b602019-06-02 03:59:49 +0000149 * `[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 -0400150
151**Security Notes**
152
153*Fixed Security Issues*
154
155 * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
156 * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
157 * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
158 * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
159
160*Known Security Issues*
161
162*Known Vulnerabilities in Used Modules*
163
164POLICY 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>`_.
165
166Quick Links:
167 - `POLICY project page`_
168 - `Passing Badge information for POLICY`_
169 - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
170
171
172**Known Issues**
173
174The following known issues will be addressed in a future release:
175
Saryu Shah1000b602019-06-02 03:59:49 +0000176 * `[POLICY-1795] - <https://jira.onap.org/browse/POLICY-1795>`_ PAP: bounced apex and xacml pdps show deleted instance in pdp status through APIs.
177 * `[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.
178 * `[POLICY-1277] - <https://jira.onap.org/browse/POLICY-1277>`_ policy config takes too long time to become retrievable in PDP
179 * `[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 -0400180 * `[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 +0000181 * `[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 -0400182 * `[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 +0000183 * `[POLICY-1793] - <https://jira.onap.org/browse/POLICY-1793>`_ API|MODELS: Retrieving Legacy Operational Policy as a Tosca Policy with wrong version
184 * `[POLICY-1800] - <https://jira.onap.org/browse/POLICY-1800>`_ API|PAP components use different version formats
185 * `[POLICY-1802] - <https://jira.onap.org/browse/POLICY-1802>`_ Apex-pdp: context album is mandatory for policy model to compile
186 * `[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
187 * `[POLICY-1818] - <https://jira.onap.org/browse/POLICY-1818>`_ APEX does not allow arbitrary Kafka parameters to be specified
188 * `[POLICY-1276] - <https://jira.onap.org/browse/POLICY-1276>`_ JRuby interpreter shutdown fails on second and subsequent runs
189 * `[POLICY-1803] - <https://jira.onap.org/browse/POLICY-1803>`_ PAP should undeploy policies when subgroup is deleted
190 * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
Pamela Dragoshf9f78d12019-06-28 08:17:38 -0400191 * `[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 -0400192
193
194.. ==========================
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400195.. * * * CASABLANCA * * *
196.. ==========================
197
198Version: 3.0.2
199--------------
200
201:Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
202
203The following items were deployed with the Casablanca Maintenance Release:
204
205**Bug Fixes**
206
207 * [POLICY-1522] - Policy doesn't send "payload" field to APPC
208
209**Security Fixes**
210
211 * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400212
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400213**License Issues**
214
215 * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
216
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400217**Known Issues**
218
219The following known issue will be addressed in a future release.
220
221 * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
222
223A 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.
224
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400225
226Version: 3.0.1
227--------------
228
229:Release Date: 2019-01-31 (Casablanca Maintenance Release)
230
231The following items were deployed with the Casablanca Maintenance Release:
232
233**New Features**
234
235 * [POLICY-1221] - Policy distribution application to support HTTPS communication
236 * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
237
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400238**Bug Fixes**
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400239
240 * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
241 * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
242
243
244Version: 3.0.0
245--------------
246
247:Release Date: 2018-11-30 (Casablanca Release)
248
249**New Features**
250
251The 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).
252
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400253 * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
254
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400255 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 -0400256
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400257 * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
258 * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
259 * [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 -0400260
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400261 The policy team did some forward looking spike work towards re-building the Software Architecture.
262
263 * [POLICY-809] - Maintain and implement performance
264 * [POLICY-814] - 72 hour stability testing (component and platform)
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400265
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400266 The policy team made enhancements to the Drools PDP to further support S3P Performance.
267 For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
268 performance standard and performed 72 hour stability tests.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400269
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400270 * [POLICY-824] - maintain and implement security
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400271
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400272 The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
273 MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400274
275 * [POLICY-840] - Flexible control loop coordination facility.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400276
277 Work towards a POC for control loop coordination policies were implemented.
278
279 * [POLICY-841] - Covers the work required to support HPA
280
281 Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
282
283 * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400284
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400285 Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
286
287 * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400288
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400289 A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
290 sonar issues, and checkstyle.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400291
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400292 * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
293
294 Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
295
296 * [POLICY-1182] - Covers the work to support CCVPN use case
297
298 Policy templates changes were submitted that supported the CCVPN use case.
299
300**Bug Fixes**
301
302The following bug fixes have been deployed with this release:
303
304 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
305 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
306 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
307 * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
308 * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
309 * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
310 * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
311 * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
312
313
314**Security Notes**
315
316POLICY 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>`_.
317
318Quick Links:
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400319 - `POLICY project page`_
320 - `Passing Badge information for POLICY`_
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400321 - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
322
323**Known Issues**
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400324
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400325 * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
326 * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
327
328
329
330.. =======================
331.. * * * BEIJING * * *
332.. =======================
333
334Version: 2.0.0
335--------------
336
337:Release Date: 2018-06-07 (Beijing Release)
338
339**New Features**
340
341The Beijing release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Beijing release, refer to `JiraPolicyBeijing`_.
342
343 * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
344 - POLICY-238 policy/drools-applications: clean up maven structure
345 - POLICY-336 Address Technical Debt
346 - POLICY-338 Address JUnit Code Coverage
347 - POLICY-377 Policy Create API should validate input matches DCAE microservice template
348 - POLICY-389 Cleanup Jenkin's CI/CD process's
349 - POLICY-449 Policy API + Console : Common Policy Validation
350 - POLICY-568 Integration with org.onap AAF project
351 - POLICY-610 Support vDNS scale out for multiple times in Beijing release
352
353 * [POLICY-391] - This epic covers the work to support Release Planning activities
354 - POLICY-552 ONAP Licensing Scan - Use Restrictions
355
356 * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
357 - POLICY-529 Platform Maturity Performance - Drools PDP
358 - POLICY-567 Platform Maturity Performance - PDP-X
359
360 * [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.
361 - POLICY-488 pap should not add rules to official template provided in drools applications
362
363 * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
364 - POLICY-434 need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
365
366 * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
367 - POLICY-622 Integrate OOF Policy Model into Policy Platform
368
369 * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
370 - POLICY-525 Platform Maturity Stability - Drools PDP
371 - POLICY-526 Platform Maturity Stability - XACML PDP
372
373 * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
374 - POLICY-527 Platform Maturity Resiliency - Policy Engine GUI and PAP
375 - POLICY-528 Platform Maturity Resiliency - Drools PDP
376 - POLICY-569 Platform Maturity Resiliency - BRMS Gateway
377 - POLICY-585 Platform Maturity Resiliency - XACML PDP
378 - POLICY-586 Platform Maturity Resiliency - Planning
379 - POLICY-681 Regression Test Use Cases
380
381 * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
382 - POLICY-523 Platform Maturity Security - CII Badging - Project Website
383
384 * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
385 - POLICY-531 Platform Maturity Scalability - XACML PDP
386 - POLICY-532 Platform Maturity Scalability - Drools PDP
387 - POLICY-623 Docker image re-design
388
389 * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
390 - POLICY-533 Platform Maturity Manageability L1 - Logging
391 - POLICY-534 Platform Maturity Manageability - Instantiation < 1 hour
392
393 * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
394 - POLICY-535 Platform Maturity Usability - User Guide
395 - POLICY-536 Platform Maturity Usability - Deployment Documentation
396 - POLICY-537 Platform Maturity Usability - API Documentation
397
398 * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
399
400
401**Bug Fixes**
402
403The following bug fixes have been deployed with this release:
404
405 * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
406 * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
407 * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
408 * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
409 * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
410 * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
411 * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
412 * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
413 * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400414 * `[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 -0400415 * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
416 * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
417 * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
418 * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
419 * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
420
421
422**Security Notes**
423
424POLICY 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>`_.
425
426Quick Links:
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400427 - `POLICY project page`_
428 - `Passing Badge information for POLICY`_
429 - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400430
431**Known Issues**
432
433The following known issues will be addressed in a future release:
434
435 * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
436 * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
437 * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
438 * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
439 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
440 * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
441 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
442 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
443
444
445
446
447Version: 1.0.2
448--------------
449
450:Release Date: 2018-01-18 (Amsterdam Maintenance Release)
451
452**Bug Fixes**
453
454The following fixes were deployed with the Amsterdam Maintenance Release:
455
456 * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
457
458
459Version: 1.0.1
460--------------
461
462:Release Date: 2017-11-16 (Amsterdam Release)
463
464**New Features**
465
466The 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`_.
467
468 * [POLICY-31] - Stabilization of Seed Code
469 - POLICY-25 Replace any remaining openecomp reference by onap
470 - POLICY-32 JUnit test code coverage
471 - POLICY-66 PDP-D Feature mechanism enhancements
472 - POLICY-67 Rainy Day Decision Policy
473 - POLICY-93 Notification API
474 - POLICY-158 policy/engine: SQL injection Mitigation
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400475 - POLICY-269 Policy API Support for Rainy Day Decision Policy and Dictionaries
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400476
477 * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400478 - POLICY-40 MSB Integration
479 - POLICY-124 Integration with oparent
480 - POLICY-41 OOM Integration
481 - POLICY-119 PDP-D: noop sinks
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400482
483 * [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 -0400484 - POLICY-57 VF-C Actor code development
485 - POLICY-43 Amsterdam Use Case Template
486 - POLICY-173 Deployment of Operational Policies Documentation
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400487
488 * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400489 - POLICY-68 TOSCA Parsing for nested objects for Microservice Policies
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400490
491 * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
492
493 * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400494 - POLICY-64 CLAMP Configuration and Operation Policies for vFW Use Case
495 - POLICY-65 CLAMP Configuration and Operation Policies for vDNS Use Case
496 - POLICY-48 CLAMP Configuration and Operation Policies for vCPE Use Case
497 - POLICY-63 CLAMP Configuration and Operation Policies for VOLTE Use Case
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400498
499 * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
500
501 * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400502 - POLICY-61 vFW Use Case - Runtime
503 - POLICY-62 vDNS Use Case - Runtime
504 - POLICY-59 vCPE Use Case - Runtime
505 - POLICY-60 VOLTE Use Case - Runtime
506 - POLICY-51 Runtime Policy Update Support
507 - POLICY-328 vDNS Use Case - Runtime Testing
508 - POLICY-324 vFW Use Case - Runtime Testing
509 - POLICY-320 VOLTE Use Case - Runtime Testing
510 - POLICY-316 vCPE Use Case - Runtime Testing
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400511
512 * [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 -0400513 - POLICY-77 Functional Test case definition for Control Loops
514 - POLICY-387 Deliver the released policy artifacts
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400515
516
517**Bug Fixes**
518 - 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`_.
519
520
521**Known Issues**
522 - 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.
523
524 - For vLBS Use Case, the following steps are required to setup the service instance:
525 - Create a Service Instance via VID.
526 - Create a VNF Instance via VID.
527 - 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.
528 - 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. Well relax this naming requirement for Beijing Release.
529 - Run heatbridge from the Robot VM using ``Vfmodule_`` as stack name (it is the actual stack name in OpenStack)
530 - Populate AAI with a dummy VF module for vDNS scaling.
531
532**Security Issues**
533 - None at this time
534
535**Other**
536 - None at this time
537
538
539.. Links to jira release notes
540
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400541.. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400542.. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
543.. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
544.. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
545
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400546.. Links to Project related pages
547
548.. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
549.. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
550
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400551
552.. note
553.. CHANGE HISTORY
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400554.. 05/16/2019 - Updated for Dublin Release.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400555.. 01/17/2019 - Updated for Casablanca Maintenance Release.
556.. 11/19/2018 - Updated for Casablanca. Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
557.. Changed version number to use ONAP versions.
558.. 10/08/2018 - Initial document for Casablanca release.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400559.. Per Jorge, POLICY-785 did not get done in Casablanca (removed).
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400560.. 05/29/2018 - Information for Beijing release.
561.. 03/22/2018 - Initial document for Beijing release.
562.. 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)
563.. Also, Set up initial information for Beijing.
564.. Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400565
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400566
567End of Release Notes
568
Pamela Dragoshc1c46402019-05-29 08:10:09 -0400569.. How to notes for SS
570.. For initial document: list epic and user stories for each, list user stories with no epics.
571.. 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.
Pamela Dragosh5fc2fdb2019-05-17 09:42:27 -0400572.. For Known issues, list bugs that are slotted for a future release.