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