Versions Compared

Key

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

Draft copy for proposal

Table of Contents
outlinetrue
Overview

Project NameEnter the name of the project
Target Release NameBeijing
Project Lifecycle State
Planning
Incubation
Participating Company Amdocs, AT&T,
ZTE
China Mobile, Huawei,
China Mobile
 Intel,
Boco
Nokia, Orange,
Intel
 ZTE

Scope

What is this release trying to address?

1. Platform maturity - enhance stability, performance, security etc. to strive for carrier-grade maturity.

2. New requirements:

a. Make ONAP SO carrier grade

b. **TBD**

Use Cases

SDC will contribute to support:

Use Case: Residential Broadband vCPE (Approved)

Use Case: VoLTE(approved)

SDC will SO will continue to support:

Use Case: vFW/vDNS (Approved)

...

Use Case: VoLTE(approved)

Minimum Viable Product

  • Enhance ONAP SO run-time orchestration framework to support orchestration driven from declarative and imperative models.
  • Perform lifecycle operations based on a HEAT and TOSCA model, including: 
    1. Deployment
    2. Undeployment

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

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

Stories

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

Longer term roadmap

SO aims at providing model driven orchestration to be provided to ONAP users.

Release Deliverables

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.

Deliverable NameDeliverable DescriptionDeliverable Location
SO Docker ImagesExecutableDocker image available on nexus3
MariaDB Docker ImageExecutableDocker image available on nexus3
SO LibsJar filesAvailable on nexus
Deployment ScriptsChef recipes used to configure the Docker containers.

found on SO Git repositories

Sub-Components

List all sub-components part of this release. Activities related to sub-component 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

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

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

Performance0

0

(stretch goal - 1)

1

Need to work with the benchmarking project and define the critera
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability0

1

(stretch goal - 2)

1.The load should be defined with the consensus of the benchmarking project
2.Need to soak test the SO for 72 hours with the defined load

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

1

(

stretch

Stretch goal

-

2)



Have to incorporate the rollback flows for all the active workflows.

SO needs to check on component level resiliency.

  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)
Security0

1

(stretch goal - 2)

1.The current code coverage needs improvement from 29% to 50%
2.Improve the documentation (readthedocs) of the SO describing what the software does (what problem does it solve?).
3. use at least one automated test suite that is publicly released as FLOSS

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

0

(stretch goal - 1)

1

SO will have

  1. new APIs for manual and Auto scaling for platform enhancement
  2. at component level SO is identifying the ways to support scaling.
  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability0

1

1.SO should use the common logging for all its logs

(stretch goal - 2)

2.SO dockers (both MSO and MariaDB) should be instantiated within one hour

  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability0

1

(stretch goal - 2)

1.Improve SO user guide

2. Improve the API documentation
  • 1 – user guide; deployment documentation; API documentation
  • 2 – UI consistency; usability testing; tutorial documentation


API Incoming Dependencies

List the API this release is expecting from other releases. 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.

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
SDCAPIs for distribute service modelsDefined in AmsterdamDelivered in AmsterdamInterfaces Link
A&AIAPIs for inventory dataDefined in AmsterdamDelivered in AmsterdamInterfaces Link
SDN-CAPIs for network controllerDefined in AmsterdamDelivered in AmsterdamInterfaces Link
APP-CAPIs for application controllerDefined in AmsterdamDelivered in AmsterdamInterfaces Link
VF-CAPIs for Network ServiceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Multi-VIMAPIs for Multi-VIMDefined in AmsterdamDelivered in AmsterdamInterfaces Link

API Outgoing Dependencies

API this release is delivering to other releases.

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
Create service instanceCreate a service instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Delete service instanceDelete a service instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Create vnf instanceCreate vnf instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Delete vnf instanceDelete vnf instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Create vf module instanceCreate vf module instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Delete vf module instanceDelete vf module instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Create volume group instanceCreate volume group instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Delete volume group instanceDelete volume group instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Create network instanceCreate network instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Delete network instanceDelete network instanceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Get orchestration requestsGet orchestration requestsDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Get a specific orchestration requestGet a specific orchestration requestDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Create E2E serviceCreate E2E serviceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Delete E2E serviceDelete E2E serviceDefined in AmsterdamDelivered in AmsterdamInterfaces Link
Query progress statusQuery progress statusDefined in AmsterdamDelivered in AmsterdamInterfaces Link

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
CamundaAn open source platform for workflow and business process management

ARIA

Tosca parser and TOSCA workflow engine

JBOSS

An open source application server program

MariaDB

One of the most popular open source database server

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

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.

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 identifiedImpact
To fill outTo fill out

Known Defects and Issues

Provide a link toward the list of all known project bugs.

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

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 identifiedMitigation PlanContingency
PlanTo fill outTo fill outTo fill out

1. Resources for functional requirement as was committed during discussion.

2.code is planned to be migrated from 1806 economy does not break anything major.( Low risk)

1. Need to decide on the on boarding by M2.

2. Att is ready to provide the required help to resolve issues.

1. M2 will rule out the functional requirement which don't keep up these needs.

2. Need to recheck on the s3p goals.

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.

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 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 items such as:
    • Installation instructions
    • Configuration instructions
    • Developer guide
    • End User guide
    • Admin guide
    • ...
Note
titleNote

The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.

Other Information

Vendor Neutral

If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.

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.

Release Key Facts

Fill out and provide a link toward the centralized Release Artifacts.