summaryrefslogtreecommitdiffstats
path: root/docs/development/overview
diff options
context:
space:
mode:
authorahothan <ahothan@cisco.com>2017-10-18 10:43:09 -0700
committerahothan <ahothan@cisco.com>2017-10-18 10:53:54 -0700
commit9b4428f37e07e400e978a5e1681d0391cf7512ec (patch)
tree0a09bb4d6cd77a6c88edc4dc71f3f33541fdbab3 /docs/development/overview
parent8fca5f93109dfb317b14e6ed41298497504bce39 (diff)
Add dev section to doc1.1.0
Change-Id: I1e8d4a3fa6be7305c89fbc28b31377ec0f9d51a2 Signed-off-by: ahothan <ahothan@cisco.com>
Diffstat (limited to 'docs/development/overview')
-rw-r--r--docs/development/overview/overview.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/development/overview/overview.rst b/docs/development/overview/overview.rst
index 2b86da3..792d50f 100644
--- a/docs/development/overview/overview.rst
+++ b/docs/development/overview/overview.rst
@@ -9,5 +9,18 @@
Introduction
----------------
-Describing the components and behaviours in a manner that helps people understand the platform and how to work with it
+NFVbench is a python application that is designed to run in a compact and portable format inside a container and on production pods.
+As such it only uses open sourec software with minimal hardware requirements (just a NIC card that is DPDK compatible).
+Traffic generation is handled by TRex on 2 physical ports (2x10G or higher) forming traffic loops up to VNF level and following
+a path that is common to all NFV applications: external source to top of rack switch(es) to conpute node(s) to vswitch (if applicable)
+to VNF(s) and back.
+Configuration of benchmarks is through a hierarchy of yaml configuraton files and command line arguments.
+
+Results are available in different formats:
+- text output with tabular results
+- json result in file or in REST reply (most detailed)
+
+Logging is available in a log file.
+
+Benchmark results and logs can be optionally sent to one or more remote fluentd aggeregators using json format.