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.4.0 Jakarta Release
14 -------------------------------
16 :Release Date: 2022-3-24
20 - MSB-661 MSB should support TLSv1.3
24 - MSB-663 NGINX request is too small on one keepalive connection
25 - MSB-645 remove obsolete docs from msb/java-sdk repo
26 - MSB-646 remove obsolete docs from msb/discovery repo
27 - MSB-633 remove duplicated docs in msb/apigateway repo and update sphinx config files
29 **Fixed Security Issues**
31 - MSB-662 NGINX should user server ciphers for security
32 - MSB-644 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR JAKARTA
39 - `MSB project page for Jakarta Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
41 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
49 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
57 Version: 1.3.1 Istanbul Release
58 -------------------------------
60 :Release Date: 2021-9-22
66 **Fixed Security Issues**
68 - MSB-593 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR ISTANBUL
69 - MSB-519 MSB has python 2.7 pods
70 - MSB-520 MSB has java 8 pods
71 - MSB-521 MSB certificates are too long and have bad owner
75 - MSB-534 kube2msb fails to register SO services including braces in url
79 The remaining issues are supposed to be fixed in the next release.
82 - `MSB project page for Istanbul Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
84 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
92 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
100 Version: 1.2.7 Guilin Release
101 ------------------------------
103 :Release Date: 2020-11-19
109 - MSB-539 Fix nginx say 10000 worker_connections are not enough
110 - MSB-540 nginx in discovery deletes useless log printing
111 - MSB-541 Discovery supports blocking monitoring time exceeding 10min
113 **Fixed Security Issues**
117 - MSB-519 MSB has python 2.7 pods
118 - MSB-520 MSB has java 8 pods
119 - MSB-521 MSB certificates are too long and have bad owner
120 - MSB-529 MSB dockers contain GPLv3
124 The remaining issues are supposed to be fixed in the next release.
127 - `MSB project page for Guilin Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
129 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
136 **Deprecation Notes**
138 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
146 Version: 1.2.6 Frankfurt Release
147 --------------------------------
149 :Release Date: 2020-May-07
155 - MSB-470 Pairwise testing fails from Portal to MSB
156 - MSB-468 MSB verification job is unstable
157 - MSB-467 Certificate in MSB is set to use zte.com.cn
158 - MSB-451 Code coverage data can't show at sonarcloud
160 **Fixed Security Issues**
162 - MSB-465 Update alpine to the latest version
163 - MSB-462 Pods still run as root
164 - MSB-418 Solve MSB vulnerability onap-msb-discovery-jackson-databind
165 - MSB-417 Solve MSB vulnerability onap-msb-apigateway-jackson-databind
166 - MSB-410 Solve MSB vulnerability onap-msb-java-sdk-jackson-databind
167 - MSB-408 Solve MSB vulnerability onap-msb-java-sdk-commons-codec
168 - MSB-407 Solve MSB vulnerability onap-msb-java-sdk-okhttp
169 - MSB-398 Remove plain HTTP Rest APIs
170 - MSB-386 General sonar fixes
176 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
177 The remaining issues are identified as false positive and their risk assessment have been documented.
180 - `MSB project page for Frankfurt Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
182 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
188 **Deprecation Notes**
190 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
198 Version: 1.2.5 EI-Alto Release
199 ------------------------------
201 :Release Date: 2019-09-05
205 This release only contains a few bug fixes and small features.
209 - MSB-332 Delete custom services via the MSB management UI
210 - MSB-151 Support registering HTTPS service on the MSB management UI
214 - MSB-372 Empty pages that looks like they should be deleted
215 - MSB-374 MSB stripe of the headers with underscore and it blocks SDC API functionality
221 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
222 The remaining issues are identified as false positive and their risk assessment have been documented.
225 - `MSB project page for EI-Alto Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
227 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
229 - `Project Vulnerability Review Table for MSB EI-Alto Release <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
235 **Deprecation Notes**
243 Version: 1.2.4 Dublin Release
244 -----------------------------
246 :Release Date: 2019-06-10
250 This release only contains some security improvements and a few fixes.
252 **Security improvements**
254 - MSB MSB-295 Nexus IQ Issue: bootstrap
255 - MSB MSB-320 Run API Gateway as a non-root user
256 - MSBMSB-321 Run Discovery as a non-root user
257 - MSB MSB-322 Run Kube2msb as a non-root user
258 - MSB MSB-328 Security issue reported by Nexus-iq : jetty-http
259 - MSB MSB-329 Security issue reported by Nexus-iq : spring-core
260 - MSB MSB-330 Security issue reported by Nexus-iq : commons-beanutils
261 - MSB MSB-331 Jackson datatype security issue
265 - MSB-98 No information is available to select proper node IP from registered services
266 - MSB-281 improve CLM for swagger sdk
267 - MSB-325 consul container is outdated
268 - MSB-326 non STAGING version on master
274 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
275 The remaining issues are identified as false positive and their risk assessment have been documented.
278 - `MSB project page for Dublin Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
280 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
282 - `Project Vulnerability Review Table for MSB Dublin Release <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
288 **Deprecation Notes**
299 :Release Date: 2018-11-30
304 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.
306 How to manage ONAP microservices with Istio service mesh:
308 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh
309 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh-Mutual+TLS+Authentication+Enabled
313 - `MSB-196 <https://jira.onap.org/browse/MSB-196>`_ IUI displays raw placeholder texts when failed to load translation
314 - `MSB-291 <https://jira.onap.org/browse/MSB-291>`_ Incomplete Apache-2.0 header
315 - `MSB-293 <https://jira.onap.org/browse/MSB-293>`_ Portal to MSB pairwise test failing in WindRiver with OOM deployment
316 - `MSB-294 <https://jira.onap.org/browse/MSB-294>`_ Nexus IQ Issue: okhttp3
317 - `MSB-296 <https://jira.onap.org/browse/MSB-296>`_ Nexus IQ Issue: guava
318 - `MSB-297 <https://jira.onap.org/browse/MSB-297>`_ MSB CSIT failed
319 - `MSB-298 <https://jira.onap.org/browse/MSB-298>`_ Release MSB artifact version 1.2.0
320 - `MSB-300 <https://jira.onap.org/browse/MSB-300>`_ Incomplete Apache-2.0 header
321 - `MSB-301 <https://jira.onap.org/browse/MSB-301>`_ Can't access aai resource http url via msb api gateway
325 - `MSB-295 <https://jira.onap.org/browse/MSB-295>`_ Nexus IQ Issue: bootstrap
326 - `MSB-198 <https://jira.onap.org/browse/MSB-198>`_ MSB GUI can not register a service mapped to an HTTPS endpoint
330 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.
331 The MSB open Critical security vulnerabilities and their risk assessment have been documented.
334 - `MSB project page for Casablanca Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
336 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
338 - `Project Vulnerability Review Table for MSB Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_
344 **Deprecation Notes**
356 :Release Date: 2018-06-07
360 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.
362 - `MSB-117 <https://jira.onap.org/browse/MSB-146>`_ Support horizontal scaling
363 - `MSB-140 <https://jira.onap.org/browse/MSB-140>`_ Providing HTTPS endpoint at API gateway
364 - `MSB-146 <https://jira.onap.org/browse/MSB-146>`_ Support service registration at K8s Pod level
365 - `MSB-152 <https://jira.onap.org/browse/MSB-152>`_ MSB JAVA SDK supports HTTPS service registration
366 - `MSB-156 <https://jira.onap.org/browse/MSB-156>`_ Support websocket request forwarding
367 - `MSB-178 <https://jira.onap.org/browse/MSB-178>`_ Support registering multiple versions under a service name
368 - `MSB-179 <https://jira.onap.org/browse/MSB-179>`_ Integration MSB GUI to Portal project
372 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
373 - `MSB-102 <https://jira.onap.org/browse/MSB-102>`_ The msb client has heavy dependencies
374 - `MSB-150 <https://jira.onap.org/browse/MSB-150>`_ Kube2msb doesn't unregister service
375 - `MSB-153 <https://jira.onap.org/browse/MSB-153>`_ MSB kube2msb registrator does not register LoadBalancer type service
376 - `MSB-187 <https://jira.onap.org/browse/MSB-187>`_ MSB discovery API in swagger is not published
377 - `MSB-195 <https://jira.onap.org/browse/MSB-195>`_ HTTP protocol used over HTTPS port
385 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.
389 - `MSB project page for Beijing Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
390 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
391 - `Project Vulnerability Review Table for MSB Beijing Release <https://wiki.onap.org/pages/viewpage.action?pageId=40927271>`_
397 **Deprecation Notes**
409 :Release Date: 2017-11-16
413 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.
415 The current release of MSB is mainly composed of the following components:
419 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.
423 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.
427 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
431 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.
433 In the future release, MSB plans to provide service mesh for ONAP.
437 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
438 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
439 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
440 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
441 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
442 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
443 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
444 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
445 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
446 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
447 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
448 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed
449 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
450 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
451 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
452 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
453 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
454 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
455 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed
456 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
457 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed
458 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
462 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
470 This is an initial release
472 **Deprecation Notes**