Document fixed OJSI-184 vulnerability
[policy/engine.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Policy Release Notes
4 ====================
5
6 .. note
7 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
8 ..      * 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
10 ..      * this Release Notes.
11 ..      * 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.
13 ..      * This note must be removed after content has been added.
14
15
16 ..      ==========================
17 ..      * * *      DUBLIN    * * *
18 ..      ==========================
19
20 Version: 4.0.0
21 --------------
22
23 :Release Date: 2019-06-06 (Dublin Release)
24
25 **New Features**
26
27 The Dublin release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Dublin release, refer to `JiraPolicyDublin`_.
28
29     * [POLICY-1068] - This epic covers the work to cleanup, enhance, fix, etc. any Control Loop based code base.
30         - POLICY-1459   PDP-D [Control Loop] : Create a Control Loop flavored PDP-D image
31         - POLICY-1397   PDP-D: NOOP Endpoints Support to test Operational Policies.
32         - POLICY-1195   Separate model code from drools-applications into other repositories
33         - POLICY-1367   Spike - Experimentation for management of Drools templates and Operational Policies
34
35     * [POLICY-1069] - This epic covers the work to harden the codebase for the Policy Framework project.
36         - POLICY-1250   Fix issues reported by sonar in policy modules
37         - POLICY-1202   policy-engine & apex-pdp are using different version of eclipselink
38         - POLICY-1368   Remove hibernate from policy repos
39         - POLICY-1007   Remove Jackson from policy framework components
40         - POLICY-1457   Use Alpine in base docker images
41
42     * [POLICY-1072] - This epic covers the work to support S3P Performance criteria.
43
44     * [POLICY-1171] - Enhance CLC Facility
45         - POLICY-1173   High-level specification of coordination directives
46
47     * [POLICY-1220] - This epic covers the work to support S3P Security criteria
48         - Task  POLICY-1538     Upgrade Elasticsearch to 6.4.x to clear security issue
49
50     * [POLICY-1269] - R4 Dublin - ReBuild Policy Infrastructure
51         - POLICY-1453   Apex PDP Dmaap Deploy/UnDeploy Functionality
52         - POLICY-1452   Apex PDP Dmaap Register/UnRegister Functionality
53         - POLICY-1460   Create S3P JMeter Tests for PAP
54         - POLICY-1458   Create S3P JMeter Tests for Policy API
55         - POLICY-1462   Create S3P JMeter Tests for Policy SDC Distribution
56         - POLICY-1461   Create S3P JMeter Tests for Policy XACML Engine (2nd Generation)
57         - POLICY-1272   Create the S3P JMeter tests for API, PAP, XACML (2nd Gen)
58         - POLICY-1455   Drools PDP Dmaap Deploy/UnDeploy Functionality
59         - POLICY-1454   Drools PDP Dmaap Register/UnRegister Functionality
60         - POLICY-1474   Modifications of Control Loop Operational Policy to support new Policy Lifecycle API
61         - POLICY-1443   PAP Dmaap PDP Register/UnRegister Main Entry Point
62         - POLICY-1444   PAP Dmaap Policy Deploy/Undeploy Policies Main Entry Point
63         - POLICY-1542   PAP REST API for PDPGroup Deployment, State Management & Health Check
64         - POLICY-1541   PAP REST API for PDPGroup Query, Statistics & Delete
65         - POLICY-1271   PAP RESTful HealthCheck/Statistics Main Entry Point
66         - POLICY-1471   Policy Application Designer - Develop Guard and Control Loop Coordination Policy Type application
67         - POLICY-1456   Policy Architecture and Roadmap Documentation
68         - POLICY-1442   Policy Lifecycle API RESTful Create/Read Main Entry Point for Concrete Policies
69         - POLICY-1441   Policy Lifecycle API RESTful Create/Read Main Entry Point for Policy Types
70         - POLICY-1447   Policy Lifecycle API RESTful Delete Main Entry Point for Concrete Policies
71         - POLICY-1446   Policy Lifecycle API RESTful Delete Main Entry Point for Policy Types
72         - POLICY-1270   Policy Lifecycle API RESTful HealthCheck/Statistics Main Entry Point
73         - POLICY-1273   Policy Type Application Design Requirements
74         - POLICY-1515   Prototype Policy Lifecycle API Swagger Entry Points
75         - POLICY-1516   Prototype the Policy Decision API
76         - POLICY-1451   XACML PDP Dmaap Deploy/UnDeploy Functionality
77         - POLICY-1449   XACML PDP Dmaap Register/UnRegister Functionality
78         - POLICY-1440   XACML PDP RESTful Decision API Main Entry Point
79         - POLICY-1436   XACML PDP RESTful HealthCheck/Statistics Main Entry Point
80         - POLICY-1445   XACML PDP upgrade to xacml 2.0.0
81
82     * [POLICY-1399] - This epic covers the work to support model drive control loop design as defined by the Control Loop Subcommittee
83
84     * [POLICY-1404] - This epic covers the work to support the CCVPN Use Case for Dublin
85         - POLICY-1405   Develop SDNC API for trigger bandwidth
86
87     * [POLICY-1408] - This epic covers the work done with the Casablanca release
88         - POLICY-1419   Better multi-role support
89         - POLICY-1427   Controller Logging Feature
90         - POLICY-1413   Dashboard enhancements
91         - POLICY-1422   Enhanced encryption
92         - POLICY-1420   Model enhancement to support embedded JSON
93         - POLICY-1416   Model enhancements to support CLAMP
94         - POLICY-1421   New audit data for push/delete
95         - POLICY-1418   PDP APIs - make ClientAuth optional
96         - POLICY-1414   Push Policy and DeletePolicy API enhancement
97         - POLICY-1417   Resiliency improvements
98         - POLICY-1423   Save original model file
99         - POLICY-1410   List Policy API
100         - POLICY-1499   Mdc Filter Feature
101         - POLICY-1489   PDP-D: Nested JSON Event Filtering support with JsonPath
102
103     * [POLICY-1438] - This epic covers the work to support 5G OOF PCI Use Case
104         - POLICY-1464   Config related aspects for OOF SON use case
105         - POLICY-1463   Functional code changes in Policy for OOF SON use case
106
107     * [POLICY-1450] - This epic covers the work to support the Scale Out Use Case.
108         - POLICY-1278   AAI named-queries are being deprecated and should be replaced with custom-queries
109         - POLICY-1545   E2E Automation - Parse the newly added model ids from operation policy
110
111     * Additional items delivered with the release.
112         - POLICY-1266   A&AI Modularity
113         - POLICY-1274   further improvement in PSSD S3P test
114         - POLICY-1159   Move expectException to policy-common/utils-test
115         - POLICY-1465   Support configurable Heap Memory Settings for JVM processes
116         - POLICY-1176   Work on technical debt introduced by CLC POC
117
118
119 **Bug Fixes**
120
121 The following bug fixes have been deployed with this release:
122
123     * `[POLICY-1627] <https://jira.onap.org/browse/POLICY-1627>`_ - APEX does not support specification of a partitioner class for Kafka
124     * `[POLICY-1289] <https://jira.onap.org/browse/POLICY-1289>`_ - Apex only considers 200 response codes as successful result codes
125     * `[POLICY-1437] <https://jira.onap.org/browse/POLICY-1437>`_ - Fix issues in FileSystemReceptionHandler of policy-distribution component
126     * `[POLICY-1501] <https://jira.onap.org/browse/POLICY-1501>`_ - policy-engine JUnit tests are not independent
127     * `[POLICY-1241] <https://jira.onap.org/browse/POLICY-1241>`_ - Test failure in drools-pdp if JAVA_HOME is not set
128
129 **Security Notes**
130
131 *Fixed Security Issues*
132
133     * `[OJSI-117] <https://jira.onap.org/browse/OJSI-117>`_ - In default deployment POLICY (nexus) exposes HTTP port 30236 outside of cluster.
134     * `[OJSI-157] <https://jira.onap.org/browse/OJSI-157>`_ - In default deployment POLICY (policy-api) exposes HTTP port 30240 outside of cluster.
135     * `[OJSI-118] <https://jira.onap.org/browse/OJSI-118>`_ - In default deployment POLICY (policy-apex-pdp) exposes HTTP port 30237 outside of cluster.
136     * `[OJSI-184] <https://jira.onap.org/browse/OJSI-184>`_ - In default deployment POLICY (brmsgw) exposes HTTP port 30216 outside of cluster.
137
138 *Known Security Issues*
139
140 *Known Vulnerabilities in Used Modules*
141
142 POLICY code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_.
143
144 Quick Links:
145     - `POLICY project page`_
146     - `Passing Badge information for POLICY`_
147     - `Project Vulnerability Review Table for POLICY (Dublin Release) <https://wiki.onap.org/pages/viewpage.action?pageId=54723253>`_
148
149
150 **Known Issues**
151
152 The following known issues will be addressed in a future release:
153
154     * `[POLICY-1291] - <https://jira.onap.org/browse/POLICY-1291>`_ Maven Error when building Apex documentation in Windows
155     * `[POLICY-1650] - <https://jira.onap.org/browse/POLICY-1650>`_ Policy UI doesn't show left menu or any content
156     * `[POLICY-1725] - <https://jira.onap.org/browse/POLICY-1725>`_ XACML PDP returns 500 vs 400 for bad syntax JSON
157
158
159
160 ..      ==========================
161 ..      * * *   CASABLANCA   * * *
162 ..      ==========================
163
164 Version: 3.0.2
165 --------------
166
167 :Release Date: 2019-03-31 (Casablanca Maintenance Release #2)
168
169 The following items were deployed with the Casablanca Maintenance Release:
170
171 **Bug Fixes**
172
173     * [POLICY-1522] - Policy doesn't send "payload" field to APPC
174
175 **Security Fixes**
176
177     * [POLICY-1538] - Upgrade Elasticsearch to 6.4.x to clear security issue
178
179 **License Issues**
180
181     * [POLICY-1433] - Remove proprietary licenses in PSSD test CSAR
182
183 **Known Issues**
184
185 The following known issue will be addressed in a future release.
186
187     * `[POLICY-1650] <https://jira.onap.org/browse/POLICY-1277>`_ - Policy UI doesn't show left menu or any content
188
189 A workaround for this issue consists in bypassing the Portal UI when accessing the Policy UI.   See `PAP recipes <https://docs.onap.org/en/casablanca/submodules/policy/engine.git/docs/platform/cookbook.html?highlight=policy%20cookbook#id23>`_ for the specific procedure.
190
191
192 Version: 3.0.1
193 --------------
194
195 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
196
197 The following items were deployed with the Casablanca Maintenance Release:
198
199 **New Features**
200
201     * [POLICY-1221] - Policy distribution application to support HTTPS communication
202     * [POLICY-1222] - Apex policy PDP to support HTTPS Communication
203
204 **Bug Fixes**
205
206     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
207     * `[POLICY-1395] <https://jira.onap.org/browse/POLICY-1395>`_ - Apex PDP does not preserve context on model upgrade
208
209
210 Version: 3.0.0
211 --------------
212
213 :Release Date: 2018-11-30 (Casablanca Release)
214
215 **New Features**
216
217 The Casablanca release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Casablanca release, refer to `JiraPolicyCasablanca`_ (Note: Jira details can also be viewed from this link).
218
219     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
220
221     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
222
223     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
224     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
225     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
226
227     The policy team did some forward looking spike work towards re-building the Software Architecture.
228
229     * [POLICY-809] - Maintain and implement performance
230     * [POLICY-814] - 72 hour stability testing (component and platform)
231
232     The policy team made enhancements to the Drools PDP to further support S3P Performance.
233     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
234     performance standard and performed 72 hour stability tests.
235
236     * [POLICY-824] - maintain and implement security
237
238     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
239     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
240
241     * [POLICY-840] - Flexible control loop coordination facility.
242
243     Work towards a POC for control loop coordination policies were implemented.
244
245     * [POLICY-841] - Covers the work required to support HPA
246
247     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
248
249     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
250
251     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
252
253     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
254
255     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
256     sonar issues, and checkstyle.
257
258     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
259
260     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
261
262     * [POLICY-1182] - Covers the work to support CCVPN use case
263
264     Policy templates changes were submitted that supported the CCVPN use case.
265
266 **Bug Fixes**
267
268 The following bug fixes have been deployed with this release:
269
270     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
271     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
272     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
273     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
274     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
275     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
276     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
277     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
278
279
280 **Security Notes**
281
282 POLICY code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_.
283
284 Quick Links:
285     - `POLICY project page`_
286     - `Passing Badge information for POLICY`_
287     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
288
289 **Known Issues**
290
291     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
292     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
293
294
295
296 ..      =======================
297 ..      * * *   BEIJING   * * *
298 ..      =======================
299
300 Version: 2.0.0
301 --------------
302
303 :Release Date: 2018-06-07 (Beijing Release)
304
305 **New Features**
306
307 The Beijing release for POLICY delivered the following Epics. For a full list of stories and tasks delivered in the Beijing release, refer to `JiraPolicyBeijing`_.
308
309     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
310         - POLICY-238    policy/drools-applications: clean up maven structure
311         - POLICY-336    Address Technical Debt
312         - POLICY-338    Address JUnit Code Coverage
313         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
314         - POLICY-389    Cleanup Jenkin's CI/CD process's
315         - POLICY-449    Policy API + Console : Common Policy Validation
316         - POLICY-568    Integration with org.onap AAF project
317         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
318
319     * [POLICY-391] - This epic covers the work to support Release Planning activities
320         - POLICY-552    ONAP Licensing Scan - Use Restrictions
321
322     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
323         - POLICY-529    Platform Maturity Performance - Drools PDP
324         - POLICY-567    Platform Maturity Performance - PDP-X
325
326     * [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.
327         - POLICY-488    pap should not add rules to official template provided in drools applications
328
329     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
330         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
331
332     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
333         - POLICY-622    Integrate OOF Policy Model into Policy Platform
334
335     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
336         - POLICY-525    Platform Maturity Stability - Drools PDP
337         - POLICY-526    Platform Maturity Stability - XACML PDP
338
339     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
340         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
341         - POLICY-528    Platform Maturity Resiliency - Drools PDP
342         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
343         - POLICY-585    Platform Maturity Resiliency - XACML PDP
344         - POLICY-586    Platform Maturity Resiliency - Planning
345         - POLICY-681    Regression Test Use Cases
346
347     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
348         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
349
350     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
351         - POLICY-531    Platform Maturity Scalability - XACML PDP
352         - POLICY-532    Platform Maturity Scalability - Drools PDP
353         - POLICY-623    Docker image re-design
354
355     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
356         - POLICY-533    Platform Maturity Manageability L1 - Logging
357         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
358
359     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
360         - POLICY-535    Platform Maturity Usability - User Guide
361         - POLICY-536    Platform Maturity Usability - Deployment Documentation
362         - POLICY-537    Platform Maturity Usability - API Documentation
363
364     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
365
366
367 **Bug Fixes**
368
369 The following bug fixes have been deployed with this release:
370
371     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
372     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
373     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
374     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
375     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
376     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
377     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
378     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
379     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
380     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
381     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
382     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
383     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
384     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
385     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
386
387
388 **Security Notes**
389
390 POLICY code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The POLICY open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_.
391
392 Quick Links:
393     - `POLICY project page`_
394     - `Passing Badge information for POLICY`_
395     - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
396
397 **Known Issues**
398
399 The following known issues will be addressed in a future release:
400
401     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
402     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
403     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
404     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
405     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
406     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
407     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
408     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
409
410
411
412
413 Version: 1.0.2
414 --------------
415
416 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
417
418 **Bug Fixes**
419
420 The following fixes were deployed with the Amsterdam Maintenance Release:
421
422     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
423
424
425 Version: 1.0.1
426 --------------
427
428 :Release Date: 2017-11-16 (Amsterdam Release)
429
430 **New Features**
431
432 The Amsterdam release continued evolving the design driven architecture of and functionality for POLICY.  The following is a list of Epics delivered with the release. For a full list of stories and tasks delivered in the Amsterdam release, refer to `JiraPolicyAmsterdam`_.
433
434     * [POLICY-31] - Stabilization of Seed Code
435         - POLICY-25  Replace any remaining openecomp reference by onap
436         - POLICY-32  JUnit test code coverage
437         - POLICY-66  PDP-D Feature mechanism enhancements
438         - POLICY-67  Rainy Day Decision Policy
439         - POLICY-93  Notification API
440         - POLICY-158  policy/engine: SQL injection Mitigation
441         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
442
443     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
444         - POLICY-40  MSB Integration
445         - POLICY-124  Integration with oparent
446         - POLICY-41  OOM Integration
447         - POLICY-119  PDP-D: noop sinks
448
449     * [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.
450         - POLICY-57  VF-C Actor code development
451         - POLICY-43  Amsterdam Use Case Template
452         - POLICY-173  Deployment of Operational Policies Documentation
453
454     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
455         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
456
457     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
458
459     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
460         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
461         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
462         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
463         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
464
465     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
466
467     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
468         - POLICY-61  vFW Use Case - Runtime
469         - POLICY-62  vDNS Use Case - Runtime
470         - POLICY-59  vCPE Use Case - Runtime
471         - POLICY-60  VOLTE Use Case - Runtime
472         - POLICY-51  Runtime Policy Update Support
473         - POLICY-328  vDNS Use Case - Runtime Testing
474         - POLICY-324  vFW Use Case - Runtime Testing
475         - POLICY-320  VOLTE Use Case - Runtime Testing
476         - POLICY-316  vCPE Use Case - Runtime Testing
477
478     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
479         - POLICY-77  Functional Test case definition for Control Loops
480         - POLICY-387  Deliver the released policy artifacts
481
482
483 **Bug Fixes**
484     - 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`_.
485
486
487 **Known Issues**
488     - 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.
489
490     - For vLBS Use Case, the following steps are required to setup the service instance:
491         -  Create a Service Instance via VID.
492         -  Create a VNF Instance via VID.
493         -  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.
494         -  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.
495         -  Run heatbridge from the Robot VM using ``Vfmodule_`` … as stack name (it is the actual stack name in OpenStack)
496         -  Populate AAI with a dummy VF module for vDNS scaling.
497
498 **Security Issues**
499     - None at this time
500
501 **Other**
502     - None at this time
503
504
505 .. Links to jira release notes
506
507 .. _JiraPolicyDublin: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10464
508 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
509 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
510 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
511
512 .. Links to Project related pages
513
514 .. _POLICY project page: https://wiki.onap.org/display/DW/Policy+Framework+Project
515 .. _Passing Badge information for POLICY: https://bestpractices.coreinfrastructure.org/en/projects/1614
516
517
518 .. note
519 ..      CHANGE  HISTORY
520 ..      05/16/2019 - Updated for Dublin Release.
521 ..      01/17/2019 - Updated for Casablanca Maintenance Release.
522 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
523 ..              Changed version number to use ONAP versions.
524 ..      10/08/2018 - Initial document for Casablanca release.
525 ..              Per Jorge, POLICY-785 did not get done in Casablanca (removed).
526 ..      05/29/2018 - Information for Beijing release.
527 ..      03/22/2018 - Initial document for Beijing release.
528 ..      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)
529 ..              Also, Set up initial information for Beijing.
530 ..              Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
531
532
533 End of Release Notes
534
535 .. How to notes for SS
536 ..      For initial document: list epic and user stories for each, list user stories with no epics.
537 ..      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.
538 ..      For Known issues, list bugs that are slotted for a future release.