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