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