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