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 Release Notes
   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 Version: 1.1.0
  13 --------------
  14
  15 :Release Date: 2018-06-07
  16
  17
  18 **New Features**
  19 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.
  20
  21 - `MSB-117 <https://jira.onap.org/browse/MSB-146>`_ Support horizontal scaling
  22 - `MSB-140 <https://jira.onap.org/browse/MSB-140>`_ Providing HTTPS endpoint at API gateway
  23 - `MSB-146 <https://jira.onap.org/browse/MSB-146>`_ Support service registration at K8s Pod level
  24 - `MSB-152 <https://jira.onap.org/browse/MSB-152>`_ MSB JAVA SDK supports HTTPS service registration
  25 - `MSB-156 <https://jira.onap.org/browse/MSB-156>`_ Support websocket request forwarding
  26 - `MSB-178 <https://jira.onap.org/browse/MSB-178>`_ Support registering multiple versions under a service name
  27 - `MSB-179 <https://jira.onap.org/browse/MSB-179>`_ Integration MSB GUI to Portal project
  28
  29 **Bug Fixes**
  30
  31 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
  32 - `MSB-102 <https://jira.onap.org/browse/MSB-102>`_ The msb client has heavy dependencies
  33 - `MSB-150 <https://jira.onap.org/browse/MSB-150>`_ Kube2msb doesn't unregister service
  34 - `MSB-153 <https://jira.onap.org/browse/MSB-153>`_ MSB kube2msb registrator does not register LoadBalancer type service
  35 - `MSB-187 <https://jira.onap.org/browse/MSB-187>`_ MSB discovery API in swagger is not published
  36 - `MSB-195 <https://jira.onap.org/browse/MSB-195>`_ HTTP protocol used over HTTPS port
  37
  38 **Known Issues**
  39
  40 N/A
  41
  42 **Security Notes**
  43
  44 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>`_.
  45
  46 Quick Links:
  47
  48 - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  49 - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  50 - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=25439016>`_
  51
  52 **Upgrade Notes**
  53
  54 N/A
  55
  56 **Deprecation Notes**
  57
  58 N/A
  59
  60 **Other**
  61
  62 N/A
  63
  64
  65 Version: 1.0.0
  66 --------------
  67
  68 :Release Date: 2017-11-16
  69
  70
  71 **New Features**
  72 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.
  73
  74 The current release of MSB is mainly composed of the following components：
  75
  76 **msb/apigateway**
  77
  78 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.
  79
  80 **msb/discovery**
  81
  82 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.
  83
  84 **msb/java-sdk**
  85
  86 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
  87
  88 **msb/swagger-sdk**
  89
  90 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.
  91
  92 In the future release, MSB plans to provide service mesh for ONAP.
  93
  94 **Bug Fixes**
  95
  96 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
  97 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
  98 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
  99 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
 100 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
 101 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
 102 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
 103 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
 104 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
 105 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
 106 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
 107 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed
 108 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
 109 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
 110 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
 111 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
 112 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
 113 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
 114 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed
 115 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
 116 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed
 117 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
 118
 119 **Known Issues**
 120
 121 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 122
 123 **Security Issues**
 124
 125 None
 126
 127 **Upgrade Notes**
 128
 129 This is an initial release
 130
 131 **Deprecation Notes**
 132
 133 N/A
 134
 135 **Other**
 136
 137 N/A
 138
 139 Version: 1.2.3
 140 --------------
 141
 142 :Release Date: 2018-11-20
 143
 144
 145 **New Features**
 146
 147 In Casablanca, 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.
 148
 149 How to manage ONAP microservices with Istio service mesh:
 150
 151 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh
 152 - https://wiki.onap.org/display/DW/Manage+ONAP+Microservices+with+Istio+Service+Mesh-Mutual+TLS+Authentication+Enabled
 153
 154 **Bug Fixes**
 155
 156 - `MSB-196 <https://jira.onap.org/browse/MSB-196>`_ IUI displays raw placeholder texts when failed to load translation
 157 - `MSB-291 <https://jira.onap.org/browse/MSB-291>`_ Incomplete Apache-2.0 header
 158 - `MSB-293 <https://jira.onap.org/browse/MSB-293>`_ Portal to MSB pairwise test failing in WindRiver with OOM deployment
 159 - `MSB-294 <https://jira.onap.org/browse/MSB-294>`_ Nexus IQ Issue: okhttp3
 160 - `MSB-296 <https://jira.onap.org/browse/MSB-296>`_ Nexus IQ Issue: guava
 161 - `MSB-297 <https://jira.onap.org/browse/MSB-297>`_ MSB CSIT failed
 162 - `MSB-298 <https://jira.onap.org/browse/MSB-298>`_ Release MSB artifact version 1.2.0
 163 - `MSB-300 <https://jira.onap.org/browse/MSB-300>`_ Incomplete Apache-2.0 header
 164 - `MSB-301 <https://jira.onap.org/browse/MSB-301>`_ Can't access aai resource http url via msb api gateway
 165
 166 **Known Issues**
 167
 168 - `MSB-295 <https://jira.onap.org/browse/MSB-295>`_ Nexus IQ Issue: bootstrap
 169 - `MSB-198 <https://jira.onap.org/browse/MSB-198>`_ MSB GUI can not register a service mapped to an HTTPS endpoint
 170
 171 **Security Issues**
 172
 173 Location: msb-apigateway
 174
 175 Artifact: bootstrap CVE-2018-14041
 176
 177 Problem Code: CVE-2018-14041
 178
 179 Plan: the bug has been fixed in upstream project, but not included in its latest release yet, it will be updated once the upstream project release the new version.
 180
 181 **Upgrade Notes**
 182
 183 N/A
 184
 185 **Deprecation Notes**
 186
 187 N/A
 188
 189 **Other**
 190
 191 N/A
 192
 193 ===========
 194
 195 End of Release Notes
 196 ===========
 197
 198 End of Release Notes