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