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.7 Guilin Release
  14 ------------------------------
  15
  16 :Release Date: 2020-11-19
  17
  18 **New Features**
  19
  20 **Bug Fixes**
  21
  22 - MSB-539 Fix nginx say 10000 worker_connections are not enough
  23 - MSB-540 nginx in discovery deletes useless log printing
  24 - MSB-541 Discovery supports blocking monitoring time exceeding 10min
  25
  26 **Fixed Security Issues**
  27
  28 **Known Issues**
  29 - MSB-519 MSB has python 2.7 pods
  30 - MSB-520 MSB has java 8 pods
  31 - MSB-521 MSB certificates are too long and have bad owner
  32 - MSB-529 MSB dockers contain GPLv3
  33
  34 **Security Notes**
  35
  36 The remaining issues are supposed to be fixed in the next release.
  37
  38 Quick Links:
  39         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  40
  41         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  42
  43         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
  44
  45 **Upgrade Notes**
  46
  47 N/A
  48
  49 **Deprecation Notes**
  50
  51 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
  52
  53 N/A
  54
  55 **Other**
  56
  57 N/A
  58
  59 Version: 1.2.6 Frankfurt Release
  60 ------------------------------
  61
  62 :Release Date: 2020-May-07
  63
  64 **New Features**
  65
  66 **Bug Fixes**
  67
  68 - MSB-470 Pairwise testing fails from Portal to MSB
  69 - MSB-468 MSB verification job is unstable
  70 - MSB-467 Certificate in MSB is set to use *.zte.com.cn
  71 - MSB-451 Code coverage data can't show at sonarcloud
  72
  73 **Fixed Security Issues**
  74
  75 - MSB-465 Update alpine to the latest version
  76 - MSB-462 Pods still run as root
  77 - MSB-418 Solve MSB vulnerability onap-msb-discovery-jackson-databind
  78 - MSB-417 Solve MSB vulnerability onap-msb-apigateway-jackson-databind
  79 - MSB-410 Solve MSB vulnerability onap-msb-java-sdk-jackson-databind
  80 - MSB-408 Solve MSB vulnerability onap-msb-java-sdk-commons-codec
  81 - MSB-407 Solve MSB vulnerability onap-msb-java-sdk-okhttp
  82 - MSB-398 Remove plain HTTP Rest APIs
  83 - MSB-386 General sonar fixes
  84
  85 **Known Issues**
  86
  87 **Security Notes**
  88
  89 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
  90 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>`_.
  91
  92 Quick Links:
  93         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  94
  95         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  96
  97         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
  98
  99 **Upgrade Notes**
 100
 101 N/A
 102
 103 **Deprecation Notes**
 104
 105 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
 106
 107 N/A
 108
 109 **Other**
 110
 111 N/A
 112
 113 Version: 1.2.5 EI-Alto Release
 114 ------------------------------
 115
 116 :Release Date: 2019-09-05
 117
 118 **New Features**
 119
 120 This release only contains a few bug fixes and small features.
 121
 122 **New Features**
 123
 124 - MSB-332 Delete custom services via the MSB management UI
 125 - MSB-151 Support registering HTTPS service on the MSB management UI
 126
 127 **Bug Fixes**
 128
 129 - MSB-372 Empty pages that looks like they should be deleted
 130 - MSB-374 MSB stripe of the headers with underscore and it blocks SDC API functionality
 131
 132 **Known Issues**
 133
 134 **Security Notes**
 135
 136 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
 137 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>`_.
 138
 139 Quick Links:
 140         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 141
 142         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 143
 144         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
 145
 146 **Upgrade Notes**
 147
 148 N/A
 149
 150 **Deprecation Notes**
 151
 152 N/A
 153
 154 **Other**
 155
 156 N/A
 157
 158 Version: 1.2.4 Dublin Release
 159 -----------------------------
 160
 161 :Release Date: 2019-06-10
 162
 163 **New Features**
 164
 165 This release only contains some security improvements and a few fixes.
 166
 167 **Security improvements**
 168
 169 - MSB MSB-295 Nexus IQ Issue: bootstrap
 170 - MSB MSB-320 Run API Gateway as a non-root user
 171 - MSBMSB-321 Run Discovery as a non-root user
 172 - MSB MSB-322 Run Kube2msb as a non-root user
 173 - MSB MSB-328 Security issue reported by Nexus-iq : jetty-http
 174 - MSB MSB-329 Security issue reported by Nexus-iq : spring-core
 175 - MSB MSB-330 Security issue reported by Nexus-iq : commons-beanutils
 176 - MSB MSB-331 Jackson datatype security issue
 177
 178 **Bug Fixes**
 179
 180 - MSB-98  No information is available to select proper node IP from registered services
 181 - MSB-281 improve CLM for swagger sdk
 182 - MSB-325 consul container is outdated
 183 - MSB-326 non STAGING version on master
 184
 185 **Known Issues**
 186
 187 **Security Notes**
 188
 189 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
 190 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>`_.
 191
 192 Quick Links:
 193         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 194
 195         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 196
 197         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
 198
 199 **Upgrade Notes**
 200
 201 N/A
 202
 203 **Deprecation Notes**
 204
 205 N/A
 206
 207 **Other**
 208
 209 N/A
 210
 211 Version: 1.2.3
 212 --------------
 213
 214 :Release Date: 2018-11-30
 215
 216
 217 **New Features**
 218
 219 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.
 220
 221 How to manage ONAP microservices with Istio service mesh:
 222
 223 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh
 224 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh-Mutual+TLS+Authentication+Enabled
 225
 226 **Bug Fixes**
 227
 228 - `MSB-196 <https://jira.onap.org/browse/MSB-196>`_ IUI displays raw placeholder texts when failed to load translation
 229 - `MSB-291 <https://jira.onap.org/browse/MSB-291>`_ Incomplete Apache-2.0 header
 230 - `MSB-293 <https://jira.onap.org/browse/MSB-293>`_ Portal to MSB pairwise test failing in WindRiver with OOM deployment
 231 - `MSB-294 <https://jira.onap.org/browse/MSB-294>`_ Nexus IQ Issue: okhttp3
 232 - `MSB-296 <https://jira.onap.org/browse/MSB-296>`_ Nexus IQ Issue: guava
 233 - `MSB-297 <https://jira.onap.org/browse/MSB-297>`_ MSB CSIT failed
 234 - `MSB-298 <https://jira.onap.org/browse/MSB-298>`_ Release MSB artifact version 1.2.0
 235 - `MSB-300 <https://jira.onap.org/browse/MSB-300>`_ Incomplete Apache-2.0 header
 236 - `MSB-301 <https://jira.onap.org/browse/MSB-301>`_ Can't access aai resource http url via msb api gateway
 237
 238 **Known Issues**
 239
 240 - `MSB-295 <https://jira.onap.org/browse/MSB-295>`_ Nexus IQ Issue: bootstrap
 241 - `MSB-198 <https://jira.onap.org/browse/MSB-198>`_ MSB GUI can not register a service mapped to an HTTPS endpoint
 242
 243 **Security Notes**
 244
 245 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.
 246 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>`_.
 247
 248 Quick Links:
 249         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 250
 251         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 252
 253         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_
 254
 255 **Upgrade Notes**
 256
 257 N/A
 258
 259 **Deprecation Notes**
 260
 261 N/A
 262
 263 **Other**
 264
 265 N/A
 266
 267
 268 Version: 1.1.0
 269 --------------
 270
 271 :Release Date: 2018-06-07
 272
 273
 274 **New Features**
 275 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.
 276
 277 - `MSB-117 <https://jira.onap.org/browse/MSB-146>`_ Support horizontal scaling
 278 - `MSB-140 <https://jira.onap.org/browse/MSB-140>`_ Providing HTTPS endpoint at API gateway
 279 - `MSB-146 <https://jira.onap.org/browse/MSB-146>`_ Support service registration at K8s Pod level
 280 - `MSB-152 <https://jira.onap.org/browse/MSB-152>`_ MSB JAVA SDK supports HTTPS service registration
 281 - `MSB-156 <https://jira.onap.org/browse/MSB-156>`_ Support websocket request forwarding
 282 - `MSB-178 <https://jira.onap.org/browse/MSB-178>`_ Support registering multiple versions under a service name
 283 - `MSB-179 <https://jira.onap.org/browse/MSB-179>`_ Integration MSB GUI to Portal project
 284
 285 **Bug Fixes**
 286
 287 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 288 - `MSB-102 <https://jira.onap.org/browse/MSB-102>`_ The msb client has heavy dependencies
 289 - `MSB-150 <https://jira.onap.org/browse/MSB-150>`_ Kube2msb doesn't unregister service
 290 - `MSB-153 <https://jira.onap.org/browse/MSB-153>`_ MSB kube2msb registrator does not register LoadBalancer type service
 291 - `MSB-187 <https://jira.onap.org/browse/MSB-187>`_ MSB discovery API in swagger is not published
 292 - `MSB-195 <https://jira.onap.org/browse/MSB-195>`_ HTTP protocol used over HTTPS port
 293
 294 **Known Issues**
 295
 296 N/A
 297
 298 **Security Notes**
 299
 300 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>`_.
 301
 302 Quick Links:
 303
 304 - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 305 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 306 - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=25439016>`_
 307
 308 **Upgrade Notes**
 309
 310 N/A
 311
 312 **Deprecation Notes**
 313
 314 N/A
 315
 316 **Other**
 317
 318 N/A
 319
 320
 321 Version: 1.0.0
 322 --------------
 323
 324 :Release Date: 2017-11-16
 325
 326
 327 **New Features**
 328 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.
 329
 330 The current release of MSB is mainly composed of the following components:
 331
 332 **msb/apigateway**
 333
 334 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.
 335
 336 **msb/discovery**
 337
 338 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.
 339
 340 **msb/java-sdk**
 341
 342 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
 343
 344 **msb/swagger-sdk**
 345
 346 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.
 347
 348 In the future release, MSB plans to provide service mesh for ONAP.
 349
 350 **Bug Fixes**
 351
 352 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
 353 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
 354 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
 355 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
 356 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
 357 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
 358 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
 359 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
 360 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
 361 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
 362 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
 363 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed
 364 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
 365 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
 366 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
 367 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
 368 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
 369 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
 370 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed
 371 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
 372 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed
 373 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
 374
 375 **Known Issues**
 376
 377 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 378
 379 **Security Issues**
 380
 381 None
 382
 383 **Upgrade Notes**
 384
 385 This is an initial release
 386
 387 **Deprecation Notes**
 388
 389 N/A
 390
 391 **Other**
 392
 393 N/A
 394
 395 End of Release Notes