ARC MSB Component Description - Guilin (R7) Release (Copy)

Page Status: Copied from R6 - Mar, 22, 2020
Component Status: Pending PTL Updates and ArchCom Review

Last Reviewed on : Aug-18-2020

Certified by: @Former user (Deleted)



MSB (Micro Service Bus):

1 High Level Component Definition and Architectural Relationships 





The Microservice Bus function provides service registration, discovery and communication services for microservices as well as a gateway for internal & External communication for the services:

  • Register communication services

  • Discover communication services

  • Manage communication between microservices

OOM connects to MSB to register and update service information when it instantiates service endpoints. 

MSB and DMaaP are complementary. MSB provides the restful API service registration/discovery/routing/API gateway, which addresses the sync/rpc communication pattern in microservice architecture,  in contrast, DMaaP provides messages/file transfer, which mainly focused on the async communication pattern in microservices architecture. 

2. API definitions

MSB provides the following interfaces: (Question, is this one interface with 3 LCMs or one interface with these capabilities)

These are separate interfaces.

Interface Name

Interface Definition

 Interface Capabilities

API Spec (Swagger)

Interface Name

Interface Definition

 Interface Capabilities

API Spec (Swagger)

MSBE-1

Registration and Discovery interface 

The registration and discovery interface provides the following capabilities:

  • Register/Unregister a service

  • Discover a service 

Microservice Bus API Documentation#RegisterservicetotheMicroserviceBus

MSBE-2

Service Request Interfaces

Provides the capability to deliver and receive a service request and subsequent communication.|

MSB API gateway acts as a proxy between the client and the server, the client just sends the request to MSB API gateway IP+Port, MSB handles the service discovery and reliable communication with the backend service including load balancing, retries, circuit breaker, etc.

MSBE-3 

 MSB Admin Interface

Provides the ability to administer policy and routing for the service requests. 

It's a management UI for viewing or modifying registered services, you can find it at HTTPs://MSB_API_AGATEWAY_IP:80 on your running MSB instance.

Note:   xxxI interface is a Component internal interface.  xxxxE interface is a component external interface

The current API documents can be found at:

MSB consumes the following Interfaces:

Interface Name

Purpose Reason For Use

API Spec (Swagger)

Interface Name

Purpose Reason For Use

API Spec (Swagger)

N/A

N/A





3. Component Description:

Add link to read-the-docs description of the component

https://docs.onap.org/projects/onap-msb-apigateway/en/latest/index.html#master-index

4. known system limitations





MSB API gateway has been tested in this scenario:

  • Client(wrk) --> MSB API gateway --> Test service(Tomcat)

  • Test machine (client, msb and test service): 8 cpu Core, 8G memory

  • Network 10000M 

The test result is 50000 request per second.

5. Used Models

MSB uses the following models:

  • -



6. System Deployment Architecture

FFS

7. New Capabilities in this Release

This release, MSB adds the following Capabilities:

  • -

8. References

  1. Microservice Bus API Documentation