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/display/pharos
  13 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
  14
  15 SampleVNF_ is an OPNFV Project.
  16
  17 The project's goal was to provide a placeholder for various sample VNF
  18 (Virtual Network Function (:term:`VNF`)) development which includes example
  19 reference architecture and optimization methods related to VNF/Network service
  20 for high performance VNFs.
  21 Today, we only maintain PROX and rapid scripts as part of this project
  22 to perform Network Function Virtualization Infrastructure
  23 (:term:`NFVI`) characterization.
  24
  25 *SampleVNF* is used in OPNFV for characterization of NFVI on OPNFV infrastructure.
  26
  27 .. seealso:: Pharos_ for information on OPNFV community labs
  28
  29
  30 About This Document
  31 ===================
  32
  33 This document consists of the following chapters:
  34
  35 * Chapter :doc:`01-introduction` provides a brief introduction to *SampleVNF*
  36   project's background and describes the structure of this document.
  37
  38 * Chapter :doc:`02-methodology` describes the methodology implemented by the
  39   *SampleVNF* Project for :term:`NFVI` verification.
  40
  41 * Chapter :doc:`03-installation` provides instructions to install *SampleVNF*.
  42
  43 * Chapter :doc:`05-How_to_run_SampleVNFs` provides example on how installing and running *SampleVNF*.
  44
  45 * Chapter :doc:`06-How_to_use_REST_api` provides info on how to run REST API *SampleVNF*.
  46
  47 * Chapter :doc:`07-Config_files` provides info *SampleVNF* configuration.
  48
  49 * Chapter :doc:`08-CLI_Commands_Reference` provides info on CLI commands supported by *SampleVNF*
  50
  51 Contact SampleVNF
  52 =================
  53
  54 Feedback? `Contact us`_
  55
  56 .. _Contact us: opnfv-users@lists.opnfv.org