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
  13 The project's goal was to provide a placeholder for various sample VNF
  14 (Virtual Network Function (:term:`VNF`)) development which includes example
  15 reference architecture and optimization methods related to VNF/Network service
  16 for high performance VNFs.
  17 Today, we only maintain PROX and rapid scripts as part of this project
  18 to perform Network Function Virtualization Infrastructure
  19 (:term:`NFVI`) characterization.
  20
  21 *SampleVNF* is used in OPNFV for characterization of NFVI.
  22
  23
  24 About This Document
  25 ===================
  26
  27 This document consists of the following chapters:
  28
  29 * Chapter :doc:`01-introduction` provides a brief introduction to *SampleVNF*
  30   project's background and describes the structure of this document.
  31
  32 * Chapter :doc:`02-methodology` describes the methodology implemented by the
  33   *SampleVNF* Project for :term:`NFVI` verification.
  34
  35 * Chapter :doc:`03-installation` provides instructions to install *SampleVNF*.
  36
  37 * Chapter :doc:`04-running_the_test` shows how to run the dataplane testing.