ee558f9a7362a1a37a2a5d61e3bd8b6e9003ff04
[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.3
12 --------------
13
14 :Release Date: 2018-11-30
15
16 This is the official release package that was tested against the 72 hour stability test in integration environment.
17
18 Casablanca Release branch
19
20 **New Features**
21
22 Features delivered in this release:
23
24  - Automatic scale out of VNFs.
25  - Extend the support of homing to vFW, vCPE usecases through HPA.
26  - Monitoring BPMN workflow capabilities through UI.
27  - SO internal architecture improvements.
28  - Support PNF resource type.
29  - Support to the CCVPN Usecase.
30  - Workflow Designer Integration.
31
32 **Docker Images**
33
34 Dockers released for SO:
35
36  - onap/so/api-handler-infra,1.3.3
37  - onap/so/bpmn-infra,1.3.3
38  - onap/so/catalog-db-adapter,1.3.3
39  - onap/so/openstack-adapter,1.3.3
40  - onap/so/request-db-adapter,1.3.3
41  - onap/so/sdc-controller,1.3.3
42  - onap/so/sdnc-adapter,1.3.3
43  - onap/so/so-monitoring,1.3.3
44  - onap/so/vfc-adapter,1.3.3
45
46 **Known Issues**
47
48 There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4
49 - `SO-1249 <https://jira.onap.org/browse/SO-1249>`_
50         
51 Below issues will be resolved in the next release:
52
53 - `SO-1258 <https://jira.onap.org/browse/SO-1258>`_
54 - `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
55 - `SO-1256 <https://jira.onap.org/browse/SO-1256>`_
56 - `SO-1248 <https://jira.onap.org/browse/SO-1248>`_
57
58
59 **Security Notes**
60
61         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>`_.
62
63         Quick Links:
64
65  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
66  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
67  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
68
69 Version: 1.3.1
70 --------------
71
72 :Release Date: 2018-10-24
73
74 Branch cut for Casablanca post M4 for integration test.
75 **New Features**
76
77 Below  features are under test:
78  - Automatic scale out of VNFs.
79  - Extend the support of homing to vFW, vCPE usecases through HPA.
80  - Monitoring BPMN workflow capabilities through UI.
81  - SO internal architecture improvements.
82  - Support PNF resource type.
83  - Support to the CCVPN Usecase.
84  - Workflow Designer Integration.
85
86
87 Version: 1.3.0
88 --------------
89
90 :Release Date: 2018-08-22
91
92 New  release over  master branch for Casablanca development
93
94 Version: 1.2.2
95 --------------
96
97 :Release Date: 2018-06-07
98
99 The Beijing release is the second release of the Service Orchestrator (SO) project.
100
101 **New Features**
102
103 * Enhance Platform maturity by improving SO maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
104 * Manual scaling of network services and VNFs.
105 * Homing and placement capabilities through OOF interaction. 
106 * Ability to perform change management.
107 * Integrated to APPC
108 * Integrated to OOF 
109 * Integrated to OOM
110  
111 **Bug Fixes**
112
113         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>`_.
114
115 **Known Issues**
116
117         SO docker image is still on ecmop and not onap in the repository. 
118         This will be addressed in the next release.
119
120 **Security Notes**
121
122         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>`_.
123
124 Quick Links:
125
126 - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
127 - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
128 - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_
129
130 **Upgrade Notes**
131         NA
132
133 **Deprecation Notes**
134         NA
135
136 Version: 1.1.2
137 --------------
138
139 :Release Date: 2018-01-18
140
141 Bug Fixes
142 ---------
143 The key defects fixed in this release :
144
145 - `SO-344 <https://jira.onap.org/browse/SO-344>`_
146   Only pass one VNF to DoCreateVnfAndModules.
147
148 - `SO-348 <https://jira.onap.org/browse/SO-348>`_
149   Json Analyze Exception in PreProcessRequest.
150
151 - `SO-352 <https://jira.onap.org/browse/SO-352>`_
152   SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process.
153
154 - `SO-354 <https://jira.onap.org/browse/SO-354>`_
155   Change the Service Type And Service Role
156
157
158 Version: 1.1.1
159 --------------
160
161 :Release Date: 2017-11-16
162
163
164 **New Features**
165
166 The SO provides the highest level of service orchestration in the ONAP architecture.
167 It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. 
168
169 The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. 
170
171 * Orchestration services will process workflows based on defined models and recipe. 
172 * The service model maintains consistency and re-usability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment.
173 * Orchestration processes interact with other platform components or external systems via standard and well-defined APIs.
174
175
176 **Deprecation Notes**
177
178 There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system.  
179 The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release.
180 The Gerrit repos of mso/* are voided and already locked as read-only.
181 Following are the deprecated SO projects in gerrit repo:
182
183 - mso
184 - mso/chef-repo
185 - mso/docker-config
186 - mso/libs
187 - mso/mso-config
188         
189 **Other**
190         NA
191
192 ===========
193
194 End of Release Notes