Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Casablanca |
| Project Lifecycle State | Incubation |
| Participating Company | AT&T, CMCC, IBM, Tech Mahindra, ZTE |
Scope
What is this release trying to address?
MSB(Microservices Bus) provides key infrastructure functionalities to support ONAP Microservice Architecture(OMSA) in Amsterdam and Beijing. In Casablanca, MSB mainly focuses on the integration of Istio service mesh with ONAP to enhance OMSA, while keeping the Istio integration compatible with the existing MSB API Gateway approaches.
- Integrate Istio with ONAP to provide a reliable, secure and flexible service communication layer (service discovery/retries/circuit breaker/route rule/policy)
- Integrate with CNCF projects jaeger to provide distributed tracing Prometheus and Grafana for metrics collection and display
- Add MSB Portal to control plane to provide service catalog, swagger UI of Restful API, service mesh configuration, etc
Use Cases
MSB is an infrastructure project, it means that MSB supports every ONAP use case with no difference.
Minimum Viable Product
- Meet the planned Casablanca platform maturity(S3P) requirements
- Integrate Istio with at least one ONAP project to provide service-2-service communication, metrics collection and distributed tracing
- Integration MSB with Istio to make service communication via MSB API gateway compatible with service communication via Istio service mesh
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
- Run ONAP on top of Istio service mesh.
- Leverage Istio to achieve closed-loop operation for ONAP system itself.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| API Gateway | Service API gateway which 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. It can be deployed as external API gateway which is a transparent inter-service communication proxy or internal API gateway which exposes ONAP services to outside world. |
| 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 and add the needed extension. |
| JAVA SDK | Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc. |
| Swagger SDK | 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. |
| MSB Istio Agent | MSB Istio Agent watches MSB services registration changes and automatically creates Istio routing rules which rewrite the requests to MSB internal API gateway to the service destination. |
| Mesh Portal | A portal including mesh configuration, service catalog and API management. |
| Istio Installation glue scripts | Glue scripts for installation: Istio control plane, Istio data plane and service backends(jaeger, Prometheus, grafana, etc.) |
| Documentation | API documentation, tutorial and installation guide |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
Architecture
High level architecture diagram
This diagram shows how MSB project fits in the ONAP Architecture in a very high-level view.
If we take a closer look at ONAP Microservice Architecture, we get this diagram. The yellow blocks are currently in this project.
Please note that this diagram is a functional view of OMSA, which is not mapped to specific projects. So some of the blocks are currently implemented in this project, some of the blocks are implemented in other projects such as OOM and DMaaP, and other blocks may not exist yet, which need to be implemented or integrate with opensource projects to provide these functionalities. MSB will work with the related projects to provide all the OMSA functionalities to support a reliable, resilient and scalable ONAP Microservice Infrastructure.
MSB will provide service mesh as a transparent service communication layer which handles service discovery, load balancing, routing, failure handling, and visibility.
Platform Maturity
Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
| Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments |
|---|---|---|---|---|
| Performance | 1 | 1 | Capture the baseline performance of API Gateway, such as QPS Latency Transfer/sec. |
|
| Stability | 1 | 1 | 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 | 1 | 1 | Reach the 50% Test Coverage. It's unclear how to get CII Passing badge, will Investgate and figure out. |
|
| 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 | 1 | Provide all the required documentation. |
|
API Incoming Dependencies
List the API this project is expecting from other projects.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.
Prior to the delivery date, it is a good practice to organize an API review with the API consumers.
Note: MSB project has no incoming dependency.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
API Outgoing Dependencies
API this project is delivering to other projects.
Note: MSB project estimate that there will be no API modification during Casablanca release, we will continue to use the same APIs published in Beijing.
| 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. | 8/1/2018 | release API Freeze date | Microservice Bus API Documentation |
| Service Discovery | RESTFul API for service discovery with MSB. | 8/1/2018 | release API Freeze date | Microservice Bus API Documentation |
| JAVA SDK | JAVA SDK for service registration, discovery and inter-services communication. | 8/1/2018 | release API Freeze date | Microservice Bus API Documentation |
Third Party Products Dependencies
Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).
| Name | Description | Version |
|---|---|---|
| Consul | Consul is a distributed, highly-available, and multi-datacenter aware tool for service discovery, configuration, and orchestration. | 0.9.3 |
| OpenResty | OpenResty® is a full-fledged web platform that integrates the standard Nginx core, LuaJIT, many carefully written Lua libraries, lots of high quality 3rd-party Nginx modules, and most of their external dependencies. It is designed to help developers easily build scalable web applications, web services, and dynamic web gateways. | 1.11.2.3 |
| Redis | Redis is an in-memory data structure store, used as a database, cache and message broker. | 3.2.8 |
Testing and Integration Plans
Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.
Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.
- Unit test: the goal is 50% coverage for Casablanca Release.
- Functional test: Leverage the robot framework infrastructure to provide the functional test.
- Integration test: Support integration team to provide the end to end integration test.
- All the above should be automation tests run on the LF Jenkins Infrastructure.
Gaps
This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.
| Gaps identified | Impact |
|---|---|
| To fill out | To fill out |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
Risks
List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).
| 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
The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.
MSB project follows the ONAP Casablanca release milestones.
Team Internal Milestone
This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is recommended to provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
| Date | Project | Deliverable |
|---|---|---|
Documentation, Training
- Reach out to each project to help them to integrate with MSB, including tutorial, demonstration and code example.
- Provide introduction, guideline and API documentation in ONAP wiki.
- Populate release documentation content to http://onap.readthedocs.io includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
Note
The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.
Other Information
Vendor Neutral
All proprietary trademarks, logos, product names, etc. have been removed to comply with this rule and be agnostic of any proprietary symbols. If there is any new findings, the team promises to remove them ASAP.
Free and Open Source Software
FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.
Each project must edit its project table available at Project FOSS.
Charter Compliance
The project team comply with the ONAP Charter.