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.6.0 London Release
14 -------------------------------
16 :Release Date: 2022-4-15
22 - MSB-755 The route from the MSB module to the usecase-ui module does not support HTTP
24 **Fixed Security Issues**
26 - MSB-732 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR LONDON RELEASE
33 - `MSB project page for LondonRelease <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.5.0 Kohn Release
52 -------------------------------
54 :Release Date: 2022-9-19
58 - MSB-692 MSB apigateway performance improvement
62 **Fixed Security Issues**
64 - MSB-681 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR KOHN
71 - `MSB project page for Kohn Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
73 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
81 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
89 Version: 1.4.0 Jakarta Release
90 -------------------------------
92 :Release Date: 2022-3-24
96 - MSB-661 MSB should support TLSv1.3
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
105 **Fixed Security Issues**
107 - MSB-662 NGINX should user server ciphers for security
108 - MSB-644 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR JAKARTA
115 - `MSB project page for Jakarta Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
117 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
123 **Deprecation Notes**
125 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
133 Version: 1.3.1 Istanbul Release
134 -------------------------------
136 :Release Date: 2021-9-22
142 **Fixed Security Issues**
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
151 - MSB-534 kube2msb fails to register SO services including braces in url
155 The remaining issues are supposed to be fixed in the next release.
158 - `MSB project page for Istanbul Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
160 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
166 **Deprecation Notes**
168 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
176 Version: 1.2.7 Guilin Release
177 ------------------------------
179 :Release Date: 2020-11-19
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
189 **Fixed Security Issues**
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
200 The remaining issues are supposed to be fixed in the next release.
203 - `MSB project page for Guilin Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
205 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
212 **Deprecation Notes**
214 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
222 Version: 1.2.6 Frankfurt Release
223 --------------------------------
225 :Release Date: 2020-May-07
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
236 **Fixed Security Issues**
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
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.
256 - `MSB project page for Frankfurt Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
258 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
264 **Deprecation Notes**
266 Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
274 Version: 1.2.5 EI-Alto Release
275 ------------------------------
277 :Release Date: 2019-09-05
281 This release only contains a few bug fixes and small features.
285 - MSB-332 Delete custom services via the MSB management UI
286 - MSB-151 Support registering HTTPS service on the MSB management UI
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
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.
301 - `MSB project page for EI-Alto Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
303 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
305 - `Project Vulnerability Review Table for MSB EI-Alto Release <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
311 **Deprecation Notes**
319 Version: 1.2.4 Dublin Release
320 -----------------------------
322 :Release Date: 2019-06-10
326 This release only contains some security improvements and a few fixes.
328 **Security improvements**
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
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
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.
354 - `MSB project page for Dublin Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
356 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
358 - `Project Vulnerability Review Table for MSB Dublin Release <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
364 **Deprecation Notes**
375 :Release Date: 2018-11-30
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.
382 How to manage ONAP microservices with Istio service mesh:
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
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
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
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.
410 - `MSB project page for Casablanca Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
412 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
414 - `Project Vulnerability Review Table for MSB Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_
420 **Deprecation Notes**
432 :Release Date: 2018-06-07
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.
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
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
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.
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>`_
473 **Deprecation Notes**
485 :Release Date: 2017-11-16
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.
491 The current release of MSB is mainly composed of the following components:
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.
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.
503 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
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.
509 In the future release, MSB plans to provide service mesh for ONAP.
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
538 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
546 This is an initial release
548 **Deprecation Notes**