summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorahothan <ahothan@cisco.com>2018-04-25 10:51:40 -0700
committerahothan <ahothan@cisco.com>2018-04-25 10:51:40 -0700
commite48023137b7010e9e1640649ea2859009a362939 (patch)
treeb4ade286684c7356977bb2e62cb39b954abe3472 /README.rst
parenteff9ff971acf5c7208ab2b824b897d3183c36f3c (diff)
Update doc1.4.1
Change-Id: I71bcf634033c78866d6808a4604b33629710ec23 Signed-off-by: ahothan <ahothan@cisco.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 0a9295d..0ed92c8 100644
--- a/README.rst
+++ b/README.rst
@@ -1,14 +1,27 @@
NFVbench: A Network Performance Benchmarking Tool for NFVi Full Stacks
**********************************************************************
-The NFVbench tool provides an automated way to measure the network performance for the most common data plane packet flows on any OpenStack based NFVi system viewed as a black box (NFVi Full Stack).
+The NFVbench tool provides an automated way to measure the network performance for the most common data plane packet flows
+on any NFVi system viewed as a black box (NFVi Full Stack).
An NFVi full stack exposes the following interfaces:
-- an OpenStack API
+- an OpenStack API for those NFVi platforms based on OpenStack
- an interface to send and receive packets on the data plane (typically through top of rack switches)
-The NFVi full stack does not have to be supported by the OPNFV ecosystem and can be any functional OpenStack system that provides the aboce interfaces. NFVbench can be installed standalone (in the form of a single Docker container) and is fully functional without the need to install any other OPNFV framework.
+The NFVi full stack does not have to be supported by the OPNFV ecosystem and can be any functional OpenStack system that provides
+the above interfaces.
+NFVbench can also be used without OpenStack on any bare system that can handle L2 forwarding or L3 routing.
-It is designed to be easy to install and easy to use by non experts (no need to be an expert in traffic generators and data plane performance testing).
+NFVbench can be installed standalone (in the form of a single Docker container) and is fully functional without
+the need to install any other OPNFV framework.
+
+It is designed to be easy to install and easy to use by non experts (no need to be an expert in traffic generators and data plane
+performance benchmarking).
+
+Online Documentation
+--------------------
+The latest version of the NFVbench documentation is available online at:
+
+http://docs.opnfv.org/en/latest/submodules/nfvbench/docs/testing/user/userguide/index.html
Contact Information
@@ -16,4 +29,3 @@ Contact Information
Inquiries and questions: send an email to opnfv-tech-discuss@lists.opnfv.org with a Subject line starting with "[nfvbench]".
Open issues or submit an issue or enhancement request: https://jira.opnfv.org/projects/NFVBENCH/issues (this requires an OPNFV Linux Foundation login).
-