4.1. Introduction¶
Welcome to SampleVNF’s documentation !
SampleVNF is an OPNFV Project.
The project’s goal is to provides a placeholder for various sample VNF (Virtual Network Function (VNF)) development which includes example reference architecture and optimization methods related to VNF/Network service for high performance VNFs. This project provides benefits to other OPNFV projects like Functest, Models, yardstick etc to perform real life use-case based testing and VNF/ Network Function Virtualization Infrastructure (NFVI) characterization for the same.
The Project’s scope to create a repository of sample VNFs to help VNF benchmarking and NFVI characterization with real world traffic and host a common development environment for developing the VNF using optimized libraries. Also, develop a test framework in yardstick to enable VNF/NFVI verification.
SampleVNF is used in OPNFV for characterization of NFVI/VNF on OPNFV infrastructure and some of the OPNFV features.
See also
Pharos for information on OPNFV community labs and this Technical_Briefs for an overview of SampleVNF
4.1.1. About This Document¶
This document consists of the following chapters:
- Chapter Introduction provides a brief introduction to SampleVNF project’s background and describes the structure of this document.
- Chapter Methodology describes the methodology implemented by the SampleVNF Project for VNF and NFVI verification.
- Chapter Architecture provides information on the software architecture of SampleVNF.
- Chapter SampleVNF Installation provides instructions to install SampleVNF.
- Chapter SampleVNF - How to run provides example on how installing and running SampleVNF.
- Chapter REST API provides info on how to run REST API SampleVNF.
- Chapter SampleVNF - Config files provides info SampleVNF configuration.
- Chapter CLI Command Reference provides info on CLI commands supported by SampleVNF
4.1.2. Contact SampleVNF¶
Feedback? Contact us