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 ..      * * *   CASABLANCA   * * *
  18 ..      ==========================
  19
  20 Version: 3.0.0
  21 --------------
  22
  23 :Release Date: 2018-11-30 (Casablanca Release)
  24
  25 **New Features**
  26
  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).
  28
  29     * [POLICY-701] - This epic covers the work to integrate Policy into the SDC Service Distribution
  30
  31     The policy team introduced a new application into the framework that provides integration of the Service Distribution Notifications from SDC to Policy.
  32
  33     * [POLICY-719] - This epic covers the work to build the Policy Lifecycle API
  34     * [POLICY-726] - This epic covers the work to distribute policy from the PAP to the PDPs into the ONAP platform
  35     * [POLICY-876] - This epics covers the work to re-build how the PAP organizes the PDP's into groups.
  36
  37     The policy team did some forward looking spike work towards re-building the Software Architecture.
  38
  39     * [POLICY-809] - Maintain and implement performance
  40     * [POLICY-814] - 72 hour stability testing (component and platform)
  41
  42     The policy team made enhancements to the Drools PDP to further support S3P Performance.
  43     For the new Policy SDC Distribution application and the newly ingested Apex PDP the team established S3P
  44     performance standard and performed 72 hour stability tests.
  45
  46     * [POLICY-824] - maintain and implement security
  47
  48     The policy team established AAF Root Certificate for HTTPS communication and CADI/AAF integration into the
  49     MVP applications. In addition, many java dependencies were upgraded to clear CLM security issues.
  50
  51     * [POLICY-840] - Flexible control loop coordination facility.
  52
  53     Work towards a POC for control loop coordination policies were implemented.
  54
  55     * [POLICY-841] - Covers the work required to support HPA
  56
  57     Enhancements were made to support the HPA use case through the use of the new Policy SDC Service Distribution application.
  58
  59     * [POLICY-842] - This epic covers the work to support the Auto Scale Out functional requirements
  60
  61     Enhancements were made to support Scale Out Use Case to enforce new guard policies and updated SO and A&AI APIs.
  62
  63     * [POLICY-851] - This epic covers the work to bring in the Apex PDP code
  64
  65     A new Apex PDP engine was ingested into the platform and work was done to ensure code cleared CLM security issues,
  66     sonar issues, and checkstyle.
  67
  68     * [POLICY-1081] - This epic covers the contribution for the 5G OOF PCI Optimization use case.
  69
  70     Policy templates changes were submitted that supported the 5G OOF PCI optimization use case.
  71
  72     * [POLICY-1182] - Covers the work to support CCVPN use case
  73
  74     Policy templates changes were submitted that supported the CCVPN use case.
  75
  76 **Bug Fixes**
  77
  78 The following bug fixes have been deployed with this release:
  79
  80     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
  81     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_ - Control Loop Drools Rules should not have exceptions as well as die upon an exception
  82     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_ - investigate potential race conditions during rules version upgrades during call loads
  83     * `[POLICY-878] <https://jira.onap.org/browse/POLICY-878>`_ - pdp-d: feature-pooling disables policy-controllers preventing processing of onset events
  84     * `[POLICY-909] <https://jira.onap.org/browse/POLICY-909>`_ - get_ZoneDictionaryDataByName class type error
  85     * `[POLICY-920] <https://jira.onap.org/browse/POLICY-920>`_ - Hard-coded path in junit test
  86     * `[POLICY-921] <https://jira.onap.org/browse/POLICY-921>`_ - XACML Junit test cannot find property file
  87     * `[POLICY-1083] <https://jira.onap.org/browse/POLICY-1083>`_ - Mismatch in action cases between Policy and APPC
  88
  89
  90 **Security Notes**
  91
  92 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>`_.
  93
  94 Quick Links:
  95     - `POLICY project page <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_
  96
  97     - `Passing Badge information for POLICY <https://bestpractices.coreinfrastructure.org/en/projects/1614>`_
  98
  99     - `Project Vulnerability Review Table for POLICY (Casablanca Release) <https://wiki.onap.org/pages/viewpage.action?pageId=45300864>`_
 100
 101 **Known Issues**
 102
 103     * `[POLICY-1277] <https://jira.onap.org/browse/POLICY-1277>`_ - policy config takes too long time to become retrievable in PDP
 104     * `[POLICY-1282] <https://jira.onap.org/browse/POLICY-1282>`_ - Policy format with some problems
 105
 106
 107
 108 ..      =======================
 109 ..      * * *   BEIJING   * * *
 110 ..      =======================
 111
 112 Version: 2.0.0
 113 --------------
 114
 115 :Release Date: 2018-06-07 (Beijing Release)
 116
 117 **New Features**
 118
 119 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`_.
 120
 121     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
 122         - POLICY-238    policy/drools-applications: clean up maven structure
 123         - POLICY-336    Address Technical Debt
 124         - POLICY-338    Address JUnit Code Coverage
 125         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
 126         - POLICY-389    Cleanup Jenkin's CI/CD process's
 127         - POLICY-449    Policy API + Console : Common Policy Validation
 128         - POLICY-568    Integration with org.onap AAF project
 129         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
 130
 131     * [POLICY-391] - This epic covers the work to support Release Planning activities
 132         - POLICY-552    ONAP Licensing Scan - Use Restrictions
 133
 134     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
 135         - POLICY-529    Platform Maturity Performance - Drools PDP
 136         - POLICY-567    Platform Maturity Performance - PDP-X
 137
 138     * [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.
 139         - POLICY-488    pap should not add rules to official template provided in drools applications
 140
 141     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
 142         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
 143
 144     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
 145         - POLICY-622    Integrate OOF Policy Model into Policy Platform
 146
 147     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
 148         - POLICY-525    Platform Maturity Stability - Drools PDP
 149         - POLICY-526    Platform Maturity Stability - XACML PDP
 150
 151     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
 152         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
 153         - POLICY-528    Platform Maturity Resiliency - Drools PDP
 154         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
 155         - POLICY-585    Platform Maturity Resiliency - XACML PDP
 156         - POLICY-586    Platform Maturity Resiliency - Planning
 157         - POLICY-681    Regression Test Use Cases
 158
 159     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
 160         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
 161
 162     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
 163         - POLICY-531    Platform Maturity Scalability - XACML PDP
 164         - POLICY-532    Platform Maturity Scalability - Drools PDP
 165         - POLICY-623    Docker image re-design
 166
 167     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
 168         - POLICY-533    Platform Maturity Manageability L1 - Logging
 169         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
 170
 171     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
 172         - POLICY-535    Platform Maturity Usability - User Guide
 173         - POLICY-536    Platform Maturity Usability - Deployment Documentation
 174         - POLICY-537    Platform Maturity Usability - API Documentation
 175
 176     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
 177
 178
 179 **Bug Fixes**
 180
 181 The following bug fixes have been deployed with this release:
 182
 183     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
 184     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
 185     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
 186     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
 187     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
 188     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
 189     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
 190     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
 191     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
 192     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
 193     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
 194     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
 195     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
 196     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
 197     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
 198
 199
 200 **Security Notes**
 201
 202 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>`_.
 203
 204 Quick Links:
 205         - `POLICY project page <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_
 206
 207         - `Passing Badge information for POLICY <https://bestpractices.coreinfrastructure.org/en/projects/1614>`_
 208
 209         - `Project Vulnerability Review Table for POLICY <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_
 210
 211 **Known Issues**
 212
 213 The following known issues will be addressed in a future release:
 214
 215     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
 216     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
 217     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
 218     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
 219     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
 220     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
 221     * `[POLICY-869] <https://jira.onap.org/browse/POLICY-869>`_  - Control Loop Drools Rules should not have exceptions as well as die upon an exception
 222     * `[POLICY-872] <https://jira.onap.org/browse/POLICY-872>`_  - investigate potential race conditions during rules version upgrades during call loads
 223
 224
 225
 226
 227 Version: 1.0.2
 228 --------------
 229
 230 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
 231
 232 **Bug Fixes**
 233
 234 The following fixes were deployed with the Amsterdam Maintenance Release:
 235
 236     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
 237
 238
 239 Version: 1.0.1
 240 --------------
 241
 242 :Release Date: 2017-11-16 (Amsterdam Release)
 243
 244 **New Features**
 245
 246 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`_.
 247
 248     * [POLICY-31] - Stabilization of Seed Code
 249         - POLICY-25  Replace any remaining openecomp reference by onap
 250         - POLICY-32  JUnit test code coverage
 251         - POLICY-66  PDP-D Feature mechanism enhancements
 252         - POLICY-67  Rainy Day Decision Policy
 253         - POLICY-93  Notification API
 254         - POLICY-158  policy/engine: SQL injection Mitigation
 255         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
 256
 257     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
 258         - POLICY-40  MSB Integration
 259         - POLICY-124  Integration with oparent
 260         - POLICY-41  OOM Integration
 261         - POLICY-119  PDP-D: noop sinks
 262
 263     * [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.
 264         - POLICY-57  VF-C Actor code development
 265         - POLICY-43  Amsterdam Use Case Template
 266         - POLICY-173  Deployment of Operational Policies Documentation
 267
 268     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
 269         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
 270
 271     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
 272
 273     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
 274         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
 275         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
 276         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
 277         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
 278
 279     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
 280
 281     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
 282         - POLICY-61  vFW Use Case - Runtime
 283         - POLICY-62  vDNS Use Case - Runtime
 284         - POLICY-59  vCPE Use Case - Runtime
 285         - POLICY-60  VOLTE Use Case - Runtime
 286         - POLICY-51  Runtime Policy Update Support
 287         - POLICY-328  vDNS Use Case - Runtime Testing
 288         - POLICY-324  vFW Use Case - Runtime Testing
 289         - POLICY-320  VOLTE Use Case - Runtime Testing
 290         - POLICY-316  vCPE Use Case - Runtime Testing
 291
 292     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
 293         - POLICY-77  Functional Test case definition for Control Loops
 294         - POLICY-387  Deliver the released policy artifacts
 295
 296
 297 **Bug Fixes**
 298     - 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`_.
 299
 300
 301 **Known Issues**
 302     - 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.
 303
 304     - For vLBS Use Case, the following steps are required to setup the service instance:
 305         -  Create a Service Instance via VID.
 306         -  Create a VNF Instance via VID.
 307         -  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.
 308         -  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.
 309         -  Run heatbridge from the Robot VM using ``Vfmodule_`` … as stack name (it is the actual stack name in OpenStack)
 310         -  Populate AAI with a dummy VF module for vDNS scaling.
 311
 312 **Security Issues**
 313     - None at this time
 314
 315 **Other**
 316     - None at this time
 317
 318
 319 .. Links to jira release notes
 320
 321 .. _JiraPolicyCasablanca: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10446
 322 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
 323 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
 324
 325
 326 .. note
 327 ..      CHANGE  HISTORY
 328 ..      11/19/2018 - Updated for Casablanca.  Also, fixed bugs is a list of bugs where the "Affected Version" is Beijing.
 329 ..              Changed version number to use ONAP versions.
 330 ..      10/08/2018 - Initial document for Casablanca release.
 331 ..              Per Jorge, POLICY-785 did not get done in Casablanca (removed).
 332 ..      05/29/2018 - Information for Beijing release.
 333 ..      03/22/2018 - Initial document for Beijing release.
 334 ..      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)
 335 ..              Also, Set up initial information for Beijing.
 336 ..              Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
 337
 338
 339 End of Release Notes
 340
 341 .. How to notes for SS
 342 ..      For initial document: list epic and user stories for each, list user stories with no epics.
 343 ..      For Bugs section, list bugs that are not tied to an epic.  Remove all items with "Won't Do" resolution.
 344 ..      For Known issues, list bugs that are slotted for a future release.
 345
 346