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
   4
   5 MSB
   6 ===
   7
   8 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.
   9
  10 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.
  11
  12 Release Notes
  13 =============
  14
  15 Version: 1.2.5 EI-Alto Release
  16 ------------------------------
  17
  18 :Release Date: 2019-09-05
  19
  20 **New Features**
  21
  22 This release only contains a few bug fixes and small features.
  23
  24 **New Features**
  25
  26 - `MSB-332 Delete custom services via the MSB management UI`_
  27 - `MSB-151 Support registering HTTPS service on the MSB management UI`_
  28
  29 **Bug Fixes**
  30
  31 - `MSB-372 Empty pages that looks like they should be deleted`_
  32 - `MSB-374 MSB stripe of the headers with underscore and it blocks SDC API functionality`_
  33
  34 **Known Issues**
  35
  36 **Security Notes**
  37
  38 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
  39 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>`_.
  40
  41 Quick Links:
  42         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  43
  44         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  45
  46         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
  47
  48 **Upgrade Notes**
  49
  50 N/A
  51
  52 **Deprecation Notes**
  53
  54 N/A
  55
  56 **Other**
  57
  58 N/A
  59
  60 Version: 1.2.4 Dublin Release
  61 -----------------------------
  62
  63 :Release Date: 2019-06-10
  64
  65 **New Features**
  66
  67 This release only contains some security improvements and a few fixes.
  68
  69 **Security improvements**
  70
  71 - `MSB MSB-295 Nexus IQ Issue: bootstrap`_
  72 - `MSB MSB-320 Run API Gateway as a non-root user`_
  73 - `MSBMSB-321 Run Discovery as a non-root user`_
  74 - `MSB MSB-322 Run Kube2msb as a non-root user`_
  75 - `MSB MSB-328 Security issue reported by Nexus-iq : jetty-http`_
  76 - `MSB MSB-329 Security issue reported by Nexus-iq : spring-core`_
  77 - `MSB MSB-330 Security issue reported by Nexus-iq : commons-beanutils`_
  78 - `MSB MSB-331 Jackson datatype security issue
  79
  80 **Bug Fixes**
  81
  82 - `MSB-98  No information is available to select proper node IP from registered services`_
  83 - `MSB-281 improve CLM for swagger sdk`_
  84 - `MSB-325 consul container is outdated`_
  85 - `MSB-326 non STAGING version on master`_
  86
  87 **Known Issues**
  88
  89 **Security Notes**
  90
  91 MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
  92 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>`_.
  93
  94 Quick Links:
  95         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  96
  97         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  98
  99         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
 100
 101 **Upgrade Notes**
 102
 103 N/A
 104
 105 **Deprecation Notes**
 106
 107 N/A
 108
 109 **Other**
 110
 111 N/A
 112
 113 Version: 1.2.3
 114 --------------
 115
 116 :Release Date: 2018-11-30
 117
 118
 119 **New Features**
 120
 121 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.
 122
 123 How to manage ONAP microservices with Istio service mesh:
 124
 125 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh
 126 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh-Mutual+TLS+Authentication+Enabled
 127
 128 **Bug Fixes**
 129
 130 - `MSB-196 <https://jira.onap.org/browse/MSB-196>`_ IUI displays raw placeholder texts when failed to load translation
 131 - `MSB-291 <https://jira.onap.org/browse/MSB-291>`_ Incomplete Apache-2.0 header
 132 - `MSB-293 <https://jira.onap.org/browse/MSB-293>`_ Portal to MSB pairwise test failing in WindRiver with OOM deployment
 133 - `MSB-294 <https://jira.onap.org/browse/MSB-294>`_ Nexus IQ Issue: okhttp3
 134 - `MSB-296 <https://jira.onap.org/browse/MSB-296>`_ Nexus IQ Issue: guava
 135 - `MSB-297 <https://jira.onap.org/browse/MSB-297>`_ MSB CSIT failed
 136 - `MSB-298 <https://jira.onap.org/browse/MSB-298>`_ Release MSB artifact version 1.2.0
 137 - `MSB-300 <https://jira.onap.org/browse/MSB-300>`_ Incomplete Apache-2.0 header
 138 - `MSB-301 <https://jira.onap.org/browse/MSB-301>`_ Can't access aai resource http url via msb api gateway
 139
 140 **Known Issues**
 141
 142 - `MSB-295 <https://jira.onap.org/browse/MSB-295>`_ Nexus IQ Issue: bootstrap
 143 - `MSB-198 <https://jira.onap.org/browse/MSB-198>`_ MSB GUI can not register a service mapped to an HTTPS endpoint
 144
 145 **Security Notes**
 146
 147 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.
 148 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>`_.
 149
 150 Quick Links:
 151         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 152
 153         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 154
 155         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_
 156
 157 **Upgrade Notes**
 158
 159 N/A
 160
 161 **Deprecation Notes**
 162
 163 N/A
 164
 165 **Other**
 166
 167 N/A
 168
 169
 170 Version: 1.1.0
 171 --------------
 172
 173 :Release Date: 2018-06-07
 174
 175
 176 **New Features**
 177 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.
 178
 179 - `MSB-117 <https://jira.onap.org/browse/MSB-146>`_ Support horizontal scaling
 180 - `MSB-140 <https://jira.onap.org/browse/MSB-140>`_ Providing HTTPS endpoint at API gateway
 181 - `MSB-146 <https://jira.onap.org/browse/MSB-146>`_ Support service registration at K8s Pod level
 182 - `MSB-152 <https://jira.onap.org/browse/MSB-152>`_ MSB JAVA SDK supports HTTPS service registration
 183 - `MSB-156 <https://jira.onap.org/browse/MSB-156>`_ Support websocket request forwarding
 184 - `MSB-178 <https://jira.onap.org/browse/MSB-178>`_ Support registering multiple versions under a service name
 185 - `MSB-179 <https://jira.onap.org/browse/MSB-179>`_ Integration MSB GUI to Portal project
 186
 187 **Bug Fixes**
 188
 189 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 190 - `MSB-102 <https://jira.onap.org/browse/MSB-102>`_ The msb client has heavy dependencies
 191 - `MSB-150 <https://jira.onap.org/browse/MSB-150>`_ Kube2msb doesn't unregister service
 192 - `MSB-153 <https://jira.onap.org/browse/MSB-153>`_ MSB kube2msb registrator does not register LoadBalancer type service
 193 - `MSB-187 <https://jira.onap.org/browse/MSB-187>`_ MSB discovery API in swagger is not published
 194 - `MSB-195 <https://jira.onap.org/browse/MSB-195>`_ HTTP protocol used over HTTPS port
 195
 196 **Known Issues**
 197
 198 N/A
 199
 200 **Security Notes**
 201
 202 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>`_.
 203
 204 Quick Links:
 205
 206 - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
 207 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
 208 - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=25439016>`_
 209
 210 **Upgrade Notes**
 211
 212 N/A
 213
 214 **Deprecation Notes**
 215
 216 N/A
 217
 218 **Other**
 219
 220 N/A
 221
 222
 223 Version: 1.0.0
 224 --------------
 225
 226 :Release Date: 2017-11-16
 227
 228
 229 **New Features**
 230 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.
 231
 232 The current release of MSB is mainly composed of the following components：
 233
 234 **msb/apigateway**
 235
 236 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.
 237
 238 **msb/discovery**
 239
 240 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.
 241
 242 **msb/java-sdk**
 243
 244 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
 245
 246 **msb/swagger-sdk**
 247
 248 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.
 249
 250 In the future release, MSB plans to provide service mesh for ONAP.
 251
 252 **Bug Fixes**
 253
 254 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
 255 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
 256 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
 257 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
 258 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
 259 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
 260 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
 261 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
 262 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
 263 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
 264 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
 265 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed
 266 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
 267 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
 268 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
 269 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
 270 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
 271 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
 272 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed
 273 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
 274 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed
 275 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
 276
 277 **Known Issues**
 278
 279 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 280
 281 **Security Issues**
 282
 283 None
 284
 285 **Upgrade Notes**
 286
 287 This is an initial release
 288
 289 **Deprecation Notes**
 290
 291 N/A
 292
 293 **Other**
 294
 295 N/A
 296
 297 End of Release Notes