| Table of Contents | ||
|---|---|---|
|
Overview
...
- Provides RESTFul API for service registration/discovery
- Provides JAVA SDK for service registration and access, discovery and inter-services communication
- Provides a transparent service registration proxy with OOM-Kube2MSB
- Provides a transparent service communication proxy which handles service discovery, load balancing, routing, failure handling, and visibility by Internal API Gateway(Current implementation) and Mesh sidecar(WIP)
- Provides an External API Gateway to expose ONAP services to the outside world
...
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 | 0 | 1 | Capture the baseline performance of API Gateway, such as QPS Latency Transfer/sec. |
|
| Stability | 0 | 1 | 72 hours soak test with random transactions from ONAP microservices via Internal API Gateway. |
|
| Resiliency | 1 | 2 | MSB integrates with OOM and leverage kubernetes to provide automated detection and recovery |
|
| Security | 0 | 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 ingle site horizontal scaling. |
|
| Manageability | 1 | 1 | MSB provide access logging at API gateway. |
|
| Usability | 1 | 1 | Provide all the required documentation. |
|
API Incoming Dependencies
...
| 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. | 1/1/2018 | release API Freeze date | Microservice Bus API Documentation |
| Service Discovery | RESTFul API for service discovery with MSB. | 1/1/2018 | release API Freeze date | Microservice Bus API Documentation |
| JAVA SDK | JAVA SDK for service registration, discovery and inter-services communication. | 1/1/2018 | release API Freeze date | Microservice Bus API Documentation |
...
| 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 |
...
It is not expected to have a detailed project plan.
| Date | Project | Deliverable | To fill out | To fill out | To fill out|
|---|---|---|---|---|---|
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
- ...
...