1 .. This work is licensed under a Creative Commons Attribution 4.0 International
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Intel Corporation and others.
10 **Welcome to SampleVNF's documentation !**
12 .. _Pharos: https://wiki.opnfv.org/display/pharos
13 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
15 SampleVNF_ is an OPNFV Project.
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.
25 *SampleVNF* is used in OPNFV for characterization of NFVI on OPNFV infrastructure.
27 .. seealso:: Pharos_ for information on OPNFV community labs
33 This document consists of the following chapters:
35 * Chapter :doc:`01-introduction` provides a brief introduction to *SampleVNF*
36 project's background and describes the structure of this document.
38 * Chapter :doc:`02-methodology` describes the methodology implemented by the
39 *SampleVNF* Project for :term:`NFVI` verification.
41 * Chapter :doc:`03-installation` provides instructions to install *SampleVNF*.
43 * Chapter :doc:`05-How_to_run_SampleVNFs` provides example on how installing and running *SampleVNF*.
45 * Chapter :doc:`06-How_to_use_REST_api` provides info on how to run REST API *SampleVNF*.
47 * Chapter :doc:`07-Config_files` provides info *SampleVNF* configuration.
49 * Chapter :doc:`08-CLI_Commands_Reference` provides info on CLI commands supported by *SampleVNF*
54 Feedback? `Contact us`_
56 .. _Contact us: opnfv-users@lists.opnfv.org