Update the SO release notes
[so.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Huawei Intellectual Property.  All rights reserved.
4
5
6 Service Orchestrator Release Notes
7 ==================================
8
9 The SO provides the highest level of service orchestration in the ONAP architecture. 
10
11 Version: 1.3.7
12 --------------
13
14 :Release Date: 2019-01-31
15
16 This is the official release package that released for the Casablanca Maintenance.
17
18 Casablanca Release branch
19
20 **New Features**
21
22 This release is supporting the features of Casablanca and their defect fixes.
23 - `SO-1400 <https://jira.onap.org/browse/SO-1336>`_
24 - `SO-1408 <https://jira.onap.org/browse/SO-1408>`_
25 - `SO-1416 <https://jira.onap.org/browse/SO-1416>`_
26 - `SO-1417 <https://jira.onap.org/browse/SO-1417>`_
27
28 **Docker Images**
29
30 Dockers released for SO:
31
32  - onap/so/api-handler-infra,1.3.7
33  - onap/so/bpmn-infra,1.3.7
34  - onap/so/catalog-db-adapter,1.3.7
35  - onap/so/openstack-adapter,1.3.7
36  - onap/so/request-db-adapter,1.3.7
37  - onap/so/sdc-controller,1.3.7
38  - onap/so/sdnc-adapter,1.3.7
39  - onap/so/so-monitoring,1.3.7
40  - onap/so/vfc-adapter,1.3.7
41
42 **Known Issues**
43
44 - `SO-1419 <https://jira.onap.org/browse/SO-1419>`_ - is a stretch goal that is under examination.
45
46 - `SDC-1955 <https://jira.onap.org/browse/SDC-1955>`_ - tested with a workaround to avoid this scenario. To be tested further with updated dockers of SDC, UUI and SO.
47
48 **Security Notes**
49
50         SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
51
52         Quick Links:
53
54  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
55  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
56  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
57
58
59 Version: 1.3.6
60 --------------
61
62 :Release Date: 2019-01-10
63
64 This is the official release package that released for the Casablanca Maintenance.
65
66 Casablanca Release branch
67
68 **New Features**
69
70 This release is supporting the features of Casablanca and their defect fixes.
71 - `SO-1336 <https://jira.onap.org/browse/SO-1336>`_
72 - `SO-1249 <https://jira.onap.org/browse/SO-1249>`_
73 - `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
74 - `SO-1258 <https://jira.onap.org/browse/SO-1258>`_
75 - `SO-1256 <https://jira.onap.org/browse/SO-1256>`_
76 - `SO-1194 <https://jira.onap.org/browse/SO-1256>`_
77 - `SO-1248 <https://jira.onap.org/browse/SO-1248>`_
78 - `SO-1184 <https://jira.onap.org/browse/SO-1184>`_
79
80 **Docker Images**
81
82 Dockers released for SO:
83
84  - onap/so/api-handler-infra,1.3.6
85  - onap/so/bpmn-infra,1.3.6
86  - onap/so/catalog-db-adapter,1.3.6
87  - onap/so/openstack-adapter,1.3.6
88  - onap/so/request-db-adapter,1.3.6
89  - onap/so/sdc-controller,1.3.6
90  - onap/so/sdnc-adapter,1.3.6
91  - onap/so/so-monitoring,1.3.6
92  - onap/so/vfc-adapter,1.3.6
93
94 **Known Issues**
95
96
97 **Security Notes**
98
99         SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
100
101         Quick Links:
102
103  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
104  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
105  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
106
107
108 Version: 1.3.3
109 --------------
110
111 :Release Date: 2018-11-30
112
113 This is the official release package that was tested against the 72 hour stability test in integration environment.
114
115 Casablanca Release branch
116
117 **New Features**
118
119 Features delivered in this release:
120
121  - Automatic scale out of VNFs.
122  - Extend the support of homing to vFW, vCPE usecases through HPA.
123  - Monitoring BPMN workflow capabilities through UI.
124  - SO internal architecture improvements.
125  - Support PNF resource type.
126  - Support to the CCVPN Usecase.
127  - Workflow Designer Integration.
128
129 **Docker Images**
130
131 Dockers released for SO:
132
133  - onap/so/api-handler-infra,1.3.3
134  - onap/so/bpmn-infra,1.3.3
135  - onap/so/catalog-db-adapter,1.3.3
136  - onap/so/openstack-adapter,1.3.3
137  - onap/so/request-db-adapter,1.3.3
138  - onap/so/sdc-controller,1.3.3
139  - onap/so/sdnc-adapter,1.3.3
140  - onap/so/so-monitoring,1.3.3
141  - onap/so/vfc-adapter,1.3.3
142
143 **Known Issues**
144
145 There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.5
146 - `SO-1249 <https://jira.onap.org/browse/SO-1249>`_
147 - `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
148 - `SO-1258 <https://jira.onap.org/browse/SO-1258>`_
149 - `SO-1256 <https://jira.onap.org/browse/SO-1256>`_
150 - `SO-1194 <https://jira.onap.org/browse/SO-1256>`_
151         
152 Below issues will be resolved in the next release:
153 - `SO-1248 <https://jira.onap.org/browse/SO-1248>`_
154 - `SO-1184 <https://jira.onap.org/browse/SO-1184>`_
155
156 **Security Notes**
157
158         SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
159
160         Quick Links:
161
162  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
163  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
164  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
165
166 Version: 1.3.1
167 --------------
168
169 :Release Date: 2018-10-24
170
171 Branch cut for Casablanca post M4 for integration test.
172 **New Features**
173
174 Below  features are under test:
175  - Automatic scale out of VNFs.
176  - Extend the support of homing to vFW, vCPE usecases through HPA.
177  - Monitoring BPMN workflow capabilities through UI.
178  - SO internal architecture improvements.
179  - Support PNF resource type.
180  - Support to the CCVPN Usecase.
181  - Workflow Designer Integration.
182
183
184 Version: 1.3.0
185 --------------
186
187 :Release Date: 2018-08-22
188
189 New  release over  master branch for Casablanca development
190
191 Version: 1.2.2
192 --------------
193
194 :Release Date: 2018-06-07
195
196 The Beijing release is the second release of the Service Orchestrator (SO) project.
197
198 **New Features**
199
200 * Enhance Platform maturity by improving SO maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
201 * Manual scaling of network services and VNFs.
202 * Homing and placement capabilities through OOF interaction. 
203 * Ability to perform change management.
204 * Integrated to APPC
205 * Integrated to OOF 
206 * Integrated to OOM
207  
208 **Bug Fixes**
209
210         The defects fixed in this release could be found `here <https://jira.onap.org/issues/?jql=project%20%3D%20SO%20AND%20affectedVersion%20%3D%20%22Beijing%20Release%22%20AND%20status%20%3D%20Closed%20>`_.
211
212 **Known Issues**
213
214         SO docker image is still on ecmop and not onap in the repository. 
215         This will be addressed in the next release.
216
217 **Security Notes**
218
219         SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_.
220
221 Quick Links:
222
223 - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
224 - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
225 - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_
226
227 **Upgrade Notes**
228         NA
229
230 **Deprecation Notes**
231         NA
232
233 Version: 1.1.2
234 --------------
235
236 :Release Date: 2018-01-18
237
238 Bug Fixes
239 ---------
240 The key defects fixed in this release :
241
242 - `SO-344 <https://jira.onap.org/browse/SO-344>`_
243   Only pass one VNF to DoCreateVnfAndModules.
244
245 - `SO-348 <https://jira.onap.org/browse/SO-348>`_
246   Json Analyze Exception in PreProcessRequest.
247
248 - `SO-352 <https://jira.onap.org/browse/SO-352>`_
249   SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process.
250
251 - `SO-354 <https://jira.onap.org/browse/SO-354>`_
252   Change the Service Type And Service Role
253
254
255 Version: 1.1.1
256 --------------
257
258 :Release Date: 2017-11-16
259
260
261 **New Features**
262
263 The SO provides the highest level of service orchestration in the ONAP architecture.
264 It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. 
265
266 The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. 
267
268 * Orchestration services will process workflows based on defined models and recipe. 
269 * The service model maintains consistency and re-usability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment.
270 * Orchestration processes interact with other platform components or external systems via standard and well-defined APIs.
271
272
273 **Deprecation Notes**
274
275 There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system.  
276 The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release.
277 The Gerrit repos of mso/* are voided and already locked as read-only.
278 Following are the deprecated SO projects in gerrit repo:
279
280 - mso
281 - mso/chef-repo
282 - mso/docker-config
283 - mso/libs
284 - mso/mso-config
285         
286 **Other**
287         NA
288
289 ===========
290
291 End of Release Notes