nfvbenchvm: fix image URL in build log
[nfvbench.git] / docs / development / overview / overview.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International
2 .. License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) Cisco Systems, Inc
5
6 .. contents::
7    :depth: 3
8    :local:
9
10 Introduction
11 ----------------
12 NFVbench is a python application that is designed to run in a compact and portable format inside a container and on production pods.
13 As such it only uses open sourec software with minimal hardware requirements (just a NIC card that is DPDK compatible).
14 Traffic generation is handled by TRex on 2 physical ports (2x10G or higher) forming traffic loops up to VNF level and following
15 a path that is common to all NFV applications: external source to top of rack switch(es) to compute node(s) to vswitch (if applicable)
16 to VNF(s) and back.
17
18 Configuration of benchmarks is through a yaml configuraton file and command line arguments.
19
20 Results are available in different formats:
21 - text output with tabular results
22 - json result in file or in REST reply (most detailed)
23
24 Logging is available in a log file.
25
26 Benchmark results and logs can be optionally sent to one or more remote fluentd aggeregators using json format.