Versions Compared

Old Version 2

changes.mady.by.user Seshu Kumar Mudiganti

Saved on

compared with

New Version 3

changes.mady.by.user Seshu Kumar Mudiganti

Saved on

Key

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


Table of Contents
outlinetrue
Overview

Draft version to be updated further, work in progress...

Project NameEnter the name of the project
Target Release Name
Amsterdam
Beijing
Project Lifecycle State
Incubation
Planning
Participating Company Amdocs, AT&T, ZTE, Huawei, China Mobile,
CMCC
Boco, Orange,
Nokia, IBM,Gigaspaces, Ericsson, VMWare, ZTE, Amdocs
Intel

Scope

What is this release trying to address?

The SO provides the highest level of service orchestration in the ONAP architecture.  

Functionality for Release 1:

  • Enhance ONAP SO run-time orchestration framework to support orchestration driven from declarative models (TOSCA encoded).
  • Perform lifecycle operations based on a declarative TOSCA model, including: 
    1. Deployment
    2. Undeployment
    3. Scale (Out, In) (Stretch goal)
    4. Heal (Stretch goal)
    5. Software Upgrade (various forms - Stretch goal)

Use Cases

...

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

2. New requirements:

a. **TBD**

Use Cases

SDC will contribute to support:

Use Case: Residential Broadband vCPE (Approved)

Use Case: VoLTE(approved)

SDC will continue to support:

Use Case: vFW/vDNS (Approved)

Use Case: Residential Broadband vCPE (Approved

...

)

Use Case: VoLTE(approved)

Minimum Viable Product

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

...

List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In  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
serverONAP JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=so and issuetype in (epic) and fixVersion = "Beijing Release"
serverId425b2b0a-557c-3c0c-b515-579789cceedb

Stories

Jira
serverONAP JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=so and issuetype in (story) and fixVersion = "Beijing Release"
serverId425b2b0a-557c-3c0c-b515-579789cceedb

Longer term roadmap

Indicate at a high level the longer term roadmap. This is to put things into the big perspective.

  1. Support more life cycle management operations
  2. Support distributed component Deployment

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 Description
Source CodeSource Code of Service OrchestrationAPI ListThe Specification of the Service Orchestration APIs.Docker Image
Deliverable 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

Docker Image(executable) of Service Orchestration

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

ONAP Dependencies

  • SDC (true dependency with SDC SDK)

  • AAI (using API interface)

  • SDN-C (using API interface)

  • APP-C (no existing interface yet)

  • DMaaP (included as part of SDC SDK)

  • MSB (no existing interface yet)

  • VF-C (no existing interface yet)

  • Multi-VIM(no existing interface yet - Need to check for direct dependency)
  • Logging Enhancements Project (Not a major dependency)

Architecture

High level architecture diagram

Image Removed

Proposal 1

Image Removed

Proposal 2 

Image Removed

Current seed code architecture, we will try to keep this intact based on he support from other components

Image Removed/

...

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)


  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability0

1

(stretch goal - 2)


  • 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 goal - 2)



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


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


  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability0

1

(stretch goal - 2)


  • 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 – 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)
SDCAPIs for distribute service modelsA&AIAPIs for inventory dataSDN-CAPIs for network controllerAPP-CAPIs for application controllerVF-CAPIs for Network ServiceMulti-VIMAPIs for Multi-VIM
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description

API Outgoing Dependencies

API this release is delivering to other releases.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Create service instanceCreate a service instanceDelete service instanceDelete a service instanceCreate vnf instanceCreate vnf instanceDelete vnf instanceDelete vnf instanceCreate vf module instanceCreate vf module instanceDelete vf module instanceDelete vf module instanceCreate volume group instanceCreate volume group instanceDelete volume group instanceDelete volume group instanceCreate network instanceCreate network instanceDelete network instanceDelete network instanceGet orchestration requestsGet orchestration requests
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description
Get a specific orchestration requestGet a specific orchestration requestCreate E2E serviceCreate E2E serviceDelete E2E serviceDelete E2E serviceQuery progress statusQuery progress status

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

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

...

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 tests are run automatically as part of every code merge.
    CSIT will be covered when it is launched by integration team.

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
serverONAP 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)
serverId425b2b0a-557c-3c0c-b515-579789cceedb

...

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 Plan
conclusion on decision on VFC vs APPC under discussion in arch. committeeRequested for a quicker closure of the issue by extending the discussion time (if required).Going ahead with the sprint planning with the assumption of supporting both flows
To fill outTo fill outTo fill out

Resources

Fill out the Resources Committed to the Release centralized  centralized page.

Resources and Repositories

Release Milestone

The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.

...

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

...

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.