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 Overview:
  18 ---------
  19
  20 This project provides a placeholder for various sample VNF (Virtual Network Function)
  21 development which includes example reference architecture and optimization methods
  22 related to VNF/Network service for high performance VNFs. This project provides
  23 benefits to other OPNFV projects like Functest, Models, yardstick etc to perform
  24 real life use-case based testing and NFVi characterization for the same.
  25
  26 The sample VNFs are Open Source approximations* of Telco grade VNF’s using optimized
  27 VNF + NFVi Infrastructure libraries, with Performance Characterization of Sample† Traffic Flows.
  28   * * Not a commercial product. Encourage the community to contribute and close the feature gaps.
  29   * † No Vendor/Proprietary Workloads
  30
  31 It helps to facilitate deterministic & repeatable bench-marking on
  32 Industry standard high volume Servers. It augments well with a Test Infrastructure
  33 to help facilitate consistent/repeatable methodologies for characterizing & validating
  34 the sample VNFs through OPEN SOURCE VNF approximations and test tools.
  35 The VNFs belongs to this project are never meant for field deployment.
  36 All the VNF source code part of this project requires Apache License Version 2.0.
  37
  38 Scope:
  39 -----
  40 The Scope of samplevnf project as follows"
  41 To create a repository of sample VNFs to help VNF benchmarking and NFVi
  42 characterization with real world traffic.
  43 Host a common development environment for developing the VNF using optimized libraries
  44 Integrate into CI tool chain and existing test frameworks for VNF feature and deployment testing
  45
  46 Testability:
  47 -----------
  48 Network Service Testing framework added into the Yardstick will be used as a test
  49 tool for Functional/Performance verification of all the sample VNFs.
  50 Planning to extend the same to FuncTest and Models project to include the testcases
  51 related to sample VNFs.