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/ Network Function Virtualization Infrastructure
  24 (:term:`NFVI`) characterization for the same.
  25
  26 The Project's scope to create a repository of sample VNFs to help VNF
  27 benchmarking and NFVI characterization with real world traffic and host a
  28 common development environment for developing the VNF using optimized libraries.
  29 Also, develop a test framework in yardstick  to enable VNF/NFVI verification.
  30
  31 *SampleVNF* is used in OPNFV for characterization of NFVI/VNF on OPNFV infrastructure
  32 and some of the OPNFV features.
  33
  34 .. seealso:: Pharos_ for information on OPNFV community labs and this
  35    Technical_Briefs_ for an overview of *SampleVNF*
  36
  37
  38 About This Document
  39 ===================
  40
  41 This document consists of the following chapters:
  42
  43 * Chapter :doc:`01-introduction` provides a brief introduction to *SampleVNF*
  44   project's background and describes the structure of this document.
  45
  46 * Chapter :doc:`02-methodology` describes the methodology implemented by the
  47   *SampleVNF* Project for :term:`VNF` and :term:`NFVI` verification.
  48
  49 * Chapter :doc:`03-architecture` provides information on the software architecture
  50   of *SampleVNF*.
  51
  52 * Chapter :doc:`04-installation` provides instructions to install *SampleVNF*.
  53
  54 * Chapter :doc:`05-How_to_run_SampleVNFs` provides example on how installing and running *SampleVNF*.
  55
  56 * Chapter :doc:`06-How_to_use_REST_api` provides info on how to run REST API *SampleVNF*.
  57
  58 * Chapter :doc:`07-Config_files` provides info *SampleVNF* configuration.
  59
  60 * Chapter :doc:`08-CLI_Commands_Reference` provides info on CLI commands supported by *SampleVNF*
  61
  62 Contact SampleVNF
  63 =================
  64
  65 Feedback? `Contact us`_
  66
  67 .. _Contact us: opnfv-users@lists.opnfv.org