docs/development/design/design.rst

   1
   2
   3 .. contents::
   4    :depth: 3
   5    :local:
   6
   7 .. This work is licensed under a Creative Commons Attribution 4.0 International
   8 .. License.
   9 .. http://creativecommons.org/licenses/by/4.0
  10 .. (c) Cisco Systems, Inc
  11
  12
  13 Introduction
  14 ------------
  15
  16 NFVbench can be decomposed in the following components:
  17 - Configuration
  18 - Orchestration:
  19
  20   - Staging
  21   - Traffic generation
  22   - Results analysis
  23
  24 Configuration
  25 -------------
  26 This component is in charge of getting the configuration options from the user and consolidate them with
  27 the default configuration into a running configuration.
  28
  29 default configuration + user configuration options = running configuration
  30
  31 User configuration can come from:
  32 - CLI configuration shortcut arguments (e.g --frame-size)
  33 - CLI configuration file (--config [file])
  34 - CLI configuration string (--config [string])
  35 - REST request body
  36 - custom platform pluging
  37
  38 The precedence order for configuration is (from highest precedence to lowest precedence)
  39 - CLI configuration or REST configuration
  40 - custom platform plugin
  41 - default configuration
  42
  43 The custom platform plugin is an optional python class that can be used to override default configuration options
  44 with default platform options which can be either hardcoded or calculated at runtime from platform specific sources
  45 (such as platform deployment configuration files).
  46 A custom platform plugin class is a child of the parent class nfvbench.config_plugin.ConfigPlugin.
  47
  48 Orchestration
  49 -------------
  50 Once the configuration is settled, benchmark orchestration is managed by the ChainRunner class (nfvbench.chain_runner.ChainRunner).
  51 The chain runner will take care of orchestrating the staging, traffic generation and results analysis.
  52
  53
  54 Staging
  55 -------
  56 The staging component is in charge of staging the OpenStack resources that are used for the requested packet path.
  57 For example, for a PVP packet path, this module will create 2 Neutron networks and one VM instance connected to these 2 networks.
  58 Multi-chaining and VM placement is also handled by this module.
  59
  60 Main class: nfvbench.chaining.ChainManager
  61
  62 Traffic Generation
  63 ------------------
  64 The traffic generation component is in charge of contrilling the TRex traffic generator using its python API.
  65 It includes tasks such as:
  66 - traffic check end to end to make sure the packet path is clear in both directions before starting a benchmark
  67 - programming the TRex traffic flows based on requested parameters
  68 - fixed rate control
  69 - NDR/PDR binary search
  70
  71 Main class: nfvbench.traffic_client.TrafficClient
  72
  73
  74 Traffic Generator Results Analysis
  75 ----------------------------------
  76 At the end of a traffic generation session, this component collects the results from TRex and packages them in a format that
  77 is suitable for the various output formats (JSON, REST, file, fluentd).
  78 In the case of multi-chaining, it handles aggregation of results across chains.
  79
  80 Main class: nfvbench.stats_manager.StatsManager