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 .. _release_notes:
   4
   5
   6 Microservices Bus(MSB) provides a reliable, resilient and scalable communication and governance infrastructure to support ONAP Microservice Architecture including service registration/discovery, external API gateway, internal API gateway, client SDK, Swagger SDK, etc. It's a pluggable architecture, plugins can be added to MSB to provide whatever functionalities you need, such as an auth plugin can be used to provide centralized authentication & authorization. MSB also provides a service portal to manage the REST APIs.
   7
   8 MSB is platform independent, while it is integrated with Kubernetes(OOM) to provide transparent service registration for ONAP microservices, MSB also supports OpenStack(Heat) and bare metal deployment.
   9
  10 Release Notes
  11 =============
  12
  13 Version: 1.2.6 Frankfurt Release
  14 ------------------------------
  15
  16 :Release Date: 2020-May-07
  17
  18 **New Features**
  19
  20 **Bug Fixes**
  21
  22 - MSB-470 Pairwise testing fails from Portal to MSB
  23 - MSB-468 MSB verification job is unstable
  24 - MSB-467 Certificate in MSB is set to use *.zte.com.cn
  25 - MSB-451 Code coverage data can't show at sonarcloud
  26
  27 **Fixed Security Issues**
  28
  29 - MSB-465 Update alpine to the latest version
  30 - MSB-462 Pods still run as root
  31 - MSB-418 Solve MSB vulnerability onap-msb-discovery-jackson-databind
  32 - MSB-417 Solve MSB vulnerability onap-msb-apigateway-jackson-databind
  33 - MSB-410 Solve MSB vulnerability onap-msb-java-sdk-jackson-databind
  34 - MSB-408 Solve MSB vulnerability onap-msb-java-sdk-commons-codec
  35 - MSB-407 Solve MSB vulnerability onap-msb-java-sdk-okhttp
  36 - MSB-398 Remove plain HTTP Rest APIs
  37 - MSB-386 General sonar fixes
  38
  39 **Known Issues**
  40
  41 **Security Notes**
  42
  43 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
  44 The remaining issues are identified as false positive and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_.
  45
  46 Quick Links:
  47         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  48
  49         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  50
  51         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
  52
  53 **Upgrade Notes**
  54
  55 N/A
  56
  57 **Deprecation Notes**
  58
  59 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
  60
  61 N/A
  62
  63 **Other**
  64
  65 N/A
  66
  67 Version: 1.2.5 EI-Alto Release
  68 ------------------------------
  69
  70 :Release Date: 2019-09-05
  71
  72 **New Features**
  73
  74 This release only contains a few bug fixes and small features.
  75
  76 **New Features**
  77
  78 - MSB-332 Delete custom services via the MSB management UI
  79 - MSB-151 Support registering HTTPS service on the MSB management UI
  80
  81 **Bug Fixes**
  82
  83 - MSB-372 Empty pages that looks like they should be deleted
  84 - MSB-374 MSB stripe of the headers with underscore and it blocks SDC API functionality
  85
  86 **Known Issues**
  87
  88 **Security Notes**
  89
  90 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
  91 The remaining issues are identified as false positive and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_.
  92
  93 Quick Links:
  94         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  95
  96         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  97
  98         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
  99
 100 **Upgrade Notes**
 101
 102 N/A
 103
 104 **Deprecation Notes**
 105
 106 N/A
 107
 108 **Other**
 109
 110 N/A
 111
 112 Version: 1.2.4 Dublin Release
 113 -----------------------------
 114
 115 :Release Date: 2019-06-10
 116
 117 **New Features**
 118
 119 This release only contains some security improvements and a few fixes.
 120
 121 **Security improvements**
 122
 123 - MSB MSB-295 Nexus IQ Issue: bootstrap
 124 - MSB MSB-320 Run API Gateway as a non-root user
 125 - MSBMSB-321 Run Discovery as a non-root user
 126 - MSB MSB-322 Run Kube2msb as a non-root user
 127 - MSB MSB-328 Security issue reported by Nexus-iq : jetty-http
 128 - MSB MSB-329 Security issue reported by Nexus-iq : spring-core
 129 - MSB MSB-330 Security issue reported by Nexus-iq : commons-beanutils
 130 - MSB MSB-331 Jackson datatype security issue
 131
 132 **Bug Fixes**
 133
 134 - MSB-98  No information is available to select proper node IP from registered services
 135 - MSB-281 improve CLM for swagger sdk
 136 - MSB-325 consul container is outdated
 137 - MSB-326 non STAGING version on master
 138
 139 **Known Issues**
 140
 141 **Security Notes**
 142
 143 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
 144 The remaining issues are identified as false positive and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_.
 145
 146 Quick Links:
 147         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 148
 149         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 150
 151         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
 152
 153 **Upgrade Notes**
 154
 155 N/A
 156
 157 **Deprecation Notes**
 158
 159 N/A
 160
 161 **Other**
 162
 163 N/A
 164
 165 Version: 1.2.3
 166 --------------
 167
 168 :Release Date: 2018-11-30
 169
 170
 171 **New Features**
 172
 173 In Casablanca Release, MSB mainly focuses on the integration of Istio service mesh with ONAP to enhance OMSA, while keeping the Istio integration compatible with the existing MSB API Gateway approaches.
 174
 175 How to manage ONAP microservices with Istio service mesh:
 176
 177 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh
 178 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh-Mutual+TLS+Authentication+Enabled
 179
 180 **Bug Fixes**
 181
 182 - `MSB-196 <https://jira.onap.org/browse/MSB-196>`_ IUI displays raw placeholder texts when failed to load translation
 183 - `MSB-291 <https://jira.onap.org/browse/MSB-291>`_ Incomplete Apache-2.0 header
 184 - `MSB-293 <https://jira.onap.org/browse/MSB-293>`_ Portal to MSB pairwise test failing in WindRiver with OOM deployment
 185 - `MSB-294 <https://jira.onap.org/browse/MSB-294>`_ Nexus IQ Issue: okhttp3
 186 - `MSB-296 <https://jira.onap.org/browse/MSB-296>`_ Nexus IQ Issue: guava
 187 - `MSB-297 <https://jira.onap.org/browse/MSB-297>`_ MSB CSIT failed
 188 - `MSB-298 <https://jira.onap.org/browse/MSB-298>`_ Release MSB artifact version 1.2.0
 189 - `MSB-300 <https://jira.onap.org/browse/MSB-300>`_ Incomplete Apache-2.0 header
 190 - `MSB-301 <https://jira.onap.org/browse/MSB-301>`_ Can't access aai resource http url via msb api gateway
 191
 192 **Known Issues**
 193
 194 - `MSB-295 <https://jira.onap.org/browse/MSB-295>`_ Nexus IQ Issue: bootstrap
 195 - `MSB-198 <https://jira.onap.org/browse/MSB-198>`_ MSB GUI can not register a service mapped to an HTTPS endpoint
 196
 197 **Security Notes**
 198
 199 MSB 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 actions to be taken in future release.
 200 The MSB open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_.
 201
 202 Quick Links:
 203         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 204
 205         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 206
 207         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_
 208
 209 **Upgrade Notes**
 210
 211 N/A
 212
 213 **Deprecation Notes**
 214
 215 N/A
 216
 217 **Other**
 218
 219 N/A
 220
 221
 222 Version: 1.1.0
 223 --------------
 224
 225 :Release Date: 2018-06-07
 226
 227
 228 **New Features**
 229 In Beijing release, MSB project mainly focused on the Platform Maturity requirements of ONAP, including the scalability and security. Some new features which were requested when integrated with other projects, such as websocket support, service registration at K8S Pod level, multiple versions of services, etc. have also been added to this release.
 230
 231 - `MSB-117 <https://jira.onap.org/browse/MSB-146>`_ Support horizontal scaling
 232 - `MSB-140 <https://jira.onap.org/browse/MSB-140>`_ Providing HTTPS endpoint at API gateway
 233 - `MSB-146 <https://jira.onap.org/browse/MSB-146>`_ Support service registration at K8s Pod level
 234 - `MSB-152 <https://jira.onap.org/browse/MSB-152>`_ MSB JAVA SDK supports HTTPS service registration
 235 - `MSB-156 <https://jira.onap.org/browse/MSB-156>`_ Support websocket request forwarding
 236 - `MSB-178 <https://jira.onap.org/browse/MSB-178>`_ Support registering multiple versions under a service name
 237 - `MSB-179 <https://jira.onap.org/browse/MSB-179>`_ Integration MSB GUI to Portal project
 238
 239 **Bug Fixes**
 240
 241 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 242 - `MSB-102 <https://jira.onap.org/browse/MSB-102>`_ The msb client has heavy dependencies
 243 - `MSB-150 <https://jira.onap.org/browse/MSB-150>`_ Kube2msb doesn't unregister service
 244 - `MSB-153 <https://jira.onap.org/browse/MSB-153>`_ MSB kube2msb registrator does not register LoadBalancer type service
 245 - `MSB-187 <https://jira.onap.org/browse/MSB-187>`_ MSB discovery API in swagger is not published
 246 - `MSB-195 <https://jira.onap.org/browse/MSB-195>`_ HTTP protocol used over HTTPS port
 247
 248 **Known Issues**
 249
 250 N/A
 251
 252 **Security Notes**
 253
 254 MSB 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 MSB open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25439016>`_.
 255
 256 Quick Links:
 257
 258 - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 259 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 260 - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=25439016>`_
 261
 262 **Upgrade Notes**
 263
 264 N/A
 265
 266 **Deprecation Notes**
 267
 268 N/A
 269
 270 **Other**
 271
 272 N/A
 273
 274
 275 Version: 1.0.0
 276 --------------
 277
 278 :Release Date: 2017-11-16
 279
 280
 281 **New Features**
 282 Initial release of Microservices Bus (MSB) for Open Network Automation Platform (ONAP). MSB provides core functionalities to support ONAP microservices architecture, including SDK for rapid microservie development, infrastructure for service communication and tools for service governance.
 283
 284 The current release of MSB is mainly composed of the following components:
 285
 286 **msb/apigateway**
 287
 288 Provides client request routing, client request load balancing, transformation, such as https to http, authentication & authorization for service request with plugin of auth service provider, service request logging, service request rate-limiting, service monitoring, request result cache, solve cross-domain issue for web application and other functionalities with the pluggable architecture capability.
 289
 290 **msb/discovery**
 291
 292 Provides service registration and discovery for ONAP microservices, which leverage Consul and build an abstract layer on top of it to make it agnostic to the registration provider and add needed extension.
 293
 294 **msb/java-sdk**
 295
 296 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
 297
 298 **msb/swagger-sdk**
 299
 300 Swagger sdk helps to generate swagger.json and java client sdk during the build time, it also helps to provide the swagger.json at the given URI in the run time.
 301
 302 In the future release, MSB plans to provide service mesh for ONAP.
 303
 304 **Bug Fixes**
 305
 306 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
 307 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
 308 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
 309 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
 310 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
 311 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
 312 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
 313 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
 314 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
 315 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
 316 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
 317 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed
 318 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
 319 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
 320 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
 321 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
 322 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
 323 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
 324 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed
 325 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
 326 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed
 327 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
 328
 329 **Known Issues**
 330
 331 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 332
 333 **Security Issues**
 334
 335 None
 336
 337 **Upgrade Notes**
 338
 339 This is an initial release
 340
 341 **Deprecation Notes**
 342
 343 N/A
 344
 345 **Other**
 346
 347 N/A
 348
 349 End of Release Notes