Update 2.0 doc

[nfvbench.git] / docs / development / design / design.rst

diff --git a/docs/development/design/design.rst b/docs/development/design/design.rst
index 6de6007..75b90f8 100644 (file)
--- a/docs/development/design/design.rst
+++ b/docs/development/design/design.rst
@@ -15,9 +15,11 @@ Introduction
 
 NFVbench can be decomposed in the following components:
 - Configuration
-- Staging
-- Traffic generation
-- Traffic generator results analysis
+- Orchestration:
+
+  - Staging
+  - Traffic generation
+  - Results analysis
 
 Configuration
 -------------
@@ -34,7 +36,7 @@ User configuration can come from:
 - custom platform pluging
 
 The precedence order for configuration is (from highest precedence to lowest precedence)
-- CLI confguration or REST configuration
+- CLI configuration or REST configuration
 - custom platform plugin
 - default configuration
 
@@ -43,6 +45,11 @@ with default platform options which can be either hardcoded or calculated at run
 (such as platform deployment configuration files).
 A custom platform plugin class is a child of the parent class nfvbench.config_plugin.ConfigPlugin.
 
+Orchestration
+-------------
+Once the configuration is settled, benchmark orchestration is managed by the ChainRunner class (nfvbench.chain_runner.ChainRunner).
+The chain runner will take care of orchestrating the staging, traffic generation and results analysis.
+
 
 Staging
 -------
@@ -57,7 +64,7 @@ Traffic Generation
 The traffic generation component is in charge of contrilling the TRex traffic generator using its python API.
 It includes tasks such as:
 - traffic check end to end to make sure the packet path is clear in both directions before starting a benchmark
-- programming the Trex traffic flows based on requested parameters
+- programming the TRex traffic flows based on requested parameters
 - fixed rate control
 - NDR/PDR binary search