From 2ecb6a9310d26bf861ac97a1f4c1d264b50e6ef7 Mon Sep 17 00:00:00 2001 From: Luc Provoost Date: Mon, 23 Nov 2020 18:24:10 +0100 Subject: Jerma documentation rewrite First step in a rewrite of the sampleVNF documentation whcih is now focused on the TST009 testing using PROX and rapid. Change-Id: Id95cd44831ae7db518ccdf1d8da55890197d2fcb Signed-off-by: Luc Provoost --- docs/testing/user/userguide/01-introduction.rst | 31 ++++++++----------------- 1 file changed, 10 insertions(+), 21 deletions(-) (limited to 'docs/testing/user/userguide/01-introduction.rst') diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst index 10c0161f..c2d28d04 100755 --- a/docs/testing/user/userguide/01-introduction.rst +++ b/docs/testing/user/userguide/01-introduction.rst @@ -9,30 +9,22 @@ Introduction **Welcome to SampleVNF's documentation !** -.. _Pharos: https://wiki.opnfv.org/pharos +.. _Pharos: https://wiki.opnfv.org/display/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. +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. -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 on OPNFV infrastructure. -*SampleVNF* is used in OPNFV for characterization of NFVI/VNF on OPNFV infrastructure -and some of the OPNFV features. - -.. seealso:: Pharos_ for information on OPNFV community labs and this - Technical_Briefs_ for an overview of *SampleVNF* +.. seealso:: Pharos_ for information on OPNFV community labs About This Document @@ -44,12 +36,9 @@ 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*. + *SampleVNF* Project for :term:`NFVI` verification. -* Chapter :doc:`04-installation` provides instructions to install *SampleVNF*. +* Chapter :doc:`03-installation` provides instructions to install *SampleVNF*. * Chapter :doc:`05-How_to_run_SampleVNFs` provides example on how installing and running *SampleVNF*. -- cgit 1.2.3-korg