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