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