Updated release notes
[policy/engine.git] / 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 Version: 1.2.0
16 --------------
17
18 :Release Date: 2017-11-16 (Amsterdam Release)
19
20 **New Features**
21
22 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 `JiraPolicyReleaseNotes`_.
23
24     * [POLICY-31] - Stabilization of Seed Code
25         - POLICY-25  Replace any remaining openecomp reference by onap
26         - POLICY-32  JUnit test code coverage
27         - POLICY-66  PDP-D Feature mechanism enhancements
28         - POLICY-67  Rainy Day Decision Policy
29         - POLICY-93  Notification API
30         - POLICY-158  policy/engine: SQL injection Mitigation
31         - POLICY-269  Policy API Support for Rainy Day Decision Policy and Dictionaries  
32
33     * [POLICY-33] - This epic covers the body of work involved in deploying the Policy Platform components
34         - POLICY-40  MSB Integration  
35         - POLICY-124  Integration with oparent  
36         - POLICY-41  OOM Integration  
37         - POLICY-119  PDP-D: noop sinks  
38
39     * [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.
40         - POLICY-57  VF-C Actor code development  
41         - POLICY-43  Amsterdam Use Case Template  
42         - POLICY-173  Deployment of Operational Policies Documentation  
43
44     * [POLICY-35] - This epic covers the body of work involved in supporting policy that is platform specific.
45         - POLICY-68  TOSCA Parsing for nested objects for Microservice Policies  
46
47     * [POLICY-36] - This epic covers the work required to capture policy during VNF on-boarding.
48
49     * [POLICY-37] - This epic covers the work required to capture, update, extend Policy(s) during Service Design.
50         - POLICY-64  CLAMP Configuration and Operation Policies for vFW Use Case  
51         - POLICY-65  CLAMP Configuration and Operation Policies for vDNS Use Case  
52         - POLICY-48  CLAMP Configuration and Operation Policies for vCPE Use Case 
53         - POLICY-63  CLAMP Configuration and Operation Policies for VOLTE Use Case  
54
55     * [POLICY-38] - This epic covers the work required to support service distribution by SDC.
56
57     * [POLICY-39] - This epic covers the work required to support the Policy Platform during runtime.
58         - POLICY-61  vFW Use Case - Runtime  
59         - POLICY-62  vDNS Use Case - Runtime  
60         - POLICY-59  vCPE Use Case - Runtime  
61         - POLICY-60  VOLTE Use Case - Runtime  
62         - POLICY-51  Runtime Policy Update Support  
63         - POLICY-328  vDNS Use Case - Runtime Testing  
64         - POLICY-324  vFW Use Case - Runtime Testing  
65         - POLICY-320  VOLTE Use Case - Runtime Testing  
66         - POLICY-316  vCPE Use Case - Runtime Testing  
67
68     * [POLICY-76] - This epic covers the body of work involved in supporting R1 Amsterdam Milestone Release Planning Milestone Tasks.
69         - POLICY-77  Functional Test case definition for Control Loops  
70         - POLICY-387  Deliver the released policy artifacts  
71
72
73
74 **Bug Fixes**
75     - 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 `JiraPolicyReleaseNotes`_.
76
77 .. _JiraPolicyReleaseNotes: https://jira.onap.org/secure/ReleaseNote.jspa?projectId=10106&version=10300
78
79 **Known Issues**
80     - 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.
81
82     - For vLBS Use Case, the following steps are required to setup the service instance:
83         -  Create a Service Instance via VID.
84         -  Create a VNF Instance via VID.
85         -  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.
86         -  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.
87         -  Run heatbridge from the Robot VM using Vfmodule_ … as stack name (it is the actual stack name in OpenStack)
88         -  Populate AAI with a dummy VF module for vDNS scaling.
89
90 **Security Issues**
91     - None at this time
92
93 **Other**
94     - None at this time
95
96 End of Release Notes
97
98
99