1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
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.
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.
13 Version: 1.5.0 Kohn Release
14 -------------------------------
16 :Release Date: 2022-9-19
20 - MSB-692 MSB apigateway performance improvement
24 **Fixed Security Issues**
26 - MSB-681 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR KOHN
33 - `MSB project page for Jakarta Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
35 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
43 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
51 Version: 1.4.0 Jakarta Release
52 -------------------------------
54 :Release Date: 2022-3-24
58 - MSB-661 MSB should support TLSv1.3
62 - MSB-663 NGINX requests is too small on one keepalive connection
63 - MSB-645 remove obsolete docs from msb/java-sdk repo
64 - MSB-646 remove obsolete docs from msb/discovery repo
65 - MSB-633 remove duplicated docs in msb/apigateway repo and update sphinx config files
67 **Fixed Security Issues**
69 - MSB-662 NGINX should user server ciphers for security
70 - MSB-644 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR JAKARTA
77 - `MSB project page for Jakarta Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
79 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
87 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
95 Version: 1.3.1 Istanbul Release
96 -------------------------------
98 :Release Date: 2021-9-22
104 **Fixed Security Issues**
106 - MSB-593 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR ISTANBUL
107 - MSB-519 MSB has python 2.7 pods
108 - MSB-520 MSB has java 8 pods
109 - MSB-521 MSB certificates are too long and have bad owner
113 - MSB-534 kube2msb fails to register SO services including braces in url
117 The remaining issues are supposed to be fixed in the next release.
120 - `MSB project page for Istanbul Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
122 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
128 **Deprecation Notes**
130 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
138 Version: 1.2.7 Guilin Release
139 ------------------------------
141 :Release Date: 2020-11-19
147 - MSB-539 Fix nginx say 10000 worker_connections are not enough
148 - MSB-540 nginx in discovery deletes useless log printing
149 - MSB-541 Discovery supports blocking monitoring time exceeding 10min
151 **Fixed Security Issues**
155 - MSB-519 MSB has python 2.7 pods
156 - MSB-520 MSB has java 8 pods
157 - MSB-521 MSB certificates are too long and have bad owner
158 - MSB-529 MSB dockers contain GPLv3
162 The remaining issues are supposed to be fixed in the next release.
165 - `MSB project page for Guilin Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
167 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
174 **Deprecation Notes**
176 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
184 Version: 1.2.6 Frankfurt Release
185 --------------------------------
187 :Release Date: 2020-May-07
193 - MSB-470 Pairwise testing fails from Portal to MSB
194 - MSB-468 MSB verification job is unstable
195 - MSB-467 Certificate in MSB is set to use zte.com.cn
196 - MSB-451 Code coverage data can't show at sonarcloud
198 **Fixed Security Issues**
200 - MSB-465 Update alpine to the latest version
201 - MSB-462 Pods still run as root
202 - MSB-418 Solve MSB vulnerability onap-msb-discovery-jackson-databind
203 - MSB-417 Solve MSB vulnerability onap-msb-apigateway-jackson-databind
204 - MSB-410 Solve MSB vulnerability onap-msb-java-sdk-jackson-databind
205 - MSB-408 Solve MSB vulnerability onap-msb-java-sdk-commons-codec
206 - MSB-407 Solve MSB vulnerability onap-msb-java-sdk-okhttp
207 - MSB-398 Remove plain HTTP Rest APIs
208 - MSB-386 General sonar fixes
214 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
215 The remaining issues are identified as false positive and their risk assessment have been documented.
218 - `MSB project page for Frankfurt Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
220 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
226 **Deprecation Notes**
228 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
236 Version: 1.2.5 EI-Alto Release
237 ------------------------------
239 :Release Date: 2019-09-05
243 This release only contains a few bug fixes and small features.
247 - MSB-332 Delete custom services via the MSB management UI
248 - MSB-151 Support registering HTTPS service on the MSB management UI
252 - MSB-372 Empty pages that looks like they should be deleted
253 - MSB-374 MSB stripe of the headers with underscore and it blocks SDC API functionality
259 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
260 The remaining issues are identified as false positive and their risk assessment have been documented.
263 - `MSB project page for EI-Alto Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
265 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
267 - `Project Vulnerability Review Table for MSB EI-Alto Release <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
273 **Deprecation Notes**
281 Version: 1.2.4 Dublin Release
282 -----------------------------
284 :Release Date: 2019-06-10
288 This release only contains some security improvements and a few fixes.
290 **Security improvements**
292 - MSB MSB-295 Nexus IQ Issue: bootstrap
293 - MSB MSB-320 Run API Gateway as a non-root user
294 - MSBMSB-321 Run Discovery as a non-root user
295 - MSB MSB-322 Run Kube2msb as a non-root user
296 - MSB MSB-328 Security issue reported by Nexus-iq : jetty-http
297 - MSB MSB-329 Security issue reported by Nexus-iq : spring-core
298 - MSB MSB-330 Security issue reported by Nexus-iq : commons-beanutils
299 - MSB MSB-331 Jackson datatype security issue
303 - MSB-98 No information is available to select proper node IP from registered services
304 - MSB-281 improve CLM for swagger sdk
305 - MSB-325 consul container is outdated
306 - MSB-326 non STAGING version on master
312 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
313 The remaining issues are identified as false positive and their risk assessment have been documented.
316 - `MSB project page for Dublin Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
318 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
320 - `Project Vulnerability Review Table for MSB Dublin Release <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
326 **Deprecation Notes**
337 :Release Date: 2018-11-30
342 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.
344 How to manage ONAP microservices with Istio service mesh:
346 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh
347 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh-Mutual+TLS+Authentication+Enabled
351 - `MSB-196 <https://jira.onap.org/browse/MSB-196>`_ IUI displays raw placeholder texts when failed to load translation
352 - `MSB-291 <https://jira.onap.org/browse/MSB-291>`_ Incomplete Apache-2.0 header
353 - `MSB-293 <https://jira.onap.org/browse/MSB-293>`_ Portal to MSB pairwise test failing in WindRiver with OOM deployment
354 - `MSB-294 <https://jira.onap.org/browse/MSB-294>`_ Nexus IQ Issue: okhttp3
355 - `MSB-296 <https://jira.onap.org/browse/MSB-296>`_ Nexus IQ Issue: guava
356 - `MSB-297 <https://jira.onap.org/browse/MSB-297>`_ MSB CSIT failed
357 - `MSB-298 <https://jira.onap.org/browse/MSB-298>`_ Release MSB artifact version 1.2.0
358 - `MSB-300 <https://jira.onap.org/browse/MSB-300>`_ Incomplete Apache-2.0 header
359 - `MSB-301 <https://jira.onap.org/browse/MSB-301>`_ Can't access aai resource http url via msb api gateway
363 - `MSB-295 <https://jira.onap.org/browse/MSB-295>`_ Nexus IQ Issue: bootstrap
364 - `MSB-198 <https://jira.onap.org/browse/MSB-198>`_ MSB GUI can not register a service mapped to an HTTPS endpoint
368 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.
369 The MSB open Critical security vulnerabilities and their risk assessment have been documented.
372 - `MSB project page for Casablanca Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
374 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
376 - `Project Vulnerability Review Table for MSB Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_
382 **Deprecation Notes**
394 :Release Date: 2018-06-07
398 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.
400 - `MSB-117 <https://jira.onap.org/browse/MSB-146>`_ Support horizontal scaling
401 - `MSB-140 <https://jira.onap.org/browse/MSB-140>`_ Providing HTTPS endpoint at API gateway
402 - `MSB-146 <https://jira.onap.org/browse/MSB-146>`_ Support service registration at K8s Pod level
403 - `MSB-152 <https://jira.onap.org/browse/MSB-152>`_ MSB JAVA SDK supports HTTPS service registration
404 - `MSB-156 <https://jira.onap.org/browse/MSB-156>`_ Support websocket request forwarding
405 - `MSB-178 <https://jira.onap.org/browse/MSB-178>`_ Support registering multiple versions under a service name
406 - `MSB-179 <https://jira.onap.org/browse/MSB-179>`_ Integration MSB GUI to Portal project
410 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
411 - `MSB-102 <https://jira.onap.org/browse/MSB-102>`_ The msb client has heavy dependencies
412 - `MSB-150 <https://jira.onap.org/browse/MSB-150>`_ Kube2msb doesn't unregister service
413 - `MSB-153 <https://jira.onap.org/browse/MSB-153>`_ MSB kube2msb registrator does not register LoadBalancer type service
414 - `MSB-187 <https://jira.onap.org/browse/MSB-187>`_ MSB discovery API in swagger is not published
415 - `MSB-195 <https://jira.onap.org/browse/MSB-195>`_ HTTP protocol used over HTTPS port
423 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.
427 - `MSB project page for Beijing Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
428 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
429 - `Project Vulnerability Review Table for MSB Beijing Release <https://wiki.onap.org/pages/viewpage.action?pageId=40927271>`_
435 **Deprecation Notes**
447 :Release Date: 2017-11-16
451 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.
453 The current release of MSB is mainly composed of the following components:
457 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.
461 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.
465 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
469 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.
471 In the future release, MSB plans to provide service mesh for ONAP.
475 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
476 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
477 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
478 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
479 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
480 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
481 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
482 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
483 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
484 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
485 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
486 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed
487 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
488 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
489 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
490 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
491 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
492 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
493 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed
494 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
495 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed
496 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
500 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
508 This is an initial release
510 **Deprecation Notes**