Merge "Fix cosmetic wording"
[msb/apigateway.git] / 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 provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management.
9
10
11 Version: 1.0.0
12 --------------
13
14 :Release Date: 2017-11-16
15
16
17 **New Features**
18 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.
19
20 The current release of MSB is mainly composed of the following components:
21
22 **msb/apigateway**
23
24 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.
25
26 **msb/discovery**
27
28 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.
29  
30 **msb/java-sdk**
31
32 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
33
34 **msb/swagger-sdk**
35
36 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.
37
38 In the future release, MSB plans to provide service mesh for ONAP.
39
40 **Bug Fixes**
41
42 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
43 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
44 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
45 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
46 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
47 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
48 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
49 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
50 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
51 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
52 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
53 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed 
54 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
55 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
56 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
57 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
58 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
59 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
60 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed 
61 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
62 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed 
63 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
64
65 **Known Issues**
66
67 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
68
69 **Security Issues**
70
71 None
72
73 **Upgrade Notes**
74
75 This is an initial release
76
77 **Deprecation Notes**
78
79 N/A
80
81 **Other**
82
83 N/A
84
85 ===========
86
87 End of Release Notes