...
- to support all the use cases (as a common service)
- to provide access to new version of ONAP APIs via MSB
- to implement the S3P requirements
- to fix the issues reported by other projects and users
- to support service mesh efforts (limited resources)
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
As a common service project, MSB is the upstream of other projects to provide inter-service communication infrastructure, so it will be involved in the use cases indirectly.
Just list the use cases of VF-C and MultiCloud project which depends on MSB here , other use case will also be supported if msb involvement is needed.
Residential Broadband vCPE (Approved)
vFW/vDNS
vCPE
Functional Requirements:
Hardware Platform Enablement In ONAP
Centralized Representation and Consistent Identification of Cloud Regions In ONAP
Auto Scaling - stretch goal Release 4 (Dublin) Use Cases and functional requirements
Minimum Viable Product
Internal API Gateway: Service API gateway which serve as a transparent inter-service communication proxy to provide service discovery/routing/load balancing inside ONAP system.
External API Gateway: Service API Gateway which serve as an entrance to allow external system access to ONAP services.
Service Discovery: Provides service registration and discovery for ONAP microservices, which leverage Consul and builds an abstract layer on top of it to make it agnostic to the registration provider.
JAVA SDK: Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
- Swagger SD: Swagger SDK could be used to generate the server stub and client part in different language.
...
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Indicate where your project fit within the ONAP Archiecture diagram.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Anyone reading this section should have a good understanding of all the interacting modules.
MSB is part of the underlying platform to support onap microservice communication.
MSB consists of these sub-components:
- Registry Service information storage, MSB uses Consul as the service registry.
- MSB Discovery Provides REST APIs for service discovery and registration.
- API Gateway Provide service request routing, load balancing and service governance. It can be deployed as external Gateway or Internal Gateway.
- MSB SDK A Java SDK for point to point communication.
MSB works with OOM (Kube2msb Registrator) to provide transparent service registration for onap microservices.
- OOM deploy/start/stop ONAP components.
- Registrator watches the kubernetes event.
- Registrator reads the service definition from kubernetes deployment specs.
- Registrator sends service endpoints to MSB discovery when ONAP apps are deployed by OOM.
- Registrator registers service endpoint info to MSB. It also updates the service info to MSB when ONAP components are stopped/restarted/scaled by OOM
Platform Maturity
...
| Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments |
|---|---|---|---|---|
| Performance | 1 | 2 | Capture the baseline performance of API Gateway, such as QPS Latency Transfer/sec. |
|
| Stability | 1 | 2 | 72 hours soak test with random transactions from ONAP microservices via Internal API Gateway. |
|
| Resiliency | 2 | 2 | MSB integrates with OOM and leverage kubernetes to provide automated detection and recovery |
|
| Security | 01 | 1 | Reach the 50% Test Coverage, get CII Passing badge(now 98%). |
|
| Scalability | 1 | 1 | Provide cluster deployment for MSB components to achieve single site horizontal scaling. |
|
| Manageability | 1 | 1 | MSB provide access logging at API gateway. |
|
| Usability | 1 | 2 | Provide all the required documentation. |
|
...
API this project is delivering to other projects.
We don't expect mass API changes in Dublin, MSB APIs are already stable.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| Service Registration | RESTFul API for service registration with MSB. | 2019/01/24 | Release Planning#DublinReleaseCalendar | Microservice Bus API Documentation |
| Service Discovery | RESTFul API for service discovery with MSB. | 2019/01/24 | Release Planning#DublinReleaseCalendar | Microservice Bus API Documentation |
| JAVA SDK | JAVA SDK for service registration, discovery and inter-services communication. | 2019/01/24 | Release Planning#DublinReleaseCalendar | Microservice Bus API Documentation |
...
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| To fill out | To fill out | To fill out |
Resources
Fill out the Resources Committed to the Release centralized page.
Release Milestone
...
It is not expected to have a detailed project plan.
...
Documentation, Training
- Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
- Highlight the team contributions to the overall Release Documentation and training asset
- High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
- Documentation includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
...