Skip to end of metadata
Go to start of metadata



Overview

Project NameVNFSDK
Target Release NameBeijing
Project Lifecycle StateIncubation
Participating Company Huawei, Intel, AT&T, Gigaspaces, China Mobile, Wind River, Orange, Amdocs, Nokia, ZTE, IBM, VMWare, Cisco, ARM

Scope

What is this release trying to address?

VNF SDK's mission is to simplify the process of developing and onboarding VNFs and expanding ONAP's VNF ecosystem. For Service Providers, VNFSDK will reduce the time and level of testing required to identify, select, and onboard a VNF.  For vendors, VNFSDK will reduce integration efforts by defining a standard for VNF packaging with widespread operator acceptance.  VNFSDK can be used in a validation/conformance testing program in the future.

The Beijing release will enhance existing functionality, introduce security, integrate with ONAP use-case flow and progress towards being carrier grade with high quality.

  1. Better integration with SDC for automatic onboarding
  2. Update pkgtools/marketplace to support VNF packaging model. Update VNF template to align with VNFD information model.
    1. add pkgtools to pypi
  3. Integrate VVP (ICE) tools to allow us to validate VNF packaging (not acceptance testing)
  4. Improve code quality & code coverage
  5. Improve security (S3P) (https, SOL004, possibly certificate validation)
  6. Align with VNF Requirements
  7. Experimental integration with OPNFV Dovetail test framework
  8. Begin work on functional testing (ONAP-lite test platform, test framework, specific tests)

Use Cases

  1. Integrate VVP (ICE) tools
  2. Standalone validation tool
  3. HPA

Minimum Viable Product

Describe the MVP for this release.

  1. Support the VNF packaging model & VNF Requirements defined in Amsterdam
  2. Enhance integration with SDC
  3. Integrate ICE tools
  4. 50% code coverage
  5. HPA

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 T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Stories

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh


Longer term roadmap

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

  • Support functional testing (requires ONAP-lite test framework)
  • Support VNF conformance/validation testing
  • Integrate with Dovetail test framework
  • Support VNF lifecycle tests

Release Deliverables

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

Deliverable NameDeliverable Description
Compliance ToolExecutable
ModelUML info model and TOSCA model
Packaging toolExecutable
Reference Repo/MarketplaceExecutable

API : Deliver API for external Project. The API will deliver such as uploading/downloading/Updating/etc functionality
Validation ToolsExecutable
Lifecycle Test Framework (future)Executable/Library
Function Test Framework (future)Executable/Library
VES Agentcode/libraries that can be included in VNFs

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

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

AreaActual LevelTargeted Level for current ReleaseHow, EvidencesComments
Performance00design-time component
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability11design-time component
  • 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
Resiliency11system run as-needed
  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)
Security01

increase test coverage to 50%.

Implement https and aspects of SOL-004

  • 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
Scalability00not a runtime component.  VNF SDK will be run as-needed in constrained environment.
  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability11
  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability11onap.readthedocs.io
  • 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.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
none



  • API Outgoing Dependencies

API this project is delivering to other projects.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Upload APIAPI for vendors to upload VNF packages to marketplaceM1M3API Documentation
Download APIAPI for downloading VNF Package from marketplaceM1M3API Documentation
Query VNF informationAPI to query information on VNFs uploaded to the marketplaceM1M3API 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

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.

We will enhance unit tests and CSIT tests for validation tools, packaging tools, and certification tools.

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

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
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 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.

  • 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

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.