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