summaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/design/01-Overview.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/testing/developer/design/01-Overview.rst')
-rw-r--r--docs/testing/developer/design/01-Overview.rst42
1 files changed, 30 insertions, 12 deletions
diff --git a/docs/testing/developer/design/01-Overview.rst b/docs/testing/developer/design/01-Overview.rst
index a1ae66af..5cd22bb1 100644
--- a/docs/testing/developer/design/01-Overview.rst
+++ b/docs/testing/developer/design/01-Overview.rst
@@ -14,7 +14,8 @@ Introduction
.. _SampleVNF: https://wiki.opnfv.org/samplevnf
.. _Technical_Briefs: https://wiki.opnfv.org/display/SAM/Technical+Briefs+of+VNFs
-Overview:
+
+Overview
---------
This project provides a placeholder for various sample VNF (Virtual Network Function)
@@ -23,10 +24,17 @@ 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 NFVi characterization for the same.
-The sample VNFs are Open Source approximations* of Telco grade VNF’s using optimized
-VNF + NFVi Infrastructure libraries, with Performance Characterization of Sample† Traffic Flows.
- * * Not a commercial product. Encourage the community to contribute and close the feature gaps.
- * † No Vendor/Proprietary Workloads
+The sample VNFs are Open Source approximations* of Telco grade VNF’s using
+optimized VNF + NFVi Infrastructure libraries, with Performance Characterization
+of Sample† Traffic Flows.
+
+The purpose is to encourage the community to contribute and close the feature gaps.
+
+ ::
+
+ * Not a commercial product.
+ † No Vendor/Proprietary Workloads
+
It helps to facilitate deterministic & repeatable bench-marking on
Industry standard high volume Servers. It augments well with a Test Infrastructure
@@ -35,15 +43,25 @@ the sample VNFs through OPEN SOURCE VNF approximations and test tools.
The VNFs belongs to this project are never meant for field deployment.
All the VNF source code part of this project requires Apache License Version 2.0.
-Scope:
+Scope
-----
-The Scope of samplevnf project as follows"
-To create a repository of sample VNFs to help VNF benchmarking and NFVi
-characterization with real world traffic.
-Host a common development environment for developing the VNF using optimized libraries
-Integrate into CI tool chain and existing test frameworks for VNF feature and deployment testing
+The Scope of samplevnf project is to create a repository of sample VNFs
+to help VNF benchmarking and NFVi characterization with real world traffic.
+
+Also to host a common development environment for developing the VNF using
+optimized libraries and integrate into CI tool chain and existing test
+frameworks for VNF feature and deployment testing.
+
+About DPDK
+----------
+The DPDK IP Pipeline Framework provides set of libraries to build a pipeline
+application.
+
+This document assumes the reader possess the knowledge of DPDK concepts and IP
+Pipeline Framework. For more details, read DPDK Getting Started Guide, DPDK
+Programmers Guide, DPDK Sample Applications Guide.
-Testability:
+Testability
-----------
Network Service Testing framework added into the Yardstick will be used as a test
tool for Functional/Performance verification of all the sample VNFs.