MSB Release Planning
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Info
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki.
Use the Wiki to document the release plan. Don't provide PowerPoint.
Use as much diagrams and flow charts as you need, directly in the wiki, to convey your message.
- 1 Overview
- 2 Scope
- 3 Release Deliverables
- 4 Sub-Components
- 5 ONAP Dependencies
- 6 Architecture
- 7 Testing and Integration Plans
- 7.1 Gaps
- 8 Known Defects and Issues
- 9 Risks
- 10 Resources
- 11 Release Milestone
- 12 Team Internal Milestone
- 13 Documentation, Training
- 14 Other Information
Overview
Project Name | Enter the name of the project |
|---|---|
Target Release Name | Amsterdam |
Project Lifecycle State | Incubation |
Participating Company | AT&T, CMCC, IBM, Tech Mahindra, ZTE |
Scope
What is this release trying to address?
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 plugin service provider options like AAF to provide Authentication & Authorization for APIs. Microservices Platform also provides a service portal and service requests logging, tracing and monitoring mechanism, etc.
Use Cases
Service registration per service provider instances
Registration
Service instances are registered to the registry by proxy or themselves. The visible scope should be indicated as a parameter when register. If a service is only internal visible, the service information is only pulled by the internal gateway (aka router & load balancer) and used by other components inside the system, the interal services can't be accessed by external systems or front end(web client). If a service is visible to external system, the service information is pulled by the external gateway and can be accessed by external systems and front end (web client) with auth.
Discovery & Service Consuming
For internal service consumers(Components inside ONAP system, such as A&AI, SO, Controller, etc.)
Client side discovery and load balancing
Server side discovery and load balancing
For external service clients(OSS, BSS, Web client, etc.), access the service via external gateway
Service registration per service
The service may have its own load balancer built inside, for example, Kubernetes can create a load balancer for a service. In such case, only need to register the service LB node to MSB, and the service request from the consumer is routed to the service LB node.Registration
Discovery & Service Consuming
Note: Only show the client side discovery in this diagram for simplicity, it's also possible to use server side discovery by the internal gateway.
Centralized Authentication&Authorization via MSB plugin
MSB is a pluggable architecture, so it can provide centralized authentication & authorization for service request with plugin of auth service provider like AAF.
Minimum Viable Product
Service Registration & Discovery
Service API Gateway(External API Gateway)
Service Router(Internal API Gateway)
Stretch Goal: Integrate with OOM so OOM can register service endpoints to MSB after deploying and starting an ONAP component/service.
Stretch Goal: Integrate with AAF so MSB API Gateway can work with AAF to provide centralized authentication and authorization for ONAP platform.
Stretch Goal: Integrate with for discovery of Dmaap topics in addition to RESTful API’s.
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
Epics
Stories
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Provide a high performance, high availability microservice infrastructure layer for ONAP platform, including service registration&discovery, service API gateway and service governance.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
|---|---|
Service Discovery | Service Registry,Registration & Discovery |
API Gateway | Can be deployed as external API gateway or router(Internal API gateway) |
API documentation |
|
RESTful API Design Specification | Guideline for ONAP Restful API design |