docs/testing/developer/design/01-Overview.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) OPNFV, Intel Corporation and others.
   4
   5 .. OPNFV SAMPLEVNF Documentation design file.
   6
   7 ============
   8 Introduction
   9 ============
  10
  11 **Welcome to SampleVNF's developer getstarted documentation !**
  12
  13 .. _Pharos: https://wiki.opnfv.org/pharos
  14 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
  15 .. _Technical_Briefs: https://wiki.opnfv.org/display/SAM/Technical+Briefs+of+VNFs
  16
  17
  18 Overview
  19 ---------
  20
  21 This project provides a placeholder for various sample VNF (Virtual Network Function)
  22 development which includes example reference architecture and optimization methods
  23 related to VNF/Network service for high performance VNFs. This project provides
  24 benefits to other OPNFV projects like Functest, Models, yardstick etc to perform
  25 real life use-case based testing and NFVi characterization for the same.
  26
  27 The sample VNFs are Open Source approximations* of Telco grade VNF’s using
  28 optimized VNF + NFVi Infrastructure libraries, with Performance Characterization
  29 of Sample† Traffic Flows.
  30
  31 The purpose is to encourage the community to contribute and close the feature gaps.
  32
  33  ::
  34
  35    * Not a commercial product.
  36    † No Vendor/Proprietary Workloads
  37
  38
  39 It helps to facilitate deterministic & repeatable bench-marking on
  40 Industry standard high volume Servers. It augments well with a Test Infrastructure
  41 to help facilitate consistent/repeatable methodologies for characterizing & validating
  42 the sample VNFs through OPEN SOURCE VNF approximations and test tools.
  43 The VNFs belongs to this project are never meant for field deployment.
  44 All the VNF source code part of this project requires Apache License Version 2.0.
  45
  46 Scope
  47 -----
  48 The Scope of samplevnf project is to create a repository of sample VNFs
  49 to help VNF benchmarking and NFVi characterization with real world traffic.
  50
  51 Also to host a common development environment for developing the VNF using
  52 optimized libraries and integrate into CI tool chain and existing test
  53 frameworks for VNF feature and deployment testing.
  54
  55 About DPDK
  56 ----------
  57 The DPDK IP Pipeline Framework provides set of libraries to build a pipeline
  58 application.
  59
  60 This document assumes the reader possess the knowledge of DPDK concepts and IP
  61 Pipeline Framework. For more details, read DPDK Getting Started Guide, DPDK
  62 Programmers Guide, DPDK Sample Applications Guide.
  63
  64 Testability
  65 -----------
  66 Network Service Testing framework added into the Yardstick will be used as a test
  67 tool for Functional/Performance verification of all the sample VNFs.
  68 Planning to extend the same to FuncTest and Models project to include the testcases
  69 related to sample VNFs.