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