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