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