Update the Casablanca Maintenance release notes
[optf/osdf.git] / docs / sections / release-notes.rst
1 ..
2  This work is licensed under a Creative Commons Attribution 4.0
3  International License.
4
5 =============
6 Release Notes
7 =============
8
9
10 Version: 3.0.1
11 --------------
12
13 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
14
15 The following items were deployed with the Casablanca Maintenance Release:
16
17
18 **New Features**
19
20 None.
21
22 **Bug Fixes**
23
24 * [OPTFRA-401] -        Need flavor id while launching vm.
25
26
27
28 Version: 3.0.0
29 --------------
30
31 :Release Date: 2018-11-30 (Casablanca Release)
32
33 **New Features**
34
35 The Casablanca release is the second release for ONAP Optimization Framework (OOF).
36
37 A summary of features includes
38
39 * Homing enhancements for improving service deployability
40     * Discovering and reusing shared resources when processing multiple homing requests in parallel
41     * Considering Latency Reduction (in addition to geographical distances) for homing optimization
42     * Enhanced capacity checks during VNF homing
43     * Asynchronous communication between HAS components
44 * OOF Casablanca S3P Usability enhancement
45     * Adherence to ONAP API Common Versioning Strategy (CVS) Proposal
46     * Move all internal and external facing APIs to Swagger 2.0
47 * OOF Casablanca S3P Performance enhancements
48     * Creating a plan for performance improvements based on the baseline measured metrics
49 * OOF development platform hardening
50     * Deployment scripts
51     * Fix Build Docker image script for supporting multiple versions
52     * Fix OOM, HEAT deployment scripts (versioning)
53     * CSIT functional tests for each repo
54     * CI Jobs for different streams (Beijing, master etc)
55     * Clean up nexus binaries and maven versioning
56 * Integrate OOF with Certificate and Secret Management Service (CSM)
57 * Support SON (PCI) optimization using OSDF
58
59 * Platform Maturity Level 1
60     * ~65.1+ unit test coverage
61     
62 The Casablanca release for OOF delivered the following Epics.
63
64     * [OPTFRA-273] - Epic Name: OOF Casablanca S3P Manageability enhancement
65     * [OPTFRA-270] - Maintain current S3P levels
66     * [OPTFRA-271] - OOF Casablanca S3P Security enhancement
67     * [OPTFRA-267] - OOF - HPA Enhancements
68     * [OPTFRA-276] - Implementing a POC for 5G SON Optimization
69
70
71 **Bug Fixes**
72
73 * The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10445>`_
74
75 **Known Issues**
76
77   * [OPTFRA-223] -      On boarding and testing AAF certificates for OSDF.
78   * [OPTFRA-293] -      Implement encryption for all OSDF internal and external communication
79   * [OPTFRA-329] -      role based access control for OSDF-Policy interface
80
81 **Security Notes**
82
83 OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
84 The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_.
85
86 Quick Links:
87     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
88     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
89     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_
90
91 **Upgrade Notes**
92
93 None.
94
95 **Deprecation Notes**
96
97 None.
98
99 **Other**
100
101 None
102
103 Version: 2.0.0
104 --------------
105
106 :Release Date: 2018-06-07
107
108 **New Features**
109
110
111 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features includes:
112
113 * Baseline HAS functionality
114     * support for VCPE use case
115     * support for HPA (Hardware Platform Awareness)
116 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
117 * Platform Maturity Level 1
118     * ~50%+ unit test coverage
119
120 The Beijing release for OOF delivered the following Epics.
121
122     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
123     * [OPTFRA-6] - Integrate OOF with other ONAP components
124     * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
125     * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
126     * [OPTFRA-21] - OOF Packaging
127     * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
128     * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
129     * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
130     * [OPTFRA-33] - OOF Support for HPA
131     * [OPTFRA-105] - All Documentation Related User Stories and Tasks
132
133
134 **Bug Fixes**
135
136 None. Initial release R2 Beijing. No previous versions
137
138 **Known Issues**
139
140 None.
141
142 **Security Notes**
143
144 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
145
146 Quick Links:
147     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
148     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
149
150 **Upgrade Notes**
151
152 None. Initial release R2 Beijing. No previous versions
153
154 **Deprecation Notes**
155
156 None. Initial release R2 Beijing. No previous versions
157
158 **Other**
159
160 None