fc9aa6d415aa1dea2b9e6997c0c2b41563bccadf
[sdnc/oam.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Release Notes
4 =============
5
6 Version: 1.3.0
7 --------------
8
9 :Release Date: 2018-07-06
10
11 **New Features**
12
13 +-------------+-------------------------------------------------------------------------------------------------------------------------+
14 | Jira #      |  Abstract                                                                                                               |
15 +=============+=========================================================================================================================+
16 |  [SDNC-278] |  Change management in-place software upgrade execution using Ansible <https://jira.onap.org/browse/SDNC-278>            |
17 +-------------+-------------------------------------------------------------------------------------------------------------------------+
18 |  [SDNC-275] | Unit tests for GenericResourceApiProvider class <https://jira.onap.org/browse/SDNC-275>                                 |
19 +-------------+-------------------------------------------------------------------------------------------------------------------------+
20 |  [SDNC-266] | Junit Test Coverage for Epic SDNC-232 <https://jira.onap.org/browse/SDNC-266>                                           |
21 +-------------+-------------------------------------------------------------------------------------------------------------------------+
22 |  [SDNC-250] | Multi-site High-availability - health-monitor reporting <https://jira.onap.org/browse/SDNC-250>                         |
23 +-------------+-------------------------------------------------------------------------------------------------------------------------+
24 |  [SDNC-223] | Maintain MD-SAL data across docker container upgrades <https://jira.onap.org/browse/SDNC-223>                           |
25 +-------------+-------------------------------------------------------------------------------------------------------------------------+
26 |  [SDNC-214] | Multi-site High-availability - Kubernetes Federation + Manual Failover (POC) <https://jira.onap.org/browse/SDNC-214>    |
27 +-------------+-------------------------------------------------------------------------------------------------------------------------+
28 |  [SDNC-210] | Address issued identified by Sonar <https://jira.onap.org/browse/SDNC-210>                                              |
29 +-------------+-------------------------------------------------------------------------------------------------------------------------+
30 |  [SDNC-163] | Deploy a SDN-C high availability environment - Kubernetes <https://jira.onap.org/browse/SDNC-163>                       |
31 +-------------+-------------------------------------------------------------------------------------------------------------------------+
32 |  [SDNC-53]  | Convert Configuration Subsystem Dependency Injection to Blueprint <https://jira.onap.org/browse/SDNC-53>                |
33 +-------------+-------------------------------------------------------------------------------------------------------------------------+
34 |  [SDNC-10]  | Refactor MD-SAL applications to conform to current OpenDaylight archetype format <https://jira.onap.org/browse/SDNC-10> |
35 +-------------+-------------------------------------------------------------------------------------------------------------------------+
36 |  [SDNC-6]   | Deploy a SDN-C high availability environment <https://jira.onap.org/browse/SDNC-6>                                      |
37 +-------------+-------------------------------------------------------------------------------------------------------------------------+
38
39 **Bug Fixes**
40
41 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
42 | Jira #     | Abstract                                                                                                                                             |
43 +============+======================================================================================================================================================+
44 | [SDNC-313] | LCM does not retrieve status from ansible-server correctly <https://jira.onap.org/browse/SDNC-313>                                                   |
45 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
46 | [SDNC-311] | sdnc/features build fails <https://jira.onap.org/browse/SDNC-311>                                                                                    |
47 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
48 | [SDNC-310] | General cleanup of SDNC helm charts <https://jira.onap.org/browse/SDNC-310>                                                                          |
49 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
50 | [SDNC-309] | ansible adapter properties file missing <https://jira.onap.org/browse/SDNC-309>                                                                      |
51 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
52 | [SDNC-308] | OOM: Update UEB and DMaaP charts to use new message-router name <https://jira.onap.org/browse/SDNC-308>                                              |
53 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
54 | [SDNC-306] | SDNC fails health check on HEAT deployment <https://jira.onap.org/browse/SDNC-306>                                                                   |
55 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
56 | [SDNC-305] | No model found for VF module customization UUID <https://jira.onap.org/browse/SDNC-305>                                                              |
57 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+  
58 | [SDNC-303] | aaiclient.properties using wrong JKS <https://jira.onap.org/browse/SDNC-303>                                                                         |
59 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
60 | [SDNC-302] | SDNC VNF-API ssl certificate error updating AAI <https://jira.onap.org/browse/SDNC-302>                                                              |
61 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
62 | [SDNC-299] | OOM deployment with 2+ MySQL instances fails when NFS provisioner disabled <https://jira.onap.org/browse/SDNC-299>                                   |
63 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
64 | [SDNC-298] | SDNC aaiclient.properties should reference v13 A&AI api <https://jira.onap.org/browse/SDNC-298>                                                      |
65 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
66 | [SDNC-295] | Ansible server stops <https://jira.onap.org/browse/SDNC-295>                                                                                         |
67 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
68 | [SDNC-293] | DMaaP listener not connecting to DMaaP in OOM deployment <https://jira.onap.org/browse/SDNC-293>                                                     |
69 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
70 | [SDNC-292] | Daily build of unused sdnc/features repo fails <https://jira.onap.org/browse/SDNC-292>                                                               |
71 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
72 | [SDNC-286] | OOM: SDN-C servers don't come up cleanly when enableClustering=true <https://jira.onap.org/browse/SDNC-286>                                          |
73 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
74 | [SDNC-285] | sdnc-dgbuilder container image error with onap/ccsdk-dgbuilder-image:0.2.1-SNAPSHOT <https://jira.onap.org/browse/SDNC-285>                          |
75 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
76 | [SDNC-284] | sdnc-dgbuilder container image error with onap/ccsdk-dgbuilder-image:0.2.1-SNAPSHOT deleted from nexus3 <https://jira.onap.org/browse/SDNC-284>      |
77 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
78 | [SDNC-283] | SDNC fails CSIT <https://jira.onap.org/browse/SDNC-283>                                                                                              |
79 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
80 | [SDNC-279] | sdnc docker build fails <https://jira.onap.org/browse/SDNC-279>                                                                                      |
81 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
82 | [SDNC-277] | SDNC CSIT test fails <https://jira.onap.org/browse/SDNC-277>                                                                                         |
83 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
84 | [SDNC-234] | DMAAP ID in dhcpalert.properties cannot contain "\_" <https://jira.onap.org/browse/SDNC-234>                                                         |
85 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
86 | [SDNC-228] | Duplicate test file name <https://jira.onap.org/browse/SDNC-228>                                                                                     |
87 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
88 | [SDNC-207] | generic-resource-api-model: failing on goal yang-maven-plugin - master only - force 1.2.0 over default 2.0.0 <https://jira.onap.org/browse/SDNC-207> |
89 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
90 | [SDNC-203] | SDNC VM & Docker Containers Unstable <https://jira.onap.org/browse/SDNC-203>                                                                         |
91 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
92 | [SDNC-195] | brg-topology-operations deactivate does not pick up parameters correctly when creating AAI request <https://jira.onap.org/browse/SDNC-195>           |
93 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
94 | [SDNC-156] | unknown log fills up on failed DELETE <https://jira.onap.org/browse/SDNC-156>                                                                        |
95 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
96 | [SDNC-127] | Generated sources not placed under target directory breaks tooling apps <https://jira.onap.org/browse/SDNC-127>                                      |
97 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
98 | [SDNC-105] | Generic Resource API DGs contain old openecomp and com.att based plugin references <https://jira.onap.org/browse/SDNC-105>                           |
99 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
100 | [SDNC-87]  | Accessing invalid network-parameters from network-request-input, it should be network-input-parameters <https://jira.onap.org/browse/SDNC-87>        |
101 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
102 | [SDNC-73]  | vnfapi: new feature to support softdelete <https://jira.onap.org/browse/SDNC-73>                                                                     |
103 +------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
104
105 **Known Issues**
106
107 +------------+----------------------------------------------------------------------------------------------------------------------------------+
108 | Jira #     | Abstract                                                                                                                         |
109 +============+==================================================================================================================================+
110 | [SDNC-304] | SDNC OOM intermittent Healthcheck failure - JSONDecodeError - on different startup order <https://jira.onap.org/browse/SDNC-304> |
111 +------------+----------------------------------------------------------------------------------------------------------------------------------+
112 | [SDNC-291] | vCPE Model distribution error in UEB Listener SQL Insert <https://jira.onap.org/browse/SDNC-291>                                 |
113 +------------+----------------------------------------------------------------------------------------------------------------------------------+
114 | [SDNC-290] | Fix nodePortPrefix in service yaml <https://jira.onap.org/browse/SDNC-290>                                                       |
115 +------------+----------------------------------------------------------------------------------------------------------------------------------+
116 | [SDNC-246] | Passwords stored in clear text in properties files <https://jira.onap.org/browse/SDNC-246>                                       |
117 +------------+----------------------------------------------------------------------------------------------------------------------------------+
118 | [SDNC-208] | SDNC preload - fix confusion: vnf-name=VF-Module, generic-vnf-name=VNF <https://jira.onap.org/browse/SDNC-208>                   |
119 +------------+----------------------------------------------------------------------------------------------------------------------------------+
120 | [SDNC-206] | REST calls from DG <https://jira.onap.org/browse/SDNC-206>                                                                       |
121 +------------+----------------------------------------------------------------------------------------------------------------------------------+
122 | [SDNC-115] | VNFAPI DGs contain plugin references to software not part of ONAP <https://jira.onap.org/browse/SDNC-115>                        |
123 +------------+----------------------------------------------------------------------------------------------------------------------------------+
124 | [SDNC-114] | Generic API DGs contain plugin references to software not part of ONAP <https://jira.onap.org/browse/SDNC-114>                   |
125 +------------+----------------------------------------------------------------------------------------------------------------------------------+
126 | [SDNC-106] | VNFAPI DGs contain old openecomp and com.att based plugin references <https://jira.onap.org/browse/SDNC-106>                     |
127 +------------+----------------------------------------------------------------------------------------------------------------------------------+
128 | [SDNC-64]  | SDNC is not setting FromApp identifier in logging MDC <https://jira.onap.org/browse/SDNC-64>                                     |
129 +------------+----------------------------------------------------------------------------------------------------------------------------------+
130
131 **Security Notes**
132
133 SDNC 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 SDNC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28379582>`_.
134
135 Quick Links:
136 - `SDNC project page <https://wiki.onap.org/display/DW/Software+Defined+Network+Controller+Project>`_
137 - `Passing Badge information for SDNC <https://bestpractices.coreinfrastructure.org/en/projects/1703>`_
138 - `Project Vulnerability Review Table for SDNC <https://wiki.onap.org/pages/viewpage.action?pageId=28379582>`_
139
140 **Upgrade Notes**
141         NA
142
143 **Deprecation Notes**
144         NA
145
146 **Other**
147         NA
148
149 Version: 1.2.1
150 --------------
151
152 :Release Date: 2018-01-18
153
154 **Bug Fixes**
155
156 - `SDNC-145 <https://jira.onap.org/browse/SDNC-145>`_ Error message refers to wrong parameters
157 - `SDNC-195 <https://jira.onap.org/browse/SDNC-195>`_ UEB listener doesn't insert correct parameters for allotted resources in DB table ALLOTTED_RESOURCE_MODEL
158 - `SDNC-198 <https://jira.onap.org/browse/SDNC-198>`_ CSIT job fails
159 - `SDNC-201 <https://jira.onap.org/browse/SDNC-201>`_ Fix DG bugs from integration tests
160 - `SDNC-202 <https://jira.onap.org/browse/SDNC-202>`_ Search for service -data null match, set vGW LAN IP via Heat
161 - `SDNC-211 <https://jira.onap.org/browse/SDNC-211>`_ Update SDNC Amsterdam branch to use maintenance release versions
162 - `SDNC-212 <https://jira.onap.org/browse/SDNC-212>`_ Duplicate file name
163
164 Version: 1.2.0
165 --------------
166
167 :Release Date: 2017-11-16
168
169 **New Features**
170
171 The ONAP Amsterdam release introduces the following changes to SDNC from
172 the original openECOMP seed code:
173    - Refactored / moved common platform code to new CCSDK project
174    - Refactored code to rename openecomp to onap
175    - Introduced new GENERIC-RESOURCE-API api, used by vCPE and VoLTE use cases
176    - Introduced new docker containers for SDC and DMAAP interfaces
177
178 **Bug Fixes**
179         NA
180 **Known Issues**
181 The following known high priority issues are being worked and are expected to be delivered
182 in release 1.2.1:
183 - `SDNC-179 <https://jira.onap.org/browse/SDNC-179>`_ Failed to make HTTPS connection in restapicall node
184 - `SDNC-181 <https://jira.onap.org/browse/SDNC-181>`_ Change call to brg-wan-ip-address vbrg-wan-ip brg topo activate DG
185 - `SDNC-182 <https://jira.onap.org/browse/SDNC-182>`_ Fix VNI Consistency: Add vG vxlan tunnel setup and bridge domain setup to brg-topo-activate DG
186
187 **Security Issues**
188         NA
189
190 **Upgrade Notes**
191         NA
192
193 **Deprecation Notes**
194         NA
195
196 **Other**
197         NA
198
199