Versions Compared

Old Version 9

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table of Contents
outlinetrue

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

...

MSB is an infrastructure project, it means that MSB supports every ONAP use case with no difference.

Minimum Viable Product

  • Meet the platform maturityMeet the planned Beijing platform maturity(S3P) requirements
  • Help other projects integrate with MSB Reach out to help other projects integrate with MSB 

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.

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox msb and issuetype in (epic) and fixVersion = "Beijing Release"
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox msb and issuetype in (story) and fixVersion = "Beijing Release"
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...

Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.

...

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.

AreaActual LevelTargeted Level for current ReleaseHow, EvidencesComments
Performance01Capture the baseline performance of API Gateway, such as QPS Latency Transfer/sec.
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability0172 hours soak test with random transactions from ONAP microservices via Internal API Gateway.
  • 0 – none
  • 1 – 72 hours component level soak w/random transactions
  • 2 – 72 hours platform level soak w/random transactions
  • 3 – 6 months track record of reduced defect rate
Resiliency12MSB integrates with OOM and leverage kubernetes to provide automated detection and recovery
  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)
Security01Reach the 50% Test Coverage. It's unclear how to get CII Passing badge, will Investgate and figure out.
  • 0 – none
  • 1 – CII Passing badge + 50% Test Coverage
  • 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls
  • 3 – CII Gold
Scalability11Provide cluster deployment for MSB components to achieve ingle site horizontal scaling.
  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability11MSB provide access logging at API gateway.
  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability11Provide all the required documentation.
  • 1 – user guide; deployment documentation; API documentation
  • 2 – UI consistency; usability testing; tutorial 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.

Link toward the detailed API description
API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill out





  • API Outgoing Dependencies

API this project is delivering to other projects.

Note:  MSB project estimate that there will be no API modification during Beijing release, we will continue to use the same APIs published in Amsterdam.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description
Service RegistrationRESTFul API for service registration with MSB.1/1/2018release API Freeze dateMicroservice Bus API Documentation
Service DiscoveryRESTFul API for service discovery with MSB.1/1/2018release API Freeze dateMicroservice Bus API Documentation
JAVA SDKJAVA SDK for service registration, discovery and inter-services communication.1/1/2018release API Freeze dateMicroservice 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, ...).

NameDescriptionVersion
To fill outTo fill outTo fill out

...

ConsulConsul is a distributed, highly-available, and multi-datacenter aware tool for service discovery, configuration, and orchestration. 0.9.3
OpenRestyOpenResty® 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
RedisRedis is an in-memory data structure store, used as a database, cache and message broker.3.2.8


  • Testing and Integration Plans

...

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.

  1. Unit test: the goal is 50% coverage for Amsterdam Release.
  2. Functional test: Leverage the robot framework infrastructure to provide the functional test.
  3. Integration test: Support integration team to provide the end to end integration test.
  4. 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.

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox MSB and issuetype in (bug) and fixVersion = "Beijing Release"
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...

Risk identifiedMitigation PlanContingency Plan
To fill outTo fill outTo 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 Beijing 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 erecommended recommended to provide these agreements and dates in this section.

It is not expected to have a detailed project plan.

DateProjectDeliverable
To fill outTo fill outTo fill out



  • 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 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
    • ...

...


Other Information

  • Vendor Neutral

If this project is coming from an existing proprietary codebase, ensure that all proprietary All proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must 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

...