VID R2 Release Planning

Owned by Ofir Sonsino
Last updated: Mar 26, 2018
5 min read

The content of this template is expected to be fill out for M1 Release Planning Milestone.


Overview

Project Name

Enter the name of the project

Project Name

Enter the name of the project

Target Release Name

Beijing Release

Project Lifecycle State

Incubation (Refer to ONAP Charter, section 3.3 Project Lifecycle for further information)

Participating Company 

AT&T, Amdocs, Nokia

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. Change management - support working without a scheduler component.

b. Scale out support

Use Cases

VID will contribute to the following use cases:

Use Case: VoLTE(approved)

VID will continue to support to the following use case:

Use Case: Residential Broadband vCPE (Approved)

Use Case: vFW/vDNS (Approved)



Minimum Viable Product

  • Read only "ONAP global role" permission for VID users

  • Specific role assignment for components instantiations 

  • Change management for selected work flows (Upgrade and Configuration)

  • PNF support

  • Tenant Isolation for test environments

  • Owning entity support



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

key summary type created updated due assignee reporter priority status resolution
Refresh

Stories

key summary type created updated due assignee reporter priority status resolution
Refresh



Longer term roadmap

  • Fully automated deployment of new VNFs without the need of manual intervention or configuration.

  • Support workflows for change management by using the SDC as a provider of workflows capabilities 

  • Dashboarding scheduled and ongoing change management

Release Deliverables

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

Deliverable Name

Deliverable Description

Deliverable Name

Deliverable Description

VID application

Executable, Docker

MariaDB

SQL database scheme

Release documentation

ReadTheDocs, ONAP WIKI pages

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

VID (Dashboard OA&M) is a run-time component as appear in the diagram:

VID dependencies diagram:

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

Area

Actual Level

Targeted Level for current Release

How, Evidences

Comments

Performance

0

1

Do benchmark

  • 0 -- none

  • 1 – baseline performance criteria identified and measured

  • 2 & 3 – performance improvement plans created & implemented

Stability

0

1

72 hours test

  • 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

Resiliency

1

2

Use Galera cluster

  • 0 – none

  • 1 – manual failure and recovery (< 30 minutes)

  • 2 – automated detection and recovery (single site)

  • 3 – automated detection and recovery (geo redundancy)

Security

0

1

Cover 50% with JUnits

  • 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

Scalability

0

1

Test single site horizontal

  • 0 – no ability to scale

  • 1 – single site horizontal scaling

  • 2 – geographic scaling

  • 3 – scaling across multiple ONAP instances

Manageability

1

0



  • 1 – single logging system across components; instantiation in < 1 hour

  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management

Usability

1

1

Update user guides

  • 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 agree 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 Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

/serviceInstances/v5/<service_instance_id>/configurations/<configuration_id>

SO API

TBD

TBD

Link toward the detailed API description

/serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/<request_type>

SO API

TBD

TBD



business/owning-entities

AAI API - get services by owning entity Id

TBD

TBD



business/projects

AAI API - get services by project names

TBD

TBD



network/pnfs/pnf/<pnf_id>

AAI API - get specific PNF

TBD

TBD



network/logical-links/logical-link/<link>

AAI API - get logical link

TBD

TBD



cloud-infrastructure/operational-environments

AAI API - get operational environments

TBD

TBD



  • API Outgoing Dependencies

API this project is delivering to other projects.

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

NA

NA

NA

NA

NA

  • 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

Name

Description

Version

Docker

 Docker container host

Latest one

MariaDB

SQL DB

10.1.11



  • 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 tests are run automatically as part of every code merge.

  • Once the final Docker image is compiled, it will be installed onto a Docker host and will be checked to ensure no errors occur during start-up.

  • Functional testing will occur to ensure that the use cases are functioning correctly.

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

Gaps identified

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.

key summary type created updated due assignee reporter priority status resolution
Refresh

  • 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

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.

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

Date

Project

Deliverable

Date

Project

Deliverable

To fill out

To fill out

To 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

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.