docs/testing/user/userguide/01-introduction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International
   2 .. License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) OPNFV, Intel Corporation and others.
   5
   6 ============
   7 Introduction
   8 ============
   9
  10 **Welcome to SampleVNF's documentation !**
  11
  12 .. _Pharos: https://wiki.opnfv.org/pharos
  13 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
  14 .. _Technical_Briefs: https://wiki.opnfv.org/display/SAM/Technical+Briefs+of+VNFs
  15
  16 SampleVNF_ is an OPNFV Project.
  17
  18 The project's goal is to provides a placeholder for various sample VNF
  19 (Virtual Network Function (:term:`VNF`)) development which includes example
  20 reference architecture and optimization methods related to VNF/Network service
  21 for high performance VNFs. This project provides benefits to other OPNFV
  22 projects like Functest, Models, yardstick etc to perform real life
  23 use-case based testing and VNF/NFVi characterization for the same.
  24
  25 The Project's scope to create a repository of sample VNFs to help VNF
  26 benchmarking and NFVi characterization with real world traffic and host a
  27 common development environment for developing the VNF using optimized libraries.
  28 Also, Develop a test framework in yardstick  to enable
  29 Virtual Network Function (:term:`VNF`) / Network Function Virtualization Infrastructure
  30 (:term:`NFVI`) verification.
  31
  32 *SampleVNF* is used in OPNFV for characterization of NFVi/VNF on OPNFV infrastructure
  33 and some of the OPNFV features.
  34
  35 .. seealso:: Pharos_ for information on OPNFV community labs and this
  36    Technical_Briefs_ for an overview of *SampleVNF*
  37
  38
  39 About This Document
  40 ===================
  41
  42 This document consists of the following chapters:
  43
  44 * Chapter :doc:`01-introduction` provides a brief introduction to *SampleVNF*
  45   project's background and describes the structure of this document.
  46
  47 * Chapter :doc:`02-methodology` describes the methodology implemented by the
  48   *SampleVNF* Project for :term:`VNF` and :term:`NFVI` verification.
  49
  50 * Chapter :doc:`03-architecture` provides information on the software architecture
  51   of *SampleVNF*.
  52
  53 * Chapter :doc:`04-installation` provides instructions to install *SampleVNF*.
  54
  55 * Chapter :doc:`05-How_to_run_SampleVNFs` provides example on how installing and running *SampleVNF*.
  56
  57 Contact SampleVNF
  58 =================
  59
  60 Feedback? `Contact us`_
  61
  62 .. _Contact us: opnfv-users@lists.opnfv.org