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