1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
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.
16 .. ==========================
17 .. * * * CASABLANCA * * *
18 .. ==========================
23 :Release Date: 2018-11-15 (Casablanca Release)
27 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).
29 * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
30 - POLICY-723 Analyze and design the Policy SDC Distribution Application
31 - POLICY-922 Create application framework for Policy Service SDC Distribution
32 - POLICY-923 Create code to generate docker images for Policy SDC Service Distribution application
33 - POLICY-924 Create CSIT test framework for Policy SDC Service Distribution application
34 - POLICY-925 Create K8S Helm Charts for deployment via OOM project
35 - POLICY-926 Create code infrastructure for automatic policy forwarding
36 - POLICY-956 Implement IConfiguration interface to initiate Distribution Client
37 - POLICY-974 Implement INotificationCallback interface
38 - POLICY-1094 Refactor reception handler configuration parameter handling
40 * [POLICY-715] - This epic covers work to harden the policy platform
41 - POLICY-955 Incorporate changes to amsterdam rules template into casablanca rules template
42 - POLICY-1128 Fix new sonar issues
44 * [POLICY-718] - This epic covers the work to perform release planning activities.
45 - POLICY-875 Update Beijing Branch and master branch for Casablanca versions
46 - POLICY-1040 Copy and clean up Beijing wiki's for Casablanca
48 * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
49 - POLICY-724 Gather requirements and design high-level software architecture
50 - POLICY-1056 Create Policy API Infrastructure
52 * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
53 - POLICY-874 Spike: Interface Stubbing for Architectual Enhancements
55 * [POLICY-772] - Enhance casablanca testing abilities between various environments
57 * [POLICY-803] - All the new repositories must be initialized and setup to work under policy/parent.
58 - POLICY-804 Setup policy/parent
59 - POLICY-805 Setup policy/models
60 - POLICY-806 Setup policy/api
61 - POLICY-807 Setup policy/apex-pdp
62 - POLICY-808 Setup ci-management verify/merge jobs
63 - POLICY-845 Setup policy/core
64 - POLICY-846 Setup policy/xacml-pdp
65 - POLICY-847 Setup policy/gui
66 - POLICY-848 Setup policy/pap
67 - POLICY-849 Setup policy/pdp
68 - POLICY-871 Setup policy/distribution
70 * [POLICY-809] - Maintain and implement performance
71 - POLICY-836 Performance PSSD (Policy SDC Service Distribution)
72 - POLICY-887 Performance PDP-X - Policy Decisions
73 - POLICY-888 Performance PDP-D - Policy Decision/Enforcement
75 * [POLICY-814] - 72 hour stability testing (component and platform)
76 - POLICY-815 Stability PDP-X
77 - POLICY-817 Stability PDP-A
79 * [POLICY-824] - maintain and implement security
80 - POLICY-781 PE Support for AAF Root Certificate in HTTPS communication.
81 - POLICY-905 Fix apex-engine License and Security issues
82 - POLICY-913 policy/engine CADI (AAF) Integration
83 - POLICY-914 policy/drools-pdp CADI (AAF) Integration
84 - POLICY-918 Policy Portal GUI - upgrade to latest Portal SDK to resolve security issues
85 - POLICY-942 BRMSGW: HTTPS support for DMaaP/UEB interfaces
86 - POLICY-946 Investigate what integration of CADI (AAF) integration into the ONAP Policy Platform components really means
87 - POLICY-982 Update security issues since portal SDK was upgraded
88 - POLICY-1030 Revisit CLM reports due to new software upgrade
89 - POLICY-1059 Address the security issues with Severe (and above) Level 4-6
91 * [POLICY-839] - Maintain and implement usability
93 * [POLICY-840] - Flexible control loop coordination facility.
94 - POLICY-951 Code placement and development procedures
95 - POLICY-952 Analyze and design the control loop coordination facility
96 - POLICY-953 Configure whether a given control loop will be regulated by flexible control loop coordination.
97 - POLICY-975 Storage of abatement (and other) events in historical database
98 - POLICY-1109 Add demo code to template.demo
100 * [POLICY-841] - Covers the work required to support HPA
101 - POLICY-927 Develop the code that translates HPA requirements into OOF policies
102 - POLICY-989 HPA Use Case Modeling work to support optimization policies
104 * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
105 - POLICY-962 Change SO Scale Out REST API call to new REST API version that support config parameters
106 - POLICY-963 Understand and Scope the Guard Policies for Scale Out
107 - POLICY-964 Modify drools-applications template to check is PROV_STATUS=Active before performing a Scale Out
108 - POLICY-968 Enforce guard policy for min/max instances of a VNF
109 - POLICY-1010 Enforce guard policy for waiting a period of time between Scale Outs
110 - POLICY-1011 Modify drools-applications template to make A&AI query to count number of instances of a VNF
111 - POLICY-1037 Use A&AI query for getting number of module instances to construct new module instance name
112 - POLICY-1038 Create new min/max guard policy template in policy engine
113 - POLICY-1039 Ensure Policy Integration Test wiki is up-to-date for new Scale Out APIs
115 * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
116 - POLICY-855 Verify APEX-PDP setup in ONAP
117 - POLICY-856 Bring in the model code for APEX-PDP into ONAP
118 - POLICY-857 Bring in the context code for APEX-PDP into ONAP
119 - POLICY-858 Bring in the core code for APEX-PDP into ONAP
120 - POLICY-859 Bring in the server service code for APEX-PDP into ONAP
121 - POLICY-860 Bring in the authoring code for APEX-PDP into ONAP
122 - POLICY-861 Bring in the domain example code for APEX-PDP into ONAP
123 - POLICY-862 Bring in the plugin code for APEX-PDP into ONAP
124 - POLICY-863 Bring in the application code for APEX-PDP into ONAP
125 - POLICY-864 Bring in the client code for APEX-PDP into ONAP
126 - POLICY-865 Set up Integration Tests for APEX in ONAP
127 - POLICY-866 Set up ONAP Policy Framework compliant Docker build for APEX-PDP
128 - POLICY-867 Bring in APEX-PDP documents
129 - POLICY-954 APEX: Missing items and configuration problems
130 - POLICY-1099 Create CSIT test for policy APEX PDP
132 * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
133 * [POLICY-904] - This epic covers the features AT&T is submitting
134 - POLICY-900 TOSCA model enhancements
135 - POLICY-901 Guard policy UI enhancements
136 - POLICY-902 XACML platform enhancements
137 - POLICY-983 getConfig naming policy implementation
138 - POLICY-1042 Policy Dashboard Enhancment
140 * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
141 - POLICY-1079 Add support for VF Module Delete recipe
142 - POLICY-1086 Configuration/policies for OOF PCI use case
143 - POLICY-1089 Handle recommendation for PCI updates received from PCI-Handler MS
145 * [POLICY-1182] - Covers the work to support CCVPN use case
146 - POLICY-1183 Create SDNC actor code
150 The following bug fixes have been deployed with this release:
152 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
153 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
154 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
155 * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
156 * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
157 * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
158 * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
159 * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
164 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=36964976>`_.
167 - `POLICY project page <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_
169 - `Passing Badge information for POLICY <https://bestpractices.coreinfrastructure.org/en/projects/1614>`_
171 - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=36964976>`_
175 * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
180 .. =======================
181 .. * * * BEIJING * * *
182 .. =======================
187 :Release Date: 2018-06-07 (Beijing Release)
191 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`_.
193 * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
194 - POLICY-238 policy/drools-applications: clean up maven structure
195 - POLICY-336 Address Technical Debt
196 - POLICY-338 Address JUnit Code Coverage
197 - POLICY-377 Policy Create API should validate input matches DCAE microservice template
198 - POLICY-389 Cleanup Jenkin's CI/CD process's
199 - POLICY-449 Policy API + Console : Common Policy Validation
200 - POLICY-568 Integration with org.onap AAF project
201 - POLICY-610 Support vDNS scale out for multiple times in Beijing release
203 * [POLICY-391] - This epic covers the work to support Release Planning activities
204 - POLICY-552 ONAP Licensing Scan - Use Restrictions
206 * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
207 - POLICY-529 Platform Maturity Performance - Drools PDP
208 - POLICY-567 Platform Maturity Performance - PDP-X
210 * [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.
211 - POLICY-488 pap should not add rules to official template provided in drools applications
213 * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
214 - POLICY-434 need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
216 * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
217 - POLICY-622 Integrate OOF Policy Model into Policy Platform
219 * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
220 - POLICY-525 Platform Maturity Stability - Drools PDP
221 - POLICY-526 Platform Maturity Stability - XACML PDP
223 * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
224 - POLICY-527 Platform Maturity Resiliency - Policy Engine GUI and PAP
225 - POLICY-528 Platform Maturity Resiliency - Drools PDP
226 - POLICY-569 Platform Maturity Resiliency - BRMS Gateway
227 - POLICY-585 Platform Maturity Resiliency - XACML PDP
228 - POLICY-586 Platform Maturity Resiliency - Planning
229 - POLICY-681 Regression Test Use Cases
231 * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
232 - POLICY-523 Platform Maturity Security - CII Badging - Project Website
234 * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
235 - POLICY-531 Platform Maturity Scalability - XACML PDP
236 - POLICY-532 Platform Maturity Scalability - Drools PDP
237 - POLICY-623 Docker image re-design
239 * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
240 - POLICY-533 Platform Maturity Manageability L1 - Logging
241 - POLICY-534 Platform Maturity Manageability - Instantiation < 1 hour
243 * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
244 - POLICY-535 Platform Maturity Usability - User Guide
245 - POLICY-536 Platform Maturity Usability - Deployment Documentation
246 - POLICY-537 Platform Maturity Usability - API Documentation
248 * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
253 The following bug fixes have been deployed with this release:
255 * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
256 * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
257 * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
258 * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
259 * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
260 * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
261 * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
262 * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
263 * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
264 * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
265 * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
266 * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
267 * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
268 * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
269 * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
274 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>`_.
277 - `POLICY project page <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_
279 - `Passing Badge information for POLICY <https://bestpractices.coreinfrastructure.org/en/projects/1614>`_
281 - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
285 The following known issues will be addressed in a future release:
287 * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
288 * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
289 * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
290 * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
291 * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
292 * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
293 * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
294 * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
302 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
306 The following fixes were deployed with the Amsterdam Maintenance Release:
308 * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
314 :Release Date: 2017-11-16 (Amsterdam Release)
318 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`_.
320 * [POLICY-31] - Stabilization of Seed Code
321 - POLICY-25 Replace any remaining openecomp reference by onap
322 - POLICY-32 JUnit test code coverage
323 - POLICY-66 PDP-D Feature mechanism enhancements
324 - POLICY-67 Rainy Day Decision Policy
325 - POLICY-93 Notification API
326 - POLICY-158 policy/engine: SQL injection Mitigation
327 - POLICY-269 Policy API Support for Rainy Day Decision Policy and Dictionaries
329 * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
330 - POLICY-40 MSB Integration
331 - POLICY-124 Integration with oparent
332 - POLICY-41 OOM Integration
333 - POLICY-119 PDP-D: noop sinks
335 * [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.
336 - POLICY-57 VF-C Actor code development
337 - POLICY-43 Amsterdam Use Case Template
338 - POLICY-173 Deployment of Operational Policies Documentation
340 * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
341 - POLICY-68 TOSCA Parsing for nested objects for Microservice Policies
343 * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
345 * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
346 - POLICY-64 CLAMP Configuration and Operation Policies for vFW Use Case
347 - POLICY-65 CLAMP Configuration and Operation Policies for vDNS Use Case
348 - POLICY-48 CLAMP Configuration and Operation Policies for vCPE Use Case
349 - POLICY-63 CLAMP Configuration and Operation Policies for VOLTE Use Case
351 * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
353 * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
354 - POLICY-61 vFW Use Case - Runtime
355 - POLICY-62 vDNS Use Case - Runtime
356 - POLICY-59 vCPE Use Case - Runtime
357 - POLICY-60 VOLTE Use Case - Runtime
358 - POLICY-51 Runtime Policy Update Support
359 - POLICY-328 vDNS Use Case - Runtime Testing
360 - POLICY-324 vFW Use Case - Runtime Testing
361 - POLICY-320 VOLTE Use Case - Runtime Testing
362 - POLICY-316 vCPE Use Case - Runtime Testing
364 * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
365 - POLICY-77 Functional Test case definition for Control Loops
366 - POLICY-387 Deliver the released policy artifacts
370 - 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`_.
374 - 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.
376 - For vLBS Use Case, the following steps are required to setup the service instance:
377 - Create a Service Instance via VID.
378 - Create a VNF Instance via VID.
379 - 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.
380 - 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.
381 - Run heatbridge from the Robot VM using ``Vfmodule_`` … as stack name (it is the actual stack name in OpenStack)
382 - Populate AAI with a dummy VF module for vDNS scaling.
391 .. Links to jira release notes
393 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
394 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
395 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
400 .. 11/19/2018 - Updated for Casablanca. Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
401 .. Changed version number to use ONAP versions.
402 .. 10/08/2018 - Initial document for Casablanca release.
403 .. Per Jorge, POLICY-785 did not get done in Casablanca (removed).
404 .. 05/29/2018 - Information for Beijing release.
405 .. 03/22/2018 - Initial document for Beijing release.
406 .. 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)
407 .. Also, Set up initial information for Beijing.
408 .. Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
413 .. How to notes for SS
414 .. For initial document: list epic and user stories for each, list user stories with no epics.
415 .. For Bugs section, list bugs that are not tied to an epic. Remove all items with "Won't Do" resolution.
416 .. For Known issues, list bugs that are slotted for a future release.
Code Review / policy / engine.git / blob