diff options
Diffstat (limited to 'docs/testing/user/userguide/01-introduction.rst')
| -rw-r--r--[-rwxr-xr-x] | docs/testing/user/userguide/01-introduction.rst | 48 |
1 files changed, 9 insertions, 39 deletions
diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst index 10c0161f..4ddde201 100755..100644 --- a/docs/testing/user/userguide/01-introduction.rst +++ b/docs/testing/user/userguide/01-introduction.rst @@ -9,30 +9,16 @@ Introduction **Welcome to SampleVNF's documentation !** -.. _Pharos: https://wiki.opnfv.org/pharos -.. _SampleVNF: https://wiki.opnfv.org/samplevnf -.. _Technical_Briefs: https://wiki.opnfv.org/display/SAM/Technical+Briefs+of+VNFs -SampleVNF_ is an OPNFV Project. - -The project's goal is to provides a placeholder for various sample VNF +The project's goal was to provide a placeholder for various sample VNF (Virtual Network Function (:term:`VNF`)) development which includes example reference architecture and optimization methods related to VNF/Network service -for high performance VNFs. This project provides benefits to other OPNFV -projects like Functest, Models, yardstick etc to perform real life -use-case based testing and VNF/ Network Function Virtualization Infrastructure -(:term:`NFVI`) characterization for the same. - -The Project's scope to create a repository of sample VNFs to help VNF -benchmarking and NFVI characterization with real world traffic and host a -common development environment for developing the VNF using optimized libraries. -Also, develop a test framework in yardstick to enable VNF/NFVI verification. - -*SampleVNF* is used in OPNFV for characterization of NFVI/VNF on OPNFV infrastructure -and some of the OPNFV features. +for high performance VNFs. +Today, we only maintain PROX and rapid scripts as part of this project +to perform Network Function Virtualization Infrastructure +(:term:`NFVI`) characterization. -.. seealso:: Pharos_ for information on OPNFV community labs and this - Technical_Briefs_ for an overview of *SampleVNF* +*SampleVNF* is used in OPNFV for characterization of NFVI. About This Document @@ -44,24 +30,8 @@ This document consists of the following chapters: project's background and describes the structure of this document. * Chapter :doc:`02-methodology` describes the methodology implemented by the - *SampleVNF* Project for :term:`VNF` and :term:`NFVI` verification. - -* Chapter :doc:`03-architecture` provides information on the software architecture - of *SampleVNF*. - -* Chapter :doc:`04-installation` provides instructions to install *SampleVNF*. - -* Chapter :doc:`05-How_to_run_SampleVNFs` provides example on how installing and running *SampleVNF*. - -* Chapter :doc:`06-How_to_use_REST_api` provides info on how to run REST API *SampleVNF*. - -* Chapter :doc:`07-Config_files` provides info *SampleVNF* configuration. - -* Chapter :doc:`08-CLI_Commands_Reference` provides info on CLI commands supported by *SampleVNF* - -Contact SampleVNF -================= + *SampleVNF* Project for :term:`NFVI` verification. -Feedback? `Contact us`_ +* Chapter :doc:`03-installation` provides instructions to install *SampleVNF*. -.. _Contact us: opnfv-users@lists.opnfv.org +* Chapter :doc:`04-running_the_test` shows how to run the dataplane testing. |