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 Version: 1.2.2
  17 --------------
  18
  19 :Release Date: 2018-05-24 (Beijing Release)
  20
  21 **New Features**
  22
  23 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`_.
  24
  25     * [POLICY-390] - This epic covers the work to harden the Policy platform software base (incl 50% JUnit coverage)
  26         - POLICY-238    policy/drools-applications: clean up maven structure
  27         - POLICY-336    Address Technical Debt
  28         - POLICY-338    Address JUnit Code Coverage
  29         - POLICY-377    Policy Create API should validate input matches DCAE microservice template
  30         - POLICY-389    Cleanup Jenkin's CI/CD process's
  31         - POLICY-449    Policy API + Console : Common Policy Validation
  32         - POLICY-568    Integration with org.onap AAF project
  33         - POLICY-610    Support vDNS scale out for multiple times in Beijing release
  34
  35     * [POLICY-391] - This epic covers the work to support Release Planning activities
  36         - POLICY-552    ONAP Licensing Scan - Use Restrictions
  37
  38     * [POLICY-392] - Platform Maturity Requirements - Performance Level 1
  39         - POLICY-529    Platform Maturity Performance - Drools PDP
  40         - POLICY-567    Platform Maturity Performance - PDP-X
  41
  42     * [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.
  43         - POLICY-488    pap should not add rules to official template provided in drools applications
  44
  45     * [POLICY-398] - This epic covers the body of work involved in supporting policy that is platform specific.
  46         - POLICY-434    need PDP /getConfig to return an indicator of where to find the config data - in config.content versus config field
  47
  48     * [POLICY-399] - This epic covers the work required to policy enable Hardware Platform Enablement
  49         - POLICY-622    Integrate OOF Policy Model into Policy Platform
  50
  51     * [POLICY-512] - This epic covers the work to support Platform Maturity Requirements - Stability Level 1
  52         - POLICY-525    Platform Maturity Stability - Drools PDP
  53         - POLICY-526    Platform Maturity Stability - XACML PDP
  54
  55     * [POLICY-513] - Platform Maturity Requirements - Resiliency Level 2
  56         - POLICY-527    Platform Maturity Resiliency - Policy Engine GUI and PAP
  57         - POLICY-528    Platform Maturity Resiliency - Drools PDP
  58         - POLICY-569    Platform Maturity Resiliency - BRMS Gateway
  59         - POLICY-585    Platform Maturity Resiliency - XACML PDP
  60         - POLICY-586    Platform Maturity Resiliency - Planning
  61         - POLICY-681    Regression Test Use Cases
  62
  63     * [POLICY-514] - This epic covers the work to support Platform Maturity Requirements - Security Level 1
  64         - POLICY-523    Platform Maturity Security - CII Badging - Project Website
  65
  66     * [POLICY-515] - This epic covers the work to support Platform Maturity Requirements - Escalability Level 1
  67         - POLICY-531    Platform Maturity Scalability - XACML PDP
  68         - POLICY-532    Platform Maturity Scalability - Drools PDP
  69         - POLICY-623    Docker image re-design
  70
  71     * [POLICY-516] - This epic covers the work to support Platform Maturity Requirements - Manageability Level 1
  72         - POLICY-533    Platform Maturity Manageability L1 - Logging
  73         - POLICY-534    Platform Maturity Manageability - Instantiation < 1 hour
  74
  75     * [POLICY-517] - This epic covers the work to support Platform Maturity Requirements - Usability Level 1
  76         - POLICY-535    Platform Maturity Usability - User Guide
  77         - POLICY-536    Platform Maturity Usability - Deployment Documentation
  78         - POLICY-537    Platform Maturity Usability - API Documentation
  79
  80     * [POLICY-546] - R2 Beijing - Various enhancements requested by clients to the way we handle TOSCA models.
  81
  82
  83 **Bug Fixes**
  84
  85     * `[POLICY-484] <https://jira.onap.org/browse/POLICY-484>`_ - Extend election handler run window and clean up error messages
  86     * `[POLICY-494] <https://jira.onap.org/browse/POLICY-494>`_ - POLICY EELF Audit.log not in ECOMP Standards Compliance
  87     * `[POLICY-501] <https://jira.onap.org/browse/POLICY-501>`_ - Fix issues blocking election handler and add directed interface for opstate
  88     * `[POLICY-509] <https://jira.onap.org/browse/POLICY-509>`_ - Add IntelliJ file to .gitingore
  89     * `[POLICY-510] <https://jira.onap.org/browse/POLICY-510>`_ - Do not enforce hostname validation
  90     * `[POLICY-518] <https://jira.onap.org/browse/POLICY-518>`_ - StateManagement creation of EntityManagers.
  91     * `[POLICY-519] <https://jira.onap.org/browse/POLICY-519>`_ - Correctly initialize the value of allSeemsWell in DroolsPdpsElectionHandler
  92     * `[POLICY-629] <https://jira.onap.org/browse/POLICY-629>`_ - Fixed a bug on editor screen
  93     * `[POLICY-684] <https://jira.onap.org/browse/POLICY-684>`_ - Fix regex for brmsgw dependency handling
  94     * `[POLICY-707] <https://jira.onap.org/browse/POLICY-707>`_ - ONAO-PAP-REST unit tests fail on first build on clean checkout
  95     * `[POLICY-717] <https://jira.onap.org/browse/POLICY-717>`_ - Fix a bug in checking required fields if the object has include function
  96     * `[POLICY-734] <https://jira.onap.org/browse/POLICY-734>`_ - Fix Fortify Header Manipulation Issue
  97     * `[POLICY-743] <https://jira.onap.org/browse/POLICY-743>`_ - Fixed data name since its name was changed on server side
  98     * `[POLICY-753] <https://jira.onap.org/browse/POLICY-753>`_ - Policy Health Check failed with multi-node cluster
  99     * `[POLICY-765] <https://jira.onap.org/browse/POLICY-765>`_ - junit test for guard fails intermittently
 100
 101
 102 **Security Issues**
 103
 104    * Refer to the `Policy R2 Beijing Security/Vulnerability Threat <https://wiki.onap.org/pages/viewpage.action?pageId=25437092>`_ page for security related issues.
 105
 106 **Known Issues**
 107
 108     * `[POLICY-522] <https://jira.onap.org/browse/POLICY-522>`_ - PAP REST APIs undesired HTTP response body for 500 responses
 109     * `[POLICY-608] <https://jira.onap.org/browse/POLICY-608>`_ - xacml components : remove hardcoded secret key from source code
 110     * `[POLICY-764] <https://jira.onap.org/browse/POLICY-764>`_ - Policy Engine PIP Configuration JUnit Test fails intermittently
 111     * `[POLICY-776] <https://jira.onap.org/browse/POLICY-776>`_ - OOF Policy TOSCA models are not correctly rendered
 112     * `[POLICY-799] <https://jira.onap.org/browse/POLICY-799>`_ - Policy API Validation Does Not Validate Required Parent Attributes in the Model
 113     * `[POLICY-801] <https://jira.onap.org/browse/POLICY-801>`_ - fields mismatch for OOF flavorFeatures between implementation and wiki
 114
 115
 116
 117 Version: 1.1.3
 118 --------------
 119
 120 :Release Date: 2018-01-18 (Amsterdam Maintenance Release)
 121
 122 **Bug Fixes**
 123
 124 The following fixes were deployed with the Amsterdam Maintenance Release:
 125
 126     * `[POLICY-486] <https://jira.onap.org/browse/POLICY-486>`_ - pdp-x api pushPolicy fails to push latest version
 127
 128
 129 Version: 1.1.1
 130 --------------
 131
 132 :Release Date: 2017-11-16 (Amsterdam Release)
 133
 134 **New Features**
 135
 136 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`_.
 137
 138     * [POLICY-31] - Stabilization of Seed Code
 139         - POLICY-25  Replace any remaining openecomp reference by onap
 140         - POLICY-32  JUnit test code coverage
 141         - POLICY-66  PDP-D Feature mechanism enhancements
 142         - POLICY-67  Rainy Day Decision Policy
 143         - POLICY-93  Notification API
 144         - POLICY-158  policy/engine: SQL injection Mitigation
 145         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries
 146
 147     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
 148         - POLICY-40  MSB Integration
 149         - POLICY-124  Integration with oparent
 150         - POLICY-41  OOM Integration
 151         - POLICY-119  PDP-D: noop sinks
 152
 153     * [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.
 154         - POLICY-57  VF-C Actor code development
 155         - POLICY-43  Amsterdam Use Case Template
 156         - POLICY-173  Deployment of Operational Policies Documentation
 157
 158     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
 159         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies
 160
 161     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
 162
 163     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
 164         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case
 165         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case
 166         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case
 167         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case
 168
 169     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
 170
 171     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
 172         - POLICY-61  vFW Use Case - Runtime
 173         - POLICY-62  vDNS Use Case - Runtime
 174         - POLICY-59  vCPE Use Case - Runtime
 175         - POLICY-60  VOLTE Use Case - Runtime
 176         - POLICY-51  Runtime Policy Update Support
 177         - POLICY-328  vDNS Use Case - Runtime Testing
 178         - POLICY-324  vFW Use Case - Runtime Testing
 179         - POLICY-320  VOLTE Use Case - Runtime Testing
 180         - POLICY-316  vCPE Use Case - Runtime Testing
 181
 182     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
 183         - POLICY-77  Functional Test case definition for Control Loops
 184         - POLICY-387  Deliver the released policy artifacts
 185
 186
 187 **Bug Fixes**
 188     - 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`_.
 189
 190
 191 **Known Issues**
 192     - 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.
 193
 194     - For vLBS Use Case, the following steps are required to setup the service instance:
 195         -  Create a Service Instance via VID.
 196         -  Create a VNF Instance via VID.
 197         -  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.
 198         -  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.
 199         -  Run heatbridge from the Robot VM using ``Vfmodule_`` … as stack name (it is the actual stack name in OpenStack)
 200         -  Populate AAI with a dummy VF module for vDNS scaling.
 201
 202 **Security Issues**
 203     - None at this time
 204
 205 **Other**
 206     - None at this time
 207
 208
 209 .. Links to jira release notes
 210
 211 .. _JiraPolicyBeijing: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10349
 212 .. _JiraPolicyAmsterdam: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
 213
 214
 215 .. note
 216 ..      CHANGE  HISTORY
 217 ..      03/22/2018 - Initial document for Beijing release.
 218 ..              For initial document: list epic and user stories for each, list user stories with no epics.
 219 ..              For Bugs section, list bugs that are not tied to an epic.  Remove all items with "Won't Do" resolution.
 220 ..      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)
 221 ..              Also, Set up initial information for Beijing.
 222 ..      05/21/2018 - Information for Beijing release.
 223 ..              Excluded POLICY-454 from bug list since it doesn't apply to Beijing per Jorge.
 224
 225
 226 End of Release Notes
 227
 228
 229