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