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