ARC VNFSDK Component Description - Montreal-R13

Owned by Chaker Al-Hakim
Last updated: Nov 01, 2023 by Byung-Woo Jun
2 min read
Page Status: PTL Updated for Montreal -  
Component Status: Approved
Last Reviewed on:

Certified by:

1. High Level Component Definition and Architectural Relationships 


The VNF SDK provides the functionality to create VNF and PNF packages, test VNF and VNF ONAP compliance and provides market place functionality to store VNF and PNF packages. It supports:


  • The ability to create a HEAT and ETSI compliant (SOL004,SOL001) based VNF&PNF packages in a csar format.

  • Test VNF and PNF packages for ONAP compliance.

  • Upload and download VNF pages to/from a marketplace

In addition VNF SDK is used outside of ONAP by the LFN compliance and verification functionality.

2. VNFSDK API definitions


VNFSDK provides the following interfaces:

Interface NameInterface Definition

 Interface Capabilities

API Spec (Swagger)
VNFSDKE-1

VNF Package Management Interface.
(Also called sdk-Md)

Provides the VNF SDK as commands and client side language bindings. Enables use of VNF SDK functions from graphical user interfaces, shell scripts, programs and command line interfaces

 A command interface for:
  • Building a VNF/PNF package
  • Validating a VNF/PNF package
  • Extracting a VNF/PNF package
  • Parsing a VNF/PNF package
  • Testing a VNF/PNF package (dry run install)
https://docs.onap.org/projects/onap-vnfsdk-model/en/latest/files/vnf-packaging-model-blueprint.html
VNFSDKE-2

Market Place GUI
(also called Sdk-Mp)

Provides the VNF SDK as commands and client side language bindings. Enables use of VNF SDK functions from graphical user interfaces, shell scripts, programs and command line interfaces

 A user interface for:

  • Upload/Re-upload VNF/PNF package
  •  Delete VNF/PNF package
  • Download VNF/PNF Package
  • Quiery individual VNF/PNF package
  • Quiery list of VNF/PNF packages
https://docs.onap.org/projects/onap-vnfsdk-model/en/latest/files/marketplace-overview.html
 VNFSDKE-3

Market Place
(also called Mp-API)

 Exposed by the NF Marketplace as a programmatic API. Enables use of NF marketplace functions from command and graphical user interfaces.

 VNFSKDE-3 provides the following capabilities

  • Upload/Re-upload VNF/PNF package
  •  Delete VNF/PNF package
  • Download VNF/PNF Package
  • Quiery individual VNF/PNF package
  • Quiery list of VNF/PNF packages
https://docs.onap.org/projects/onap-vnfsdk-model/en/latest/files/vnfsdk-apis.html
VNFSDKE4 

VNF Test Platform
(Also called Mp-Tf)

Exposed by the NF Marketplace as a programmatic API. Enables use of the NF Marketplace's PnP test framework for validation of uploaded VNF products.

 An interface to:

  • Retrieve the list of test cases
  •  Request the execution of a test case and get a result
VTP REST API v1

Note:   xxxI interface is a Component internal interface.  xxxxE interface is a component external interface

The current API documents can be found at:

VNFSDK consumes the following Interfaces:

Interface NamePurpose Reason For UseAPI Spec (Swagger)
N/AN/A


3. Component Description:

A more detailed figure and description of the component.

VNF Test Platform (VTP)

4. known system limitations

None known.  Note, VNF-SDK is a design time component.

5. Used Models

VNFSDK uses the following models:

  • VNF Package Model
  • PNF Package Model

6. System Deployment Architecture

VNFSDKconsists of 2 components deployed in one container:

  • VNF Test Platform
  • Marketplace


7. New Capabilities in this Release

This release, VNFSDK adds the following Capabilities:

  • Add release specific details in the CSAR validation test cases (example ONAP dublin, ONAP frankfurt, etc)

8. References

  1.  VNF  Package Tool: https://docs.onap.org/en/casablanca/submodules/vnfsdk/model.git/docs/files/pkgtool.html?highlight=VNFSDK
  2.  Marketplace API: https://docs.onap.org/en/casablanca/submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.html