diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/platform/architecture.rst | 12 | ||||
| -rw-r--r-- | docs/release-notes.rst | 20 |
3 files changed, 27 insertions, 9 deletions
diff --git a/docs/index.rst b/docs/index.rst index a55f4dd..7c22467 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,9 @@ MSB(Microservices Bus) ------------------------------------------------ -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. +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. + +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. This document is aimed to give the users some brief introductions on MSB from different aspects. The users could find useful information, e.g. the architecuture, the APIs and the installation steps, etc. as well as the release notes of MSB in this document. diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst index de36415..d134f47 100644 --- a/docs/platform/architecture.rst +++ b/docs/platform/architecture.rst @@ -3,18 +3,20 @@ Architecture ------------ -MSB (Microservices Bus) provides a comprehensive, end to end solution to support ONAP microservice architecture including service registration/discovery, external gateway, internal gateway, client SDK. It's a pluggable architecture so it can integrate with Auth service provider to provide centralized Authentication & Authorization. MSB also provides a service portal to manage the REST APIs. +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. -MSB itself doesn’t depend on a specific environment. It can work in any bare metal, virtual machine or containerized environment. +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. -MSB mainly comprises of three parts: Discovery, API Gateway and MSB Client SDK. MSB also provides a swagger SDK which could generate swagger REST service description files. + + +MSB is mainly comprised of three parts: Discovery, API Gateway and MSB Client SDK. MSB also provide a swagger SDK which could generate swagger REST service description files.. .. image:: images/msb-architecture.png -Registry is the storage of service information, MSB leverages on the Consul as the service registry. +Registry is the storage of service information, MSB leverage Consul as the service registry. MSB Discovery provides REST APIs for service discovery and registration. -Service Gateway provides service request routing, load balancing and centralized Auth. It can be deployed as external Gateway or Internal Gateway. +API Gateway provides service request routing, load balancing and service governance. It can be deployed as external Gateway or Internal Gateway. MSB SDK is a client-side Java SDK which can be used for point to point communication of microservices. diff --git a/docs/release-notes.rst b/docs/release-notes.rst index ee913db..397f2e4 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,7 +5,9 @@ MSB Release Notes ================= -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. +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. + +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. Version: 1.1.0 -------------- @@ -14,11 +16,23 @@ Version: 1.1.0 **New Features** +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. +- `MSB-117 <https://jira.onap.org/browse/MSB-146>`_ Support horizontal scaling +- `MSB-140 <https://jira.onap.org/browse/MSB-140>`_ Providing HTTPS endpoint at API gateway +- `MSB-146 <https://jira.onap.org/browse/MSB-146>`_ Support service registration at K8s Pod level +- `MSB-152 <https://jira.onap.org/browse/MSB-152>`_ MSB JAVA SDK supports HTTPS service registration +- `MSB-156 <https://jira.onap.org/browse/MSB-156>`_ Support websocket request forwarding +- `MSB-178 <https://jira.onap.org/browse/MSB-178>`_ Support registering multiple versions under a service name +- `MSB-179 <https://jira.onap.org/browse/MSB-179>`_ Integration MSB GUI to Portal project **Bug Fixes** - -N/A +- `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service +- `MSB-102 <https://jira.onap.org/browse/MSB-102>`_ The msb client has heavy dependencies +- `MSB-150 <https://jira.onap.org/browse/MSB-150>`_ Kube2msb doesn't unregister service +- `MSB-153 <https://jira.onap.org/browse/MSB-153>`_ MSB kube2msb registrator does not register LoadBalancer type service +- `MSB-187 <https://jira.onap.org/browse/MSB-187>`_ MSB discovery API in swagger is not published +- `MSB-195 <https://jira.onap.org/browse/MSB-195>`_ HTTP protocol used over HTTPS port **Known Issues** |