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