diff options
| author |   ahothan <ahothan@cisco.com> | 2017-07-28 17:08:46 -0700 |
|---|---|---|
| committer | ahothan <ahothan@cisco.com> | 2017-07-31 12:34:00 -0700 |
| commit | 04a7de082bd221eae3c7004f4e0b99dfa4f8be91 (patch) | |
| tree | c9fb7beaedc80479772ba24c3b47c85d49c22f76 /docs/testing/user/userguide | |
| parent | b8f02ed4e72399840a93aceb02b8c53831bbe68a (diff) | |
Initial code drop from Cisco1.0.0
Change-Id: Ie2993886dc8e95c5f73ccdb871add8b96ffcc849
Signed-off-by: ahothan <ahothan@cisco.com>
Diffstat (limited to 'docs/testing/user/userguide')
19 files changed, 2669 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/_static/custom.css b/docs/testing/user/userguide/_static/custom.css new file mode 100644 index 0000000..6cbfde3 --- /dev/null +++ b/docs/testing/user/userguide/_static/custom.css @@ -0,0 +1,4 @@ +.wy-nav-content { + max-width: 1200px !important; +} + diff --git a/docs/testing/user/userguide/_templates/layout.html b/docs/testing/user/userguide/_templates/layout.html new file mode 100644 index 0000000..f3387d5 --- /dev/null +++ b/docs/testing/user/userguide/_templates/layout.html @@ -0,0 +1,5 @@ +{% extends "!layout.html" %} +{% block extrahead %} + <link href="{{ pathto("_static/custom.css", True) }}" rel="stylesheet" type="text/css"> +{% endblock %} + diff --git a/docs/testing/user/userguide/advanced.rst b/docs/testing/user/userguide/advanced.rst new file mode 100644 index 0000000..f757b46 --- /dev/null +++ b/docs/testing/user/userguide/advanced.rst @@ -0,0 +1,318 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +============== +Advanced Usage +============== + +This section covers a few examples on how to run NFVbench with multiple different settings. +Below are shown the most common and useful use-cases and explained some fields from a default config file. + +How to change any NFVbench run configuration (CLI) +-------------------------------------------------- +NFVbench always starts with a default configuration which can further be partially refined (overridden) by the user from the CLI or from REST requests. + +At first have a look at the default config: + +.. code-block:: bash + + nfvbench --show-default-config + +It is sometimes useful derive your own configuration from a copy of the default config: + +.. code-block:: bash + + nfvbench --show-default-config > nfvbench.cfg + +At this point you can edit the copy by: + +- removing any parameter that is not to be changed (since NFVbench will always load the default configuration, default values are not needed) +- edit the parameters that are to be changed changed + +A run with the new confguration can then simply be requested using the -c option and by using the actual path of the configuration file +as seen from inside the container (in this example, we assume the current directory is mapped to /tmp/nfvbench in the container): + +.. code-block:: bash + + nfvbench -c /tmp/nfvbench/nfvbench.cfg + +The same -c option also accepts any valid yaml or json string to override certain parameters without having to create a configuration file. + +NFVbench also provides many configuration options as optional arguments. For example the number of flows can be specified using the --flow-count option. + +For example, flow count can be specified in any of 3 ways: + +- by providing a confguration file that has the flow_count value to use (-c myconfig.yaml and myconfig.yaml contains 'flow_count: 100k') +- by passing that yaml paremeter inline (-c "flow_count: 100k") or (-c "{flow_count: 100k}") +- by using the flow count optional argument (--flow-count 100k) + +Showing the running configuration +--------------------------------- + +Because configuration parameters can be overriden, it is sometimes useful to show the final configuration (after all oevrrides are done) by using the --show-config option. +This final configuration is also called the "running" configuration. + +For example, this will only display the running configuration (without actually running anything): + +.. code-block:: bash + + nfvbench -c "{flow_count: 100k, debug: true}" --show-config + + +Connectivity and Configuration Check +------------------------------------ + +NFVbench allows to test connectivity to devices used with selected flow test, for example PVP. +It runs the whole test, but without actually sending any traffic or influencing interface counters. +It is also a good way to check if everything is configured properly in the config file and what versions of components are used. + + +To verify everything works without sending any traffic, use the --no-traffic option: + +.. code-block:: bash + + nfvbench --no-traffic + +Used parameters: + +* ``--no-traffic`` or ``-0`` : sending traffic from traffic generator is skipped + + + +Fixed Rate Run +-------------- + +Fixed rate run is the most basic type of NFVbench usage. It is usually used to verify that some amount of packets can pass network components in selected flow. + +The first example shows how to run PVP flow (default flow) with multiple different settings: + +.. code-block:: bash + + nfvbench -c nfvbench.cfg --no-reset --no-cleanup --rate 100000pps --duration 30 --interval 15 --json results.json + +Used parameters: + +* ``-c nfvbench.cfg`` : path to the config file +* ``--no-cleanup`` : resources (networks, VMs, attached ports) are not deleted after test is finished +* ``--rate 100000pps`` : defines rate of packets sent by traffic generator +* ``--duration 30`` : specifies how long should traffic be running in seconds +* ``--interval 15`` : stats are checked and shown periodically (in seconds) in this interval when traffic is flowing +* ``--json results.json`` : collected data are stored in this file after run is finished + +.. note:: It is your responsibility to clean up resources if needed when ``--no-cleanup`` parameter is used. + +The ``--json`` parameter makes it easy to store NFVbench results. To display collected results in a table form, do: + +.. code-block:: bash + + nfvbench --show-summary results.json # or shortcut -ss results.json + + +Second example aims to show how to specify which supported flow to run: + +.. code-block:: bash + + nfvbench -c nfvbench.cfg --rate 1Mbps --inter-node --service-chain PVVP + +Used parameters: + +* ``-c nfvbench.cfg`` : path to the config file +* ``--rate 1Mbps`` : defines rate of packets sent by traffic generator +* ``--inter-node`` : VMs are created on different compute nodes, works only with PVVP flow +* ``--service-chain PVVP`` or ``-sc PVVP`` : specifies type of flow to use, default is PVP + +.. note:: When parameter ``--inter-node`` is not used or there aren't enough compute nodes, VMs are on the same compute node. + + +Rate Units +^^^^^^^^^^ + +Parameter ``--rate`` accepts different types of values: + +* packets per second (pps, kpps, mpps), e.g. ``1000pps`` or ``10kpps`` +* load percentage (%), e.g. ``50%`` +* bits per second (bps, kbps, Mbps, Gbps), e.g. ``1Gbps``, ``1000bps`` +* NDR/PDR (ndr, pdr, ndr_pdr), e.g. ``ndr_pdr`` + +The last mentioned value, NDR/PDR, is default one and its usage is covered more below. + + +NDR and PDR +----------- + +NDR and PDR test is used to determine performance of your setup, maximum packets throughput. + +* NDR (No Drop Rate): how many packets can be sent so (almost) none of them are dropped +* PDR (Partial Drop Rate): how many packets can be sent so drop rate is below given limit + +Config file contains section where settings for NDR/PDR can be set. +Increasing number of attempts helps to minimize a chance of traffic hiccups influencing result. +Other way of increasing precision is to specify longer duration for traffic to run. + +.. code-block:: bash + + # NDR/PDR configuration + measurement: + # Drop rates represent the ratio of dropped packet to the total number of packets sent. + # Values provided here are percentages. A value of 0.01 means that at most 0.01% of all + # packets sent are dropped (or 1 packet every 10,000 packets sent) + + # No Drop Rate; Default to 0.001% + NDR: 0.001 + # Partial Drop Rate; NDR should always be less than PDR + PDR: 0.1 + # The accuracy of NDR and PDR load percentiles; The actual load percentile that match NDR + # or PDR should be within `load_epsilon` difference than the one calculated. + load_epsilon: 0.1 + +Because NDR/PDR is the default ``--rate`` value, it's possible to run NFVbench simply like this: + +.. code-block:: bash + + nfvbench -c nfvbench.cfg + +Other custom run: + +.. code-block:: bash + + nfvbench -c nfvbench.cfg --duration 120 --json results.json + +Used parameters: + +* ``-c nfvbench.cfg`` : path to the config file +* ``--duration 120`` : specifies how long should be traffic running in each iteration +* ``--json results.json`` : collected data are stored in this file after run is finished + + +Multichain +---------- + +NFVbench allows to run multiple chains at the same time. For example it is possible to run PVP service chain N-times, +where N can be as much as your compute power can scale. With N = 10, NFVbench will spawn 10 VMs as a part of 10 simultaneous PVP chains. + +Number of chains is specified by ``--service-chain-count`` or ``-scc`` flag, default value is 1. +For example to run NFVbench with 3 PVP chains use command: + +.. code-block:: bash + + nfvbench -c nfvbench.cfg --rate 10000pps -scc 3 + +It is not necessary to specify service chain because PVP is set as default. PVP service chains will have 3 VMs in 3 chains with this configuration. +If ``-sc PVVP`` is specified instead, there would be 6 VMs in 3 chains as this service chain has 2 VMs per chain. +Both **single run** or **NDR/PDR** can be run as multichain. Running multichain is a scenario closer to a real life situation than just simple run. + + +External Chain +-------------- + +NFVbench can measure the performance of 1 or more L3 service chains that are setup externally. Instead of being setup by NFVbench, +the complete environment (VMs and networks) has to be setup prior to running NFVbench. + +Each external chain is made of 1 or more VNFs and has exactly 2 end network interfaces (left and right network interfaces) that are connected to 2 neutron networks (left and right networks). +The internal composition of a multi-VNF service chain can be arbitrary (usually linear) as far as NFVbench is concerned, +the only requirement is that the service chain can route L3 packets properly between the left and right networks. + +To run NFVbench on such external service chains: + +- explicitly tell NFVbench to use external service chain by adding ``-sc EXT`` or ``--service-chain EXT`` to NFVbench CLI options +- specify the number of external chains using the ``-scc`` option (defaults to 1 chain) +- specify the 2 end point networks of your environment in ``external_networks`` inside the config file. + - The two networks specified there have to exist in Neutron and will be used as the end point networks by NFVbench ('napa' and 'marin' in the diagram below) +- specify the router gateway IPs for the external service chains (1.1.0.2 and 2.2.0.2) +- specify the traffic generator gateway IPs for the external service chains (1.1.0.102 and 2.2.0.102 in diagram below) +- specify the packet source and destination IPs for the virtual devices that are simulated (10.0.0.0/8 and 20.0.0.0/8) + + +.. image:: images/extchain-config.svg + +The L3 router function must be enabled in the VNF and configured to: + +- reply to ARP requests to its public IP addresses on both left and right networks +- route packets from each set of remote devices toward the appropriate dest gateway IP in the traffic generator using 2 static routes (as illustrated in the diagram) + +Upon start, NFVbench will: +- first retrieve the properties of the left and right networks using Neutron APIs, +- extract the underlying network ID (either VLAN ID or VNI if VxLAN is used), +- then program the TOR to stitch the 2 interfaces from the traffic generator into each end of the service chain, +- then generate and measure traffic. + +Note that in the case of multiple chains, all chains end interfaces must be connected to the same two left and right networks. +The traffic will be load balanced across the corresponding gateway IP of these external service chains. + +.. note:: By default, interfaces configuration (TOR, VTS, etc.) will be run by NFVbench but these can be skipped by using ``--no-int-config`` flag. + + +Multiflow +--------- + +NFVbench always generates L3 packets from the traffic generator but allows the user to specify how many flows to generate. +A flow is identified by a unique src/dest MAC IP and port tuple that is sent by the traffic generator. Note that from a vswitch point of view, the +number of flows seen will be higher as it will be at least 4 times the number of flows sent by the traffic generator +(add reverse direction of vswitch to traffic generator, add flow to VM and flow from VM). + + +The number of flows will be spread roughly even between chains when more than 1 chain is being tested. +For example, for 11 flows and 3 chains, number of flows that will run for each chain will be 3, 4, and 4 flows respectively. + +The number of flows is specified by ``--flow-count`` or ``-fc`` flag, the default value is 2 (1 flow in each direction). +To run NFVbench with 3 chains and 100 flows, use the following command: + +.. code-block:: bash + + nfvbench -c nfvbench.cfg --rate 10000pps -scc 3 -fc 100 + + +IP addresses generated can be controlled with the following NFVbench configuration options: + +.. code-block:: bash + + ip_addrs: ['10.0.0.0/8', '20.0.0.0/8'] + ip_addrs_step: 0.0.0.1 + tg_gateway_ip_addrs: ['1.1.0.100', '2.2.0.100'] + tg_gateway_ip_addrs_step: 0.0.0.1 + gateway_ip_addrs: ['1.1.0.2', '2.2.0.2'] + gateway_ip_addrs_step: 0.0.0.1 + +``ip_addrs`` are the start of the 2 ip address ranges used by the traffic generators as the packets source and destination packets +where each range is associated to virtual devices simulated behind 1 physical interface of the traffic generator. +These can also be written in CIDR notation to represent the subnet. + +``tg_gateway_ip_addrs`` are the traffic generator gateway (virtual) ip addresses, all traffic to/from the virtual devices go through them. + +``gateway_ip_addrs`` are the 2 gateway ip address ranges of the VMs used in the external chains. They are only used with external chains and must correspond to their public IP address. + +The corresponding ``step`` is used for ranging the IP addresses from the `ip_addrs``, ``tg_gateway_ip_addrs`` and ``gateway_ip_addrs`` base addresses. +0.0.0.1 is the default step for all IP ranges. In ``ip_addrs``, 'random' can be configured which tells NFVBench to generate random src/dst IP pairs in the traffic stream. + + +Traffic Config via CLI +---------------------- + +While traffic configuration can modified using the config file, it became a hassle to have to change the config file everytime you need to change traffic config. + +Traffic config can be overridden with the CLI options. + +Here is an example of configuring traffic via CLI: + +.. code-block:: bash + + nfvbench --rate 10kpps --service-chain-count 2 -fs 64 -fs IMIX -fs 1518 --unidir + +This command will run NFVbench with two streams with unidirectional flow for three packet sizes 64B, IMIX, and 1518B. + +Used parameters: + +* ``--rate 10kpps`` : defines rate of packets sent by traffic generator (total TX rate) +* ``-scc 2`` or ``--service-chain-count 2`` : specifies number of parallel chains of given flow to run (default to 1) +* ``-fs 64`` or ``--frame-size 64``: add the specified frame size to the list of frame sizes to run +* ``--unidir`` : run traffic with unidirectional flow (default to bidirectional flow) + + +MAC Addresses +------------- + +NFVbench will dicover the MAC addresses to use for generated frames using: +- either OpenStack discovery (find the MAC of an existing VM) if the loopback VM is configured to run L2 forwarding +- or using dynamic ARP discovery (find MAC from IP) if the loopback VM is configured to run L3 routing or in the case of external chains. + diff --git a/docs/testing/user/userguide/conf.py b/docs/testing/user/userguide/conf.py new file mode 100644 index 0000000..638764c --- /dev/null +++ b/docs/testing/user/userguide/conf.py @@ -0,0 +1,344 @@ +# -*- coding: utf-8 -*- +# +# NFVBench documentation build configuration file, created by +# sphinx-quickstart on Thu Sep 29 14:25:18 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +from pbr import version as pbr_ver + +sys.path.insert(0, os.path.abspath('../..')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'NFVBench' +copyright = u'2016 Cisco Systems, Inc.' +author = u'Cisco Systems, Inc.' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = pbr_ver.VersionInfo(project).version_string() +# The full version, including alpha/beta/rc tags. +release = pbr_ver.VersionInfo(project).version_string_with_vcs() + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +#html_theme = 'haiku' +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# "<project> v<release> documentation" by default. +# +# html_title = u'NFVBench vdev117' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +html_short_title = 'nfvbench' + +# The name of an image file (relative to this directory) to place at the topß +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +html_use_smartypants = False + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NFVBenchdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NFVBench.tex', u'NFVBench Documentation', + u'Alec Hothan, Stefano Suryanto, Jan Balaz', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'nfvbench', u'NFVBench Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NFVBench', u'NFVBench Documentation', + author, 'NFVBench', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False diff --git a/docs/testing/user/userguide/examples.rst b/docs/testing/user/userguide/examples.rst new file mode 100644 index 0000000..4fc68b7 --- /dev/null +++ b/docs/testing/user/userguide/examples.rst @@ -0,0 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +Example of Results +****************** + + + diff --git a/docs/testing/user/userguide/faq.rst b/docs/testing/user/userguide/faq.rst new file mode 100644 index 0000000..cb5acb5 --- /dev/null +++ b/docs/testing/user/userguide/faq.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +Frequently Asked Questions +************************** + + +Can NFVbench be used with a different traffic generator than TRex? +------------------------------------------------------------------ +This is possible but requires developing a new python class to manage the new traffic generator interface. + +Can I connect Trex directly to my compute node? +----------------------------------------------- +That is possible but you will not be able to run more advanced use cases such as PVVP inter-node which requires 2 compute nodes. + + +Can I drive NFVbench using a REST interface? +-------------------------------------------- +NFVbench can run in server mode and accept HTTP or WebSocket/SocketIO events to run any type of measurement (fixed rate run or NDR_PDR run) +with any run configuration. + + +Can I run NFVbench on a Cisco UCS-B series blade? +------------------------------------------------- +Yes provided your UCS-B series server has a Cisco VIC 1340 (with a recent firmware version). +TRex will require VIC firmware version 3.1(2) or higher for blade servers (which supports more filtering capabilities). +In this setting, the 2 physical interfaces for data plane traffic are simply hooked to the UCS-B fabric interconnect (no need to connect to a switch). diff --git a/docs/testing/user/userguide/hw_requirements.rst b/docs/testing/user/userguide/hw_requirements.rst new file mode 100644 index 0000000..acb4c0a --- /dev/null +++ b/docs/testing/user/userguide/hw_requirements.rst @@ -0,0 +1,79 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +Requirements for running NFVbench +================================= + +.. _requirements: + +Hardware Requirements +--------------------- +To run NFVbench you need the following hardware: +- a Linux server +- a DPDK compatible NIC with at least 2 ports (preferably 10Gbps or higher) +- 2 ethernet cables between the NIC and the OpenStack pod under test (usually through a top of rack switch) + +The DPDK-compliant NIC must be one supported by the TRex traffic generator (such as Intel X710, refer to the `Trex Installation Guide <https://trex-tgn.cisco.com/trex/doc/trex_manual.html#_download_and_installation>`_ for a complete list of supported NIC) + +To run the TRex traffic generator (that is bundled with NFVbench) you will need to wire 2 physical interfaces of the NIC to the TOR switch(es): + - if you have only 1 TOR, wire both interfaces to that same TOR + - 1 interface to each TOR if you have 2 TORs and want to use bonded links to your compute nodes + +.. image:: images/nfvbench-trex-setup.svg + + +Switch Configuration +-------------------- +For VLAN encapsulation, the 2 corresponding ports on the switch(es) facing the Trex ports on the Linux server should be configured in trunk mode (NFVbench will instruct TRex to insert the appropriate vlan tag). + +For VxLAN encapsulation, the switch(es) must support the VTEP feature (VxLAN Tunnel End Point) with the ability to attach an interface to a VTEP (this is an advanced feature that requires an NFVbench plugin for the switch). + +Using a TOR switch is more representative of a real deployment and allows to measure packet flows on any compute node in the rack without rewiring and includes the overhead of the TOR switch. + +Although not the primary targeted use case, NFVbench could also support the direct wiring of the traffic generator to +a compute node without a switch (although that will limit some of the features that invove multiple compute nodes in the packet path). + +Software Requirements +--------------------- + +You need Docker to be installed on the Linux server. + +TRex uses the DPDK interface to interact with the DPDK compatible NIC for sending and receiving frames. The Linux server will +need to be configured properly to enable DPDK. + +DPDK requires a uio (User space I/O) or vfio (Virtual Function I/O) kernel module to be installed on the host to work. +There are 2 main uio kernel modules implementations (igb_uio and uio_pci_generic) and one vfio kernel module implementation. + +To check if a uio or vfio is already loaded on the host: + +.. code-block:: bash + + lsmod | grep -e igb_uio -e uio_pci_generic -e vfio + + +If missing, it is necessary to install a uio/vfio kernel module on the host server: + +- find a suitable kernel module for your host server (any uio or vfio kernel module built with the same Linux kernel version should work) +- load it using the modprobe and insmod commands + +Example of installation of the igb_uio kernel module: + +.. code-block:: bash + + modprobe uio + insmod ./igb_uio.ko + +Finally, the correct iommu options and huge pages to be configured on the Linux server on the boot command line: + +- enable intel_iommu and iommu pass through: "intel_iommu=on iommu=pt" +- for Trex, pre-allocate 1024 huge pages of 2MB each (for a total of 2GB): "hugepagesz=2M hugepages=1024" + +More detailed instructions can be found in the DPDK documentation (https://media.readthedocs.org/pdf/dpdk/latest/dpdk.pdf). + + +NFVbench loopback VM image Upload +--------------------------------- + +The NFVbench loopback VM image should be uploaded to OpenStack prior to running NFVbench. +The NFVbench VM qcow2 image can be rebuilt from script or can be copied from the OPNFV artifact repository [URL TBP]. diff --git a/docs/testing/user/userguide/images/extchain-config.svg b/docs/testing/user/userguide/images/extchain-config.svg new file mode 100644 index 0000000..4e3db47 --- /dev/null +++ b/docs/testing/user/userguide/images/extchain-config.svg @@ -0,0 +1,219 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="78 81 726 460" width="726pt" height="460pt" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <metadata> Produced by OmniGraffle 7.3 + <dc:date>2017-03-31 20:15:29 +0000</dc:date> + </metadata> + <defs> + <filter id="Shadow" filterUnits="userSpaceOnUse"> + <feGaussianBlur in="SourceAlpha" result="blur" stdDeviation="1.308"/> + <feOffset in="blur" result="offset" dx="0" dy="2"/> + <feFlood flood-color="black" flood-opacity=".5" result="flood"/> + <feComposite in="flood" in2="offset" operator="in"/> + </filter> + <font-face font-family="Lucida Sans" font-size="10" panose-1="2 11 6 2 3 5 4 2 2 4" units-per-em="1000" underline-position="-97.65625" underline-thickness="48.828125" slope="0" x-height="541.9922" cap-height="740.7227" ascent="966.7969" descent="-210.9375" font-weight="500"> + <font-face-src> + <font-face-name name="LucidaSans"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="10" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="Box_Marker" viewBox="-1 -2 4 4" markerWidth="4" markerHeight="4" color="#cec3fa"> + <g> + <rect x="0" y="-.9" width="1.8" height="1.8" fill="none" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="Box_Marker_2" viewBox="-3 -2 4 4" markerWidth="4" markerHeight="4" color="#cec3fa"> + <g> + <rect x="-1.8" y="-.9" width="1.8" height="1.8" fill="none" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="Ball_Marker" viewBox="-1 -2 4 4" markerWidth="4" markerHeight="4" color="#929292"> + <g> + <circle cx=".8999996" cy="0" r=".8999992" fill="none" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="Ball_Marker_2" viewBox="-3 -2 4 4" markerWidth="4" markerHeight="4" color="#929292"> + <g> + <circle cx="-.8999996" cy="0" r=".8999992" fill="none" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <font-face font-family="Gill Sans" font-size="10" panose-1="2 11 5 2 2 1 4 2 2 3" units-per-em="1000" underline-position="-75.19531" underline-thickness="49.80469" slope="0" x-height="449.70703" cap-height="687.0117" ascent="917.9688" descent="-230.46875" font-weight="500"> + <font-face-src> + <font-face-name name="GillSans"/> + </font-face-src> + </font-face> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="FilledArrow_Marker" viewBox="-1 -2 4 4" markerWidth="4" markerHeight="4" color="#d4c057" opacity=".493177"> + <g> + <path d="M 1.6 0 L 0 -.6 L 0 .6 Z" fill="currentColor" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="FilledArrow_Marker_2" viewBox="-3 -2 4 4" markerWidth="4" markerHeight="4" color="#d4c057" opacity=".493177"> + <g> + <path d="M -1.6 0 L 0 .6 L 0 -.6 Z" fill="currentColor" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <font-face font-family="Helvetica" font-size="10" units-per-em="1000" underline-position="-75.68359" underline-thickness="49.316406" slope="0" x-height="522.9492" cap-height="717.28516" ascent="770.0195" descent="-229.98047" font-weight="500"> + <font-face-src> + <font-face-name name="Helvetica"/> + </font-face-src> + </font-face> + <font-face font-family="Osaka" font-size="12" panose-1="2 11 6 0 0 0 0 0 0 0" units-per-em="1000" underline-position="0" underline-thickness="59.037876" slope="0" x-height="464.84375" cap-height="648.4375" ascent="855.4688" descent="-191.40625" font-weight="500"> + <font-face-src> + <font-face-name name="Osaka-Mono"/> + </font-face-src> + </font-face> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="StickArrow_Marker" viewBox="-1 -4 10 8" markerWidth="10" markerHeight="8" color="#e86fd0"> + <g> + <path d="M 8 0 L 0 0 M 0 -3 L 8 0 L 0 3" fill="none" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + </defs> + <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"> + <title>ext chain</title> + <g> + <title>pvvp-intra</title> + <g> + <xl:use xl:href="#id49_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id48_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id46_Graphic" filter="url(#Shadow)"/> + </g> + <g id="id49_Graphic"> + <rect x="82.125" y="148.5" width="247.32675" height="182.87344" fill="#f0f0f0"/> + <rect x="82.125" y="148.5" width="247.32675" height="182.87344" stroke="#a5a5a5" stroke-linecap="round" stroke-linejoin="round" stroke-width=".5"/> + <text transform="translate(87.125 148.5)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="79.13457" y="10" textLength="79.05762">traffic generator</tspan> + </text> + </g> + <g id="id48_Graphic"> + <rect x="479.25" y="167.625" width="176.625" height="151.875" fill="#f5f5eb"/> + <path d="M 479.25 167.625 L 655.875 167.625 L 655.875 319.5 L 479.25 319.5 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width=".5" stroke-dasharray="4,4"/> + <text transform="translate(484.25 167.625)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="93.13867" y="10" textLength="73.48633">SERVICE CHAIN</tspan> + </text> + </g> + <line x1="507.125" y1="260" x2="507.125" y2="186.20833" stroke="#929292" stroke-linecap="round" stroke-linejoin="round" stroke-width="5"/> + <g id="id46_Graphic"> + <rect x="379.125" y="166.5" width="57.68741" height="159.7121" fill="#d1d9e6" fill-opacity=".10672624"/> + <rect x="379.125" y="166.5" width="57.68741" height="159.7121" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width=".5"/> + <text transform="translate(384.125 166.5)" fill="black" fill-opacity=".4152397"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" fill-opacity=".4152397" x="7.4130395" y="10" textLength="22.27539">DC-S</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" fill-opacity=".4152397" x="29.6689" y="10" textLength="10.605469">W</tspan> + </text> + </g> + <line x1="274.14287" y1="292.33777" x2="626.52315" y2="293.47495" marker-end="url(#Box_Marker)" marker-start="url(#Box_Marker_2)" stroke="#cec3fa" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <line x1="631.3333" y1="308.625" x2="630" y2="212.625" stroke="#cec3fa" stroke-linecap="round" stroke-linejoin="round" stroke-width="5"/> + <line x1="273.76087" y1="205.73606" x2="502.52503" y2="206.58753" marker-end="url(#Ball_Marker)" marker-start="url(#Ball_Marker_2)" stroke="#929292" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <line x1="546.0999" y1="228.59572" x2="511.7247" y2="228.97873" marker-end="url(#Ball_Marker)" stroke="#929292" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <line x1="589.094" y1="243.43417" x2="625.8217" y2="243.0174" marker-end="url(#Box_Marker)" stroke="#cec3fa" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <ellipse cx="567.4375" cy="236.73324" rx="21.812535" ry="27.48328" fill="#eaf2bf"/> + <ellipse cx="567.4375" cy="236.73324" rx="21.812535" ry="27.48328" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(554.9875 225.73324)" fill="black"> + <tspan font-family="Gill Sans" font-size="10" font-weight="500" fill="black" x="7.498828" y="9" textLength="12.680664">L3 </tspan> + <tspan font-family="Gill Sans" font-size="10" font-weight="500" fill="black" x="3.1799805" y="20" textLength="18.54004">VNF</tspan> + </text> + <ellipse cx="244.20895" cy="205.40873" rx="24.458986" ry="12.852811" fill="#eaf2bf"/> + <ellipse cx="244.20895" cy="205.40873" rx="24.458986" ry="12.852811" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(229.6418 198.7598)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" x="4.000751" y="10" textLength="21.132812">gwA</tspan> + </text> + <line x1="218.17016" y1="204.90873" x2="123.03817" y2="204.90873" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <line x1="124.875" y1="289.3752" x2="223.16667" y2="289.3752" stroke="#8e3bae" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <ellipse cx="245.08395" cy="290.853" rx="24.458986" ry="12.852811" fill="#eaf2bf"/> + <ellipse cx="245.08395" cy="290.853" rx="24.458986" ry="12.852811" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(230.5168 284.20406)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" x="4.747821" y="10" textLength="19.638672">gwB</tspan> + </text> + <path d="M 287.06743 305.7484 C 383.5292 303.84953 517.4412 309.08555 536.8379 307.16983 C 557.0879 305.16983 623.125 308.875 621.7917 272.875 C 620.4583 236.875 506.8675 259.29167 502.08333 252.625 C 497.29917 245.95833 494.08333 258.625 494.08333 229.95833 C 494.08333 201.29167 497.34544 216.1918 487.1968 204.85848 C 477.6795 194.23016 353.7978 198.7745 286.9911 197.26211" marker-end="url(#FilledArrow_Marker)" marker-start="url(#FilledArrow_Marker_2)" stroke="#d4c057" stroke-opacity=".493177" stroke-linecap="butt" stroke-linejoin="round" stroke-width="4"/> + <text transform="translate(545 483.125)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="10" textLength="67.59766">right public IP</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="22" textLength="34.785156">2.2.0.2</tspan> + </text> + <line x1="588.27516" y1="244.87632" x2="579.6301" y2="478.125" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(323.25 364.375)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x=".13378906" y="10" textLength="95.73242">right virtual devices</tspan> + </text> + <line x1="155.375" y1="283.97184" x2="342.5177" y2="358.875" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(677.75 127.625)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="10" textLength="63.291016">static routes:</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="22" textLength="120.07324">20.0.0.0/8 gw 2.2.0.102</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="34" textLength="120.07324">10.0.0.0/8 gw 1.1.0.102</tspan> + </text> + <line x1="586.2303" y1="222.76824" x2="692.92584" y2="168.625" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(478.375 360.5)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x=".234375" y="10" textLength="99.53125">right virtual gateway</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="26.28418" y="22" textLength="47.43164">2.2.0.102</tspan> + </text> + <line x1="269.5429" y1="292.32292" x2="473.49465" y2="355.5" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <rect x="100.26389" y="269.51805" width="55.11111" height="42.857143" fill="white"/> + <rect x="100.26389" y="269.51805" width="55.11111" height="42.857143" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="96.81944" y="265.94663" width="55.11111" height="42.857143" fill="white"/> + <rect x="96.81944" y="265.94663" width="55.11111" height="42.857143" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="93.375" y="262.3752" width="55.11111" height="42.857143" fill="white"/> + <rect x="93.375" y="262.3752" width="55.11111" height="42.857143" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(98.375 271.80377)" fill="black"> + <tspan font-family="Helvetica" font-size="10" font-weight="500" x=".3143446" y="10" textLength="44.48242">20.0.0.0/8</tspan> + <tspan font-family="Helvetica" font-size="10" font-weight="500" x="5.6024306" y="22" textLength="33.90625">devices</tspan> + </text> + <rect x="101.38889" y="185.87466" width="55.11111" height="42.857143" fill="white"/> + <rect x="101.38889" y="185.87466" width="55.11111" height="42.857143" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="97.94444" y="182.30323" width="55.11111" height="42.857143" fill="white"/> + <rect x="97.94444" y="182.30323" width="55.11111" height="42.857143" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="94.5" y="178.7318" width="55.11111" height="42.857143" fill="white"/> + <rect x="94.5" y="178.7318" width="55.11111" height="42.857143" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(99.5 188.16037)" fill="black"> + <tspan font-family="Helvetica" font-size="10" font-weight="500" x=".3143446" y="10" textLength="44.48242">10.0.0.0/8</tspan> + <tspan font-family="Helvetica" font-size="10" font-weight="500" x="5.6024306" y="22" textLength="33.90625">devices</tspan> + </text> + <text transform="translate(375.125 86)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="45.3125" y="10" textLength="34.375">’marin’</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x=".4296875" y="22" textLength="124.14062">service chain left network</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="36.313477" y="34" textLength="52.373047">1.1.0.0/24</tspan> + </text> + <line x1="507.125" y1="192.32936" x2="455.72204" y2="127" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(609.125 423.5)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="10" textLength="29.873047">‘napa’</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="22" textLength="131.42578">service chain right network</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="0" y="34" textLength="52.373047">2.2.0.0/24</tspan> + </text> + <line x1="631.2763" y1="304.51667" x2="667.7626" y2="418.5" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(502 116.375)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x=".34375" y="10" textLength="60.3125">left public IP</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="13.107422" y="22" textLength="34.785156">1.1.0.2</tspan> + </text> + <line x1="546.5302" y1="228.09501" x2="534.89194" y2="145.375" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(250 95)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x=".37695312" y="10" textLength="92.24609">left virtual gateway</tspan> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x="22.78418" y="22" textLength="47.43164">1.1.0.102</tspan> + </text> + <line x1="271.58333" y1="206.31494" x2="292.23495" y2="124" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(116.25 95.5)" fill="black"> + <tspan font-family="Lucida Sans" font-size="10" font-weight="500" fill="black" x=".2763672" y="10" textLength="88.44727">left virtual devices</tspan> + </text> + <line x1="122.453" y1="178.7318" x2="155.04748" y2="113" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(97.25 396.85107)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" x="0" y="10" textLength="35.253906">nfvbenc</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" x="35.512695" y="10" textLength="30.13672">h confi</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" x="65.649414" y="10" textLength="14.379883">g fi</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" x="80.0293" y="10" textLength="11.108398">le:</tspan> + </text> + <text transform="translate(91.625 425.75)" fill="black"> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="10" textLength="252">internal_network_name: [‘marin', ‘napa']</tspan> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="22" textLength="108">traffic_generator:</tspan> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="34" textLength="252"> ip_addrs: ['10.0.0.0/8', '20.0.0.0/8']</tspan> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="46" textLength="156"> ip_addrs_step: 0.0.0.1</tspan> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="58" textLength="318"> tg_gateway_ip_addrs: ['1.1.0.102’, '2.2.0.102’]</tspan> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="70" textLength="222"> tg_gateway_ip_addrs_step: 0.0.0.1</tspan> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="82" textLength="264"> gateway_ip_addrs: ['1.1.0.2', '2.2.0.2']</tspan> + <tspan font-family="Osaka" font-size="12" font-weight="500" x="0" y="94" textLength="204"> gateway_ip_addrs_step: 0.0.0.1</tspan> + </text> + <path d="M 604.125 438.8336 C 558.9773 439.34514 343.50462 360.4248 324.713 418.4743" marker-end="url(#StickArrow_Marker)" stroke="#e86fd0" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <path d="M 540 497.4063 C 494.85924 497.91775 348.4386 576.5024 327.58433 519.6221" marker-end="url(#StickArrow_Marker)" stroke="#e86fd0" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <path d="M 503.41667 393.95833 C 483.9034 443.0562 422.1928 531.9741 383.3793 497.97585" marker-end="url(#StickArrow_Marker)" stroke="#e86fd0" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <path d="M 366.45733 381.875 C 362.811 420.01984 368.47553 438.26776 347.53805 447.0305" marker-end="url(#StickArrow_Marker)" stroke="#e86fd0" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + </g> + </g> +</svg> diff --git a/docs/testing/user/userguide/images/nfvbench-npvp.svg b/docs/testing/user/userguide/images/nfvbench-npvp.svg new file mode 100644 index 0000000..f72af34 --- /dev/null +++ b/docs/testing/user/userguide/images/nfvbench-npvp.svg @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="120 486 399 148" width="399pt" height="148pt" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <metadata> Produced by OmniGraffle 7.2 + <dc:date>2016-11-13 19:58:51 +0000</dc:date> + </metadata> + <defs> + <font-face font-family="Futura" font-size="15" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <filter id="Shadow" filterUnits="userSpaceOnUse"> + <feGaussianBlur in="SourceAlpha" result="blur" stdDeviation="1.308"/> + <feOffset in="blur" result="offset" dx="0" dy="2"/> + <feFlood flood-color="black" flood-opacity=".5" result="flood"/> + <feComposite in="flood" in2="offset" operator="in"/> + </filter> + <font-face font-family="Futura" font-size="11" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="10" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="12" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + </defs> + <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"> + <title>nfvbench-flows 2</title> + <g> + <title>pvvp-intra</title> + <text transform="translate(129.0625 491.65665)" fill="black"> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x=".07739258" y="16" textLength="103.19092">N single VNF c</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="103.6565" y="16" textLength="35.266113">hains</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="16.000244" y="36.446777" textLength="62.13135">(N x PVP</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="77.06958" y="36.446777" textLength="45.930176">, N=2)</tspan> + </text> + </g> + <g> + <title>nxpvp</title> + <g> + <xl:use xl:href="#id38354_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id38328_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id38334_Graphic" filter="url(#Shadow)"/> + </g> + <g id="id38354_Graphic"> + <rect x="214.03778" y="541" width="57.68741" height="56.25" fill="#d1d9e6"/> + <rect x="214.03778" y="541" width="57.68741" height="56.25" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(219.03778 583.4224)" fill="black"> + <tspan font-family="Futura" font-size="11" font-weight="600" fill="black" x="5.769973" y="11" textLength="24.50293">DC-S</tspan> + <tspan font-family="Futura" font-size="11" font-weight="600" fill="black" x="30.25142" y="11" textLength="11.666016">W</tspan> + </text> + </g> + <g id="id38328_Graphic"> + <rect x="295.57012" y="505.6288" width="218.99238" height="121.75641" fill="#dae68e"/> + <rect x="295.57012" y="505.6288" width="218.99238" height="121.75641" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(300.57012 614.58734)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="71.01718" y="10" textLength="20.927734">Com</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="92.06699" y="10" textLength="14.179688">put</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="106.33457" y="10" textLength="31.640625">e node</tspan> + </text> + </g> + <path d="M 352.57017 532.96637 L 402.2576 532.96637 C 404.4667 532.96637 406.2576 534.7572 406.2576 536.96637 L 406.2576 590.3585 C 406.2576 592.5677 404.4667 594.3585 402.2576 594.3585 L 352.57017 594.3585 C 350.36103 594.3585 348.57017 592.5677 348.57017 590.3585 L 348.57017 536.96637 C 348.57017 534.7572 350.36103 532.96637 352.57017 532.96637 Z" fill="#bbcee3"/> + <path d="M 352.57017 532.96637 L 402.2576 532.96637 C 404.4667 532.96637 406.2576 534.7572 406.2576 536.96637 L 406.2576 590.3585 C 406.2576 592.5677 404.4667 594.3585 402.2576 594.3585 L 352.57017 594.3585 C 350.36103 594.3585 348.57017 592.5677 348.57017 590.3585 L 348.57017 536.96637 C 348.57017 534.7572 350.36103 532.96637 352.57017 532.96637 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(353.57017 557.0135)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="7.566848" y="10" textLength="26.811523">vswitc</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="34.63716" y="10" textLength="5.4833984">h</tspan> + </text> + <ellipse cx="463.7071" cy="536.9195" rx="30.93755" ry="21.300585" fill="#eaf2bf"/> + <ellipse cx="463.7071" cy="536.9195" rx="30.93755" ry="21.300585" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(443.9571 530.27055)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="6.5200195" y="10" textLength="26.45996">VNF1</tspan> + </text> + <ellipse cx="463.7071" cy="589.8623" rx="30.93755" ry="21.300585" fill="#eaf2bf"/> + <ellipse cx="463.7071" cy="589.8623" rx="30.93755" ry="21.300585" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(443.9571 583.2134)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="6.5200195" y="10" textLength="26.45996">VNF2</tspan> + </text> + <rect x="295.57012" y="505.6288" width="29.25" height="121.75641" fill="#eae9dd"/> + <rect x="295.57012" y="505.6288" width="29.25" height="121.75641" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(300.57012 614.58734)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x=".42578125" y="10" textLength="18.398438">NIC</tspan> + </text> + <path d="M 169.92628 548.013 C 233.42628 548.013 333.63258 545.382 381.6326 538.382 C 429.6326 531.382 445.6882 531.18676 446.9104 537.68676 C 448.1326 544.18676 417.4888 544.1532 381.9888 549.6532 C 346.4888 555.1532 227.80128 558.76214 169.80128 558.1532" stroke="#aaa" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/> + <path d="M 170.41727 578.7688 C 233.91727 578.7688 334.12356 581.3998 382.12356 588.3998 C 430.12356 595.3998 446.0076 596.56276 446.7576 589.56276 C 447.5076 582.56276 417.97977 582.6286 382.47977 577.1286 C 346.97977 571.6286 228.29227 568.01965 170.29227 568.6286" stroke="#929292" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/> + <g id="id38334_Graphic"> + <rect x="124.0625" y="541" width="68.5" height="56.25" fill="#f0f0f0"/> + <rect x="124.0625" y="541" width="68.5" height="56.25" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(129.0625 553.7676)" fill="black"> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="13.983398" y="12" textLength="7.769531">tr</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="21.670898" y="12" textLength="17.126953">affi</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="38.79785" y="12" textLength="5.71875">c</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="2.3964844" y="27.357422" textLength="31.529297">gener</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="33.84375" y="27.357422" textLength="10.476562">at</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="44.402344" y="27.357422" textLength="11.701172">or</tspan> + </text> + </g> + </g> + </g> +</svg> diff --git a/docs/testing/user/userguide/images/nfvbench-pvp.svg b/docs/testing/user/userguide/images/nfvbench-pvp.svg new file mode 100644 index 0000000..e023b1f --- /dev/null +++ b/docs/testing/user/userguide/images/nfvbench-pvp.svg @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="114 61 405 103" width="405pt" height="103pt" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <metadata> Produced by OmniGraffle 7.2 + <dc:date>2016-11-13 19:58:51 +0000</dc:date> + </metadata> + <defs> + <font-face font-family="Futura" font-size="15" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <filter id="Shadow" filterUnits="userSpaceOnUse"> + <feGaussianBlur in="SourceAlpha" result="blur" stdDeviation="1.308"/> + <feOffset in="blur" result="offset" dx="0" dy="2"/> + <feFlood flood-color="black" flood-opacity=".5" result="flood"/> + <feComposite in="flood" in2="offset" operator="in"/> + </filter> + <font-face font-family="Futura" font-size="10" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="12" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + </defs> + <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"> + <title>nfvbench-flows 2</title> + <g> + <title>pvvp-intra</title> + <text transform="translate(119.5625 67.15161)" fill="black"> + <tspan font-family="Futura" font-size="15" font-weight="600" x=".2866211" y="16" textLength="85.89844">single VNF c</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" x="86.57324" y="16" textLength="71.14014">hain (PVP)</tspan> + </text> + </g> + <g> + <title>pvp</title> + <g> + <xl:use xl:href="#id38285_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id38287_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id38291_Graphic" filter="url(#Shadow)"/> + </g> + <g id="id38285_Graphic"> + <rect x="308.6875" y="72.34412" width="205.875" height="85.5" fill="#dae68e"/> + <rect x="308.6875" y="72.34412" width="205.875" height="85.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(313.6875 72.34412)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="64.458496" y="10" textLength="20.927734">Com</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="85.5083" y="10" textLength="14.179688">put</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="99.77588" y="10" textLength="31.640625">e node</tspan> + </text> + </g> + <rect x="308.6875" y="72.34412" width="29.25" height="85.5" fill="#eae9dd"/> + <rect x="308.6875" y="72.34412" width="29.25" height="85.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(313.6875 72.34412)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x=".42578125" y="10" textLength="18.398438">NIC</tspan> + </text> + <g id="id38287_Graphic"> + <rect x="217.125" y="101.25" width="61.875" height="50.28088" fill="#d1d9e6"/> + <rect x="217.125" y="101.25" width="61.875" height="50.28088" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(222.125 101.25)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="9.506836" y="10" textLength="22.27539">DC-S</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="31.762695" y="10" textLength="10.605469">W</tspan> + </text> + </g> + <path d="M 360.4375 99.73456 L 399 99.73456 C 403.97056 99.73456 408 103.764 408 108.73456 L 408 141.01544 C 408 145.986 403.97056 150.01544 399 150.01544 L 360.4375 150.01544 C 355.46694 150.01544 351.4375 145.986 351.4375 141.01544 L 351.4375 108.73456 C 351.4375 103.764 355.46694 99.73456 360.4375 99.73456 Z" fill="#bbcee3"/> + <path d="M 360.4375 99.73456 L 399 99.73456 C 403.97056 99.73456 408 103.764 408 108.73456 L 408 141.01544 C 408 145.986 403.97056 150.01544 399 150.01544 L 360.4375 150.01544 C 355.46694 150.01544 351.4375 145.986 351.4375 141.01544 L 351.4375 108.73456 C 351.4375 103.764 355.46694 99.73456 360.4375 99.73456 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(356.4375 99.73456)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="7.0043945" y="10" textLength="26.811523">vswitc</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="34.074707" y="10" textLength="5.4833984">h</tspan> + </text> + <ellipse cx="475.26203" cy="126.39044" rx="30.93755" ry="25.14048" fill="#eaf2bf"/> + <ellipse cx="475.26203" cy="126.39044" rx="30.93755" ry="25.14048" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(455.51203 119.74152)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="9.605957" y="10" textLength="20.288086">VNF</tspan> + </text> + <path d="M 182.62498 119.31252 L 452.75 119.31252 C 455.8221 119.31252 458.3125 121.80293 458.3125 124.875 L 458.3125 124.875 C 458.3125 127.94707 455.8221 130.43748 452.75 130.43748 L 182.62498 130.43748 C 179.5529 130.43748 177.0625 127.94707 177.0625 124.875 L 177.0625 124.875 C 177.0625 121.80293 179.5529 119.31252 182.62498 119.31252 Z" stroke="#aaa" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/> + <g id="id38291_Graphic"> + <rect x="125.0625" y="101.25" width="68.5" height="50.28088" fill="#f0f0f0"/> + <rect x="125.0625" y="101.25" width="68.5" height="50.28088" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(130.0625 111.03302)" fill="black"> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="13.983398" y="12" textLength="7.769531">tr</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="21.670898" y="12" textLength="17.126953">affi</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="38.79785" y="12" textLength="5.71875">c</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="2.3964844" y="27.357422" textLength="31.529297">gener</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="33.84375" y="27.357422" textLength="10.476562">at</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="44.402344" y="27.357422" textLength="11.701172">or</tspan> + </text> + </g> + </g> + </g> +</svg> diff --git a/docs/testing/user/userguide/images/nfvbench-pvvp-inter.svg b/docs/testing/user/userguide/images/nfvbench-pvvp-inter.svg new file mode 100644 index 0000000..3371346 --- /dev/null +++ b/docs/testing/user/userguide/images/nfvbench-pvvp-inter.svg @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="581 205 359 200" width="359pt" height="200pt" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <metadata> Produced by OmniGraffle 7.2 + <dc:date>2016-11-13 19:58:51 +0000</dc:date> + </metadata> + <defs> + <filter id="Shadow" filterUnits="userSpaceOnUse"> + <feGaussianBlur in="SourceAlpha" result="blur" stdDeviation="1.308"/> + <feOffset in="blur" result="offset" dx="0" dy="2"/> + <feFlood flood-color="black" flood-opacity=".5" result="flood"/> + <feComposite in="flood" in2="offset" operator="in"/> + </filter> + <font-face font-family="Futura" font-size="15" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="10" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="11" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="12" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + </defs> + <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"> + <title>nfvbench-flows 2</title> + <g> + <title>pvvp-intra</title> + <g> + <xl:use xl:href="#id38374_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id38375_Graphic" filter="url(#Shadow)"/> + </g> + <text transform="translate(590.2153 212.05322)" fill="black"> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="17.86377" y="16" textLength="12.524414">2-</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="30.358887" y="16" textLength="42.209473">VNF c</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="72.95654" y="16" textLength="29.179688">hain</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x=".08056641" y="36.446777" textLength="21.555176">(int</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="21.767578" y="36.446777" textLength="13.908691">er</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="35.507812" y="36.446777" textLength="84.41162">-node PVVP)</tspan> + </text> + <g id="id38374_Graphic"> + <rect x="764.0202" y="207" width="172.13258" height="85.5" fill="#dae68e"/> + <rect x="764.0202" y="207" width="172.13258" height="85.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(769.0202 207)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="42.340703" y="10" textLength="20.927734">Com</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="63.39051" y="10" textLength="14.179688">put</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="77.65809" y="10" textLength="42.13379">e node A</tspan> + </text> + </g> + <g id="id38375_Graphic"> + <rect x="763.0202" y="312.3848" width="173.13258" height="85.5" fill="#dae68e"/> + <rect x="763.0202" y="312.3848" width="173.13258" height="85.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(768.0202 385.08695)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" x="43.587773" y="10" textLength="20.927734">Com</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" x="64.63758" y="10" textLength="14.179688">put</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" x="78.90516" y="10" textLength="40.63965">e node B</tspan> + </text> + </g> + </g> + <g> + <title>pvv-inter</title> + <g> + <xl:use xl:href="#id38306_Graphic" filter="url(#Shadow)"/> + <xl:use xl:href="#id38310_Graphic" filter="url(#Shadow)"/> + </g> + <rect x="764.0202" y="207" width="29.25" height="85.5" fill="#eae9dd"/> + <rect x="764.0202" y="207" width="29.25" height="85.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(769.0202 207)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x=".42578125" y="10" textLength="18.398438">NIC</tspan> + </text> + <g id="id38306_Graphic"> + <rect x="671.625" y="280.125" width="57.68741" height="56.25" fill="#d1d9e6"/> + <rect x="671.625" y="280.125" width="57.68741" height="56.25" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(676.625 301.08618)" fill="black"> + <tspan font-family="Futura" font-size="11" font-weight="600" fill="black" x="5.769973" y="11" textLength="24.50293">DC-S</tspan> + <tspan font-family="Futura" font-size="11" font-weight="600" fill="black" x="30.25142" y="11" textLength="11.666016">W</tspan> + </text> + </g> + <path d="M 806.496 233.4918 L 843.4956 233.4918 C 846.257 233.4918 848.4956 235.73038 848.4956 238.4918 L 848.4956 278.7727 C 848.4956 281.5341 846.257 283.7727 843.4956 283.7727 L 806.496 283.7727 C 803.73455 283.7727 801.496 281.5341 801.496 278.7727 L 801.496 238.4918 C 801.496 235.73038 803.73455 233.4918 806.496 233.4918 Z" fill="#bbcee3"/> + <path d="M 806.496 233.4918 L 843.4956 233.4918 C 846.257 233.4918 848.4956 235.73038 848.4956 238.4918 L 848.4956 278.7727 C 848.4956 281.5341 846.257 283.7727 843.4956 283.7727 L 806.496 283.7727 C 803.73455 283.7727 801.496 281.5341 801.496 278.7727 L 801.496 238.4918 C 801.496 235.73038 803.73455 233.4918 806.496 233.4918 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(806.496 233.4918)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="2.2229413" y="10" textLength="26.811523">vswitc</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="29.293254" y="10" textLength="5.4833984">h</tspan> + </text> + <ellipse cx="897.3403" cy="253.4073" rx="30.93755" ry="21.300585" fill="#eaf2bf"/> + <ellipse cx="897.3403" cy="253.4073" rx="30.93755" ry="21.300585" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(877.5903 238.4969)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="3.5219727" y="10" textLength="32.456055">VNF1a</tspan> + </text> + <ellipse cx="897.3403" cy="362.5323" rx="30.93755" ry="21.300585" fill="#eaf2bf"/> + <ellipse cx="897.3403" cy="362.5323" rx="30.93755" ry="21.300585" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(877.5903 364.64482)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="3.5219727" y="10" textLength="32.456055">VNF1b</tspan> + </text> + <rect x="762.9653" y="312.3848" width="29.25" height="85.5" fill="#eae9dd"/> + <rect x="762.9653" y="312.3848" width="29.25" height="85.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(767.9653 385.08695)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x=".42578125" y="10" textLength="18.398438">NIC</tspan> + </text> + <path d="M 807.4024 329.71157 L 842.0227 329.71157 C 844.7841 329.71157 847.0227 331.95015 847.0227 334.71157 L 847.0227 374.99245 C 847.0227 377.75388 844.7841 379.99245 842.0227 379.99245 L 807.4024 379.99245 C 804.641 379.99245 802.4024 377.75388 802.4024 374.99245 L 802.4024 334.71157 C 802.4024 331.95015 804.641 329.71157 807.4024 329.71157 Z" fill="#bbcee3"/> + <path d="M 807.4024 329.71157 L 842.0227 329.71157 C 844.7841 329.71157 847.0227 331.95015 847.0227 334.71157 L 847.0227 374.99245 C 847.0227 377.75388 844.7841 379.99245 842.0227 379.99245 L 807.4024 379.99245 C 804.641 379.99245 802.4024 377.75388 802.4024 374.99245 L 802.4024 334.71157 C 802.4024 331.95015 804.641 329.71157 807.4024 329.71157 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(807.4024 367.1946)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="1.0333076" y="10" textLength="26.811523">vswitc</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="28.10362" y="10" textLength="5.4833984">h</tspan> + </text> + <path d="M 636.55465 318.22146 C 700.05465 318.22146 742.74215 337.67113 777.74215 345.67113 C 812.74215 353.67113 886.0206 366.93505 890.0206 355.62176 C 894.0206 344.30847 843.2908 342.9551 814.6797 339.17113 C 786.0687 335.38717 724.49215 318.90186 724.49215 307.17113" stroke="#aaa" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/> + <path d="M 636.7778 296.02245 C 700.2778 296.02245 742.9653 276.57278 777.9653 268.57278 C 812.9653 260.57278 886.0278 244.75948 890.0278 256.07278 C 894.0278 267.38607 841.4653 269.07278 814.9029 275.07278 C 788.3405 281.07278 724.7153 295.34205 724.7153 307.07278" stroke="#aaa" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/> + <g id="id38310_Graphic"> + <rect x="585.2153" y="280.125" width="68.5" height="56.25" fill="#f0f0f0"/> + <rect x="585.2153" y="280.125" width="68.5" height="56.25" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(590.2153 292.89258)" fill="black"> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="13.983398" y="12" textLength="7.769531">tr</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="21.670898" y="12" textLength="17.126953">affi</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="38.79785" y="12" textLength="5.71875">c</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="2.3964844" y="27.357422" textLength="31.529297">gener</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="33.84375" y="27.357422" textLength="10.476562">at</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="44.402344" y="27.357422" textLength="11.701172">or</tspan> + </text> + </g> + </g> + </g> +</svg> diff --git a/docs/testing/user/userguide/images/nfvbench-pvvp-intra.svg b/docs/testing/user/userguide/images/nfvbench-pvvp-intra.svg new file mode 100644 index 0000000..6c454b2 --- /dev/null +++ b/docs/testing/user/userguide/images/nfvbench-pvvp-intra.svg @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="121 227 398 139" width="398pt" height="139pt" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <metadata> Produced by OmniGraffle 7.2 + <dc:date>2016-11-13 19:58:51 +0000</dc:date> + </metadata> + <defs> + <filter id="Shadow" filterUnits="userSpaceOnUse"> + <feGaussianBlur in="SourceAlpha" result="blur" stdDeviation="1.308"/> + <feOffset in="blur" result="offset" dx="0" dy="2"/> + <feFlood flood-color="black" flood-opacity=".5" result="flood"/> + <feComposite in="flood" in2="offset" operator="in"/> + </filter> + <filter id="Shadow_2" filterUnits="userSpaceOnUse"> + <feGaussianBlur in="SourceAlpha" result="blur" stdDeviation="1.308"/> + <feOffset in="blur" result="offset" dx="0" dy="2"/> + <feFlood flood-color="black" flood-opacity=".5" result="flood"/> + <feComposite in="flood" in2="offset" operator="in" result="color"/> + <feMerge> + <feMergeNode in="color"/> + <feMergeNode in="SourceGraphic"/> + </feMerge> + </filter> + <font-face font-family="Futura" font-size="10" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="11" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="15" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + <font-face font-family="Futura" font-size="12" panose-1="2 11 6 2 2 2 4 2 3 3" units-per-em="1000" underline-position="-97.65625" underline-thickness="78.125" slope="0" x-height="482.4219" cap-height="761.2305" ascent="1038.5742" descent="-259.76562" font-weight="600"> + <font-face-src> + <font-face-name name="Futura-Medium"/> + </font-face-src> + </font-face> + </defs> + <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"> + <title>nfvbench-flows 2</title> + <g> + <title>pvvp-intra</title> + <g> + <xl:use xl:href="#id38276_Graphic" filter="url(#Shadow)"/> + </g> + <g filter="url(#Shadow_2)"> + <rect x="307.6875" y="233.82794" width="206.875" height="126.17206" fill="#dae68e"/> + <rect x="307.6875" y="233.82794" width="206.875" height="126.17206" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(312.6875 233.82794)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="64.958496" y="10" textLength="20.927734">Com</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="86.0083" y="10" textLength="14.179688">put</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="100.27588" y="10" textLength="31.640625">e node</tspan> + </text> + </g> + <rect x="307.6875" y="233.82794" width="29.25" height="126.17206" fill="#eae9dd"/> + <rect x="307.6875" y="233.82794" width="29.25" height="126.17206" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(312.6875 233.82794)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x=".42578125" y="10" textLength="18.398438">NIC</tspan> + </text> + <g filter="url(#Shadow_2)"> + <rect x="217.125" y="271.77353" width="61.875" height="50.28088" fill="#d1d9e6"/> + <rect x="217.125" y="271.77353" width="61.875" height="50.28088" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(222.125 289.75015)" fill="black"> + <tspan font-family="Futura" font-size="11" font-weight="600" fill="black" x="7.8637695" y="11" textLength="24.50293">DC-S</tspan> + <tspan font-family="Futura" font-size="11" font-weight="600" fill="black" x="32.345215" y="11" textLength="11.666016">W</tspan> + </text> + </g> + <path d="M 356.4375 272.44522 L 403 272.44522 C 405.7614 272.44522 408 274.6838 408 277.44522 L 408 317.7261 C 408 320.48753 405.7614 322.7261 403 322.7261 L 356.4375 322.7261 C 353.67608 322.7261 351.4375 320.48753 351.4375 317.7261 L 351.4375 277.44522 C 351.4375 274.6838 353.67608 272.44522 356.4375 272.44522 Z" fill="#bbcee3"/> + <path d="M 356.4375 272.44522 L 403 272.44522 C 405.7614 272.44522 408 274.6838 408 277.44522 L 408 317.7261 C 408 320.48753 405.7614 322.7261 403 322.7261 L 356.4375 322.7261 C 353.67608 322.7261 351.4375 320.48753 351.4375 317.7261 L 351.4375 277.44522 C 351.4375 274.6838 353.67608 272.44522 356.4375 272.44522 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(356.4375 290.93674)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="7.0043945" y="10" textLength="26.811523">vswitc</tspan> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="34.074707" y="10" textLength="5.4833984">h</tspan> + </text> + <ellipse cx="475.26203" cy="262.05055" rx="30.93755" ry="21.300585" fill="#eaf2bf"/> + <ellipse cx="475.26203" cy="262.05055" rx="30.93755" ry="21.300585" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(455.51203 247.14017)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="3.5219727" y="10" textLength="32.456055">VNF1a</tspan> + </text> + <ellipse cx="475.26203" cy="333.4872" rx="30.93755" ry="21.300585" fill="#eaf2bf"/> + <ellipse cx="475.26203" cy="333.4872" rx="30.93755" ry="21.300585" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(455.51203 335.59974)" fill="black"> + <tspan font-family="Futura" font-size="10" font-weight="600" fill="black" x="3.5219727" y="10" textLength="32.456055">VNF1b</tspan> + </text> + <text transform="translate(130.0625 232.5266)" fill="black"> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x=".31152344" y="16" textLength="12.524414">2-</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="12.80664" y="16" textLength="42.209473">VNF c</tspan> + <tspan font-family="Futura" font-size="15" font-weight="600" fill="black" x="55.4043" y="16" textLength="81.28418">hain (PVVP)</tspan> + </text> + <path d="M 182 307.60514 C 245.5 307.60514 348.18945 305.48077 386.18945 315.0207 C 424.18945 324.56065 461.68945 339.06065 465.18945 330.06065 C 468.68945 321.06065 436.68945 314.06065 422.68945 310.56065 C 408.68945 307.06065 402.87695 308.06065 402.68945 299.06065" stroke="#aaa" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/> + <g id="id38276_Graphic"> + <rect x="125.0625" y="272.44522" width="69.5" height="50.28088" fill="#f0f0f0"/> + <rect x="125.0625" y="272.44522" width="69.5" height="50.28088" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(130.0625 282.22824)" fill="black"> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="14.483398" y="12" textLength="7.769531">tr</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="22.170898" y="12" textLength="17.126953">affi</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="39.29785" y="12" textLength="5.71875">c</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="2.8964844" y="27.357422" textLength="31.529297">gener</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="34.34375" y="27.357422" textLength="10.476562">at</tspan> + <tspan font-family="Futura" font-size="12" font-weight="600" fill="black" x="44.902344" y="27.357422" textLength="11.701172">or</tspan> + </text> + </g> + </g> + <g> + <title>pvp</title> + <path d="M 195.06213 289.18618 C 258.56213 289.18618 348.18945 291.32988 386.18945 281.78994 C 424.18945 272.25 461.68945 257.75 465.18945 266.75 C 468.68945 275.75 436.68945 282.75 422.68945 286.25 C 408.68945 289.75 402.87695 288.75 402.68945 297.75" stroke="#aaa" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/> + </g> + </g> +</svg> diff --git a/docs/testing/user/userguide/images/nfvbench-spirent-setup.svg b/docs/testing/user/userguide/images/nfvbench-spirent-setup.svg new file mode 100644 index 0000000..e149fc0 --- /dev/null +++ b/docs/testing/user/userguide/images/nfvbench-spirent-setup.svg @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="169 216 693 327" width="693pt" height="327pt" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <metadata> Produced by OmniGraffle 7.2.1 + <dc:date>2016-12-03 22:53:19 +0000</dc:date> + </metadata> + <defs> + <font-face font-family="Monaco" font-size="10" units-per-em="1000" underline-position="-37.597656" underline-thickness="75.68359" slope="0" x-height="560.5469" cap-height="780.2734" ascent="1e3" descent="-250" font-weight="500"> + <font-face-src> + <font-face-name name="Monaco"/> + </font-face-src> + </font-face> + <font-face font-family="Candara" font-size="12" panose-1="2 14 5 2 3 3 3 2 2 4" units-per-em="1000" underline-position="-64.94141" underline-thickness="9.765625" slope="0" x-height="463.8672" cap-height="638.6719" ascent="952.1484" descent="-268.5547" font-weight="500"> + <font-face-src> + <font-face-name name="Candara"/> + </font-face-src> + </font-face> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="FilledBall_Marker" viewBox="-1 -4 8 8" markerWidth="8" markerHeight="8" color="#847b5a"> + <g> + <circle cx="2.9999986" cy="0" r="2.9999973" fill="currentColor" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="FilledBall_Marker_2" viewBox="-7 -4 8 8" markerWidth="8" markerHeight="8" color="#847b5a"> + <g> + <circle cx="-2.9999986" cy="0" r="2.9999973" fill="currentColor" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <font-face font-family="Helvetica" font-size="12" units-per-em="1000" underline-position="-75.68359" underline-thickness="49.316406" slope="0" x-height="522.9492" cap-height="717.28516" ascent="770.0195" descent="-229.98047" font-weight="500"> + <font-face-src> + <font-face-name name="Helvetica"/> + </font-face-src> + </font-face> + <font-face font-family="Helvetica Neue" font-size="12" panose-1="2 0 8 3 0 0 0 9 0 4" units-per-em="1000" underline-position="-100" underline-thickness="50" slope="0" x-height="517" cap-height="714" ascent="975.0061" descent="-216.99524" font-weight="bold"> + <font-face-src> + <font-face-name name="HelveticaNeue-Bold"/> + </font-face-src> + </font-face> + <font-face font-family="Monaco" font-size="18" units-per-em="1000" underline-position="-37.597656" underline-thickness="75.68359" slope="0" x-height="560.5469" cap-height="780.2734" ascent="1e3" descent="-250" font-weight="500"> + <font-face-src> + <font-face-name name="Monaco"/> + </font-face-src> + </font-face> + </defs> + <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"> + <title>nfvbench-spirent-setup</title> + <g> + <title>Layer 1</title> + <rect x="169.875" y="310.268" width="183.375" height="156.607" fill="#afb2e0"/> + <rect x="169.875" y="310.268" width="183.375" height="156.607" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(174.875 310.268)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="32.67871" y="10" textLength="108.01758">Mercury Build Node</tspan> + </text> + <path d="M 279.875 334.19787 L 335.78906 334.19787 C 341.8642 334.19787 346.78906 339.12274 346.78906 345.19787 L 346.78906 386.125 C 346.78906 392.20013 341.8642 397.125 335.78906 397.125 L 279.875 397.125 C 273.79987 397.125 268.875 392.20013 268.875 386.125 L 268.875 345.19787 C 268.875 339.12274 273.79987 334.19787 279.875 334.19787 Z" fill="#eaf2bf"/> + <path d="M 279.875 334.19787 L 335.78906 334.19787 C 341.8642 334.19787 346.78906 339.12274 346.78906 345.19787 L 346.78906 386.125 C 346.78906 392.20013 341.8642 397.125 335.78906 397.125 L 279.875 397.125 C 273.79987 397.125 268.875 392.20013 268.875 386.125 L 268.875 345.19787 C 268.875 339.12274 273.79987 334.19787 279.875 334.19787 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <path d="M 191.01562 334.19787 L 242.14062 334.19787 C 248.21576 334.19787 253.14062 339.12274 253.14062 345.19787 L 253.14062 442.804 C 253.14062 448.87915 248.21576 453.804 242.14062 453.804 L 191.01562 453.804 C 184.9405 453.804 180.01562 448.87915 180.01562 442.804 L 180.01562 345.19787 C 180.01562 339.12274 184.9405 334.19787 191.01562 334.19787 Z" fill="#eaf2bf"/> + <path d="M 191.01562 334.19787 L 242.14062 334.19787 C 248.21576 334.19787 253.14062 339.12274 253.14062 345.19787 L 253.14062 442.804 C 253.14062 448.87915 248.21576 453.804 242.14062 453.804 L 191.01562 453.804 C 184.9405 453.804 180.01562 448.87915 180.01562 442.804 L 180.01562 345.19787 C 180.01562 339.12274 184.9405 334.19787 191.01562 334.19787 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="185.375" y="420.9982" width="62.40625" height="26.889958" fill="#e7d9fe"/> + <rect x="185.375" y="420.9982" width="62.40625" height="26.889958" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(185.375 427.4432)" fill="black"> + <tspan font-family="Candara" font-size="12" font-weight="500" x="7.416992" y="11" textLength="47.572266">nfvbench</tspan> + </text> + <rect x="723.375" y="360.661" width="137.25" height="21.375" fill="#dae68e"/> + <rect x="723.375" y="360.661" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 364.43103)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="21.618164" y="10" textLength="84.01367">Compute node 1</tspan> + </text> + <rect x="507.375" y="344.49533" width="73.125" height="45.305643" fill="#d1d9e6"/> + <rect x="507.375" y="344.49533" width="73.125" height="45.305643" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(512.375 360.23067)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="10.559082" y="10" textLength="42.006836">N9K TOR</tspan> + </text> + <rect x="191.26562" y="343.58694" width="50.625" height="43.69141" fill="#e7d9fe"/> + <rect x="191.26562" y="343.58694" width="50.625" height="43.69141" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(196.26562 358.51517)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="5.3100586" y="10" textLength="30.004883">T-rex</tspan> + </text> + <path d="M 254.78125 434.4432 L 256.78125 434.4432 L 296.8802 434.4432 L 296.8802 395.77836 L 296.8802 393.77836" marker-end="url(#FilledBall_Marker)" marker-start="url(#FilledBall_Marker_2)" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="372.67188" y="346.10956" width="62.40625" height="43.69141" fill="#eae9dd"/> + <rect x="372.67188" y="346.10956" width="62.40625" height="43.69141" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(377.67188 361.0378)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="5.199707" y="10" textLength="42.006836">Spirent</tspan> + </text> + <line x1="507.375" y1="359.5972" x2="435.0781" y2="360.67336" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <rect x="723.375" y="217.125" width="137.25" height="21.375" fill="#fcc1b3"/> + <rect x="723.375" y="217.125" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 220.89502)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="27.61914" y="10" textLength="72.01172">Control Node</tspan> + </text> + <rect x="723.375" y="288.893" width="137.25" height="21.375" fill="#bbcee3"/> + <rect x="723.375" y="288.893" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 292.66303)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="42.62158" y="10" textLength="42.006836">Storage</tspan> + </text> + <line x1="507.375" y1="374.6991" x2="435.0781" y2="375.23717" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <rect x="723.375" y="238.5" width="137.25" height="21.375" fill="#fcc1b3"/> + <rect x="723.375" y="238.5" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 242.27002)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="27.61914" y="10" textLength="72.01172">Control Node</tspan> + </text> + <rect x="723.375" y="259.875" width="137.25" height="21.375" fill="#fcc1b3"/> + <rect x="723.375" y="259.875" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 263.64502)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="27.61914" y="10" textLength="72.01172">Control Node</tspan> + </text> + <rect x="723.375" y="310.268" width="137.25" height="21.375" fill="#bbcee3"/> + <rect x="723.375" y="310.268" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 314.03803)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="42.62158" y="10" textLength="42.006836">Storage</tspan> + </text> + <rect x="723.375" y="331.643" width="137.25" height="21.375" fill="#bbcee3"/> + <rect x="723.375" y="331.643" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 335.41303)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="42.62158" y="10" textLength="42.006836">Storage</tspan> + </text> + <rect x="723.375" y="432.429" width="137.25" height="21.375" fill="#dae68e"/> + <rect x="723.375" y="432.429" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 436.19904)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="21.618164" y="10" textLength="84.01367">Compute node i</tspan> + </text> + <rect x="507.375" y="286.33736" width="73.125" height="45.305643" fill="#d1d9e6"/> + <rect x="507.375" y="286.33736" width="73.125" height="45.305643" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(512.375 302.0727)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="10.559082" y="10" textLength="42.006836">N9K TOR</tspan> + </text> + <line x1="543.9375" y1="343.99533" x2="543.9375" y2="331.643" stroke="#2370ba" stroke-linecap="round" stroke-linejoin="round" stroke-width="6"/> + <path d="M 723.375 227.8125 L 716.875 227.8125 L 651.875 227.8125 L 651.875 308.9902 L 587 308.9902 L 580.5 308.9902" stroke="#2370ba" stroke-linecap="round" stroke-linejoin="round" stroke-width=".5"/> + <path d="M 723.375 231.375 L 716.875 231.375 L 657 231.375 L 657 353.018 L 657 359.5972 L 587 359.5972 L 580.5 359.5972" stroke="#2370ba" stroke-linecap="round" stroke-linejoin="round" stroke-width=".5"/> + <path d="M 723.375 443.1165 L 715.375 443.1165 L 672 443.1165 L 672 417.66667 L 672 374.6991 L 588.5 374.6991 L 580.5 374.6991" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <path d="M 723.375 435.9915 L 715.375 435.9915 L 679.3333 435.9915 L 679.3333 382.036 L 679.3333 315 L 580.5 315" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <rect x="723.375" y="482.822" width="137.25" height="21.375" fill="#dae68e"/> + <rect x="723.375" y="482.822" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 486.59205)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="21.618164" y="10" textLength="84.01367">Compute node N</tspan> + </text> + <path d="M 607.375 328.5 L 638 328.5 C 643.52285 328.5 648 332.97715 648 338.5 L 648 338.5 C 648 344.02285 643.52285 348.5 638 348.5 L 607.375 348.5 C 601.85215 348.5 597.375 344.02285 597.375 338.5 L 597.375 338.5 C 597.375 332.97715 601.85215 328.5 607.375 328.5 Z" fill="#e4e4e4"/> + <text transform="translate(607.375 331.5)" fill="#424242"> + <tspan font-family="Helvetica" font-size="12" font-weight="500" fill="#424242" x="3.977539" y="11" textLength="22.669922">vPC</tspan> + </text> + <path d="M 463.5 357.95526 L 470.5 357.95526 C 475.47056 357.95526 479.5 361.9847 479.5 366.95526 L 479.5 368.95526 C 479.5 373.92583 475.47056 377.95526 470.5 377.95526 L 463.5 377.95526 C 458.52944 377.95526 454.5 373.92583 454.5 368.95526 L 454.5 366.95526 C 454.5 361.9847 458.52944 357.95526 463.5 357.95526 Z" fill="#c75d5b"/> + <text transform="translate(463.5 360.28122)" fill="white"> + <tspan font-family="Helvetica Neue" font-size="12" font-weight="bold" fill="white" x="0" y="12" textLength="6.672">1</tspan> + </text> + <path d="M 256.78125 439.875 L 263.78125 439.875 C 268.7518 439.875 272.78125 443.90444 272.78125 448.875 L 272.78125 450.875 C 272.78125 455.84556 268.7518 459.875 263.78125 459.875 L 256.78125 459.875 C 251.8107 459.875 247.78125 455.84556 247.78125 450.875 L 247.78125 448.875 C 247.78125 443.90444 251.8107 439.875 256.78125 439.875 Z" fill="#c75d5b"/> + <text transform="translate(256.78125 442.20096)" fill="white"> + <tspan font-family="Helvetica Neue" font-size="12" font-weight="bold" fill="white" x="0" y="12" textLength="6.672">2</tspan> + </text> + <text transform="translate(308.75 514.29004)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x=".48828125" y="10" textLength="144.02344">pull spirent test center</tspan> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="3.4887695" y="23.83496" textLength="138.02246">and nfvbench containers</tspan> + </text> + <line x1="260.28125" y1="459.875" x2="303.75" y2="532.79167" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(472.875 414.775)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x=".4892578" y="10" textLength="132.02148">connect spirent to TOR</tspan> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="9.490723" y="23.83496" textLength="114.01855">with 2 x 10G cables</tspan> + </text> + <line x1="467" y1="377.95526" x2="493.875" y2="428.61" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(284.875 222.99854)" fill="black"> + <tspan font-family="Monaco" font-size="18" font-weight="500" x=".18066406" y="18" textLength="237.63867">nfvbench/Spirent setup</tspan> + </text> + <rect x="276.07812" y="343.58694" width="62.40625" height="43.69141" fill="#e7d9fe"/> + <rect x="276.07812" y="343.58694" width="62.40625" height="43.69141" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(281.07812 344.6802)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="5.199707" y="10" textLength="42.006836">Spirent</tspan> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="14.201172" y="23.83496" textLength="30.004883">Test </tspan> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="8.200195" y="37.66992" textLength="36.00586">Center</tspan> + </text> + <line x1="342.49312" y1="369.0503" x2="365.6765" y2="368.2091" marker-end="url(#FilledBall_Marker)" marker-start="url(#FilledBall_Marker_2)" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + </g> + </g> +</svg> diff --git a/docs/testing/user/userguide/images/nfvbench-trex-setup.svg b/docs/testing/user/userguide/images/nfvbench-trex-setup.svg new file mode 100644 index 0000000..3f68006 --- /dev/null +++ b/docs/testing/user/userguide/images/nfvbench-trex-setup.svg @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" version="1.1" viewBox="227 216 635 295" width="635pt" height="295pt" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <metadata> Produced by OmniGraffle 7.2.2 + <dc:date>2017-03-17 17:57:44 +0000</dc:date> + </metadata> + <defs> + <font-face font-family="Monaco" font-size="10" units-per-em="1000" underline-position="-37.597656" underline-thickness="75.68359" slope="0" x-height="560.5469" cap-height="780.2734" ascent="1e3" descent="-250" font-weight="500"> + <font-face-src> + <font-face-name name="Monaco"/> + </font-face-src> + </font-face> + <font-face font-family="Candara" font-size="12" panose-1="2 14 5 2 3 3 3 2 2 4" units-per-em="1000" underline-position="-64.94141" underline-thickness="9.765625" slope="0" x-height="463.8672" cap-height="638.6719" ascent="952.1484" descent="-268.5547" font-weight="500"> + <font-face-src> + <font-face-name name="Candara"/> + </font-face-src> + </font-face> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="FilledBall_Marker" viewBox="-1 -4 8 8" markerWidth="8" markerHeight="8" color="#847b5a"> + <g> + <circle cx="2.9999986" cy="0" r="2.9999973" fill="currentColor" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <marker orient="auto" overflow="visible" markerUnits="strokeWidth" id="FilledBall_Marker_2" viewBox="-7 -4 8 8" markerWidth="8" markerHeight="8" color="#847b5a"> + <g> + <circle cx="-2.9999986" cy="0" r="2.9999973" fill="currentColor" stroke="currentColor" stroke-width="1"/> + </g> + </marker> + <font-face font-family="Helvetica" font-size="12" units-per-em="1000" underline-position="-75.68359" underline-thickness="49.316406" slope="0" x-height="522.9492" cap-height="717.28516" ascent="770.0195" descent="-229.98047" font-weight="500"> + <font-face-src> + <font-face-name name="Helvetica"/> + </font-face-src> + </font-face> + <font-face font-family="Helvetica Neue" font-size="12" panose-1="2 0 8 3 0 0 0 9 0 4" units-per-em="1000" underline-position="-100" underline-thickness="50" slope="0" x-height="517" cap-height="714" ascent="975.0061" descent="-216.99524" font-weight="bold"> + <font-face-src> + <font-face-name name="HelveticaNeue-Bold"/> + </font-face-src> + </font-face> + <font-face font-family="Monaco" font-size="18" units-per-em="1000" underline-position="-37.597656" underline-thickness="75.68359" slope="0" x-height="560.5469" cap-height="780.2734" ascent="1e3" descent="-250" font-weight="500"> + <font-face-src> + <font-face-name name="Monaco"/> + </font-face-src> + </font-face> + </defs> + <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1"> + <title>nfvbench-trex-setup</title> + <g> + <title>Layer 1</title> + <rect x="228.375" y="310.268" width="182.09627" height="156.607" fill="#afb2e0"/> + <rect x="228.375" y="310.268" width="182.09627" height="156.607" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(233.375 310.268)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="32.039345" y="10" textLength="108.01758">Mercury Build Node</tspan> + </text> + <path d="M 253.06058 338.01395 L 317.68558 338.01395 C 323.7607 338.01395 328.68558 342.9388 328.68558 349.01395 L 328.68558 446.6201 C 328.68558 452.69523 323.7607 457.6201 317.68558 457.6201 L 253.06058 457.6201 C 246.98544 457.6201 242.06058 452.69523 242.06058 446.6201 L 242.06058 349.01395 C 242.06058 342.9388 246.98544 338.01395 253.06058 338.01395 Z" fill="#eaf2bf"/> + <path d="M 253.06058 338.01395 L 317.68558 338.01395 C 323.7607 338.01395 328.68558 342.9388 328.68558 349.01395 L 328.68558 446.6201 C 328.68558 452.69523 323.7607 457.6201 317.68558 457.6201 L 253.06058 457.6201 C 246.98544 457.6201 242.06058 452.69523 242.06058 446.6201 L 242.06058 349.01395 C 242.06058 342.9388 246.98544 338.01395 253.06058 338.01395 Z" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="254.25" y="423.5208" width="62.40625" height="26.889958" fill="#e7d9fe"/> + <rect x="254.25" y="423.5208" width="62.40625" height="26.889958" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(254.25 429.9658)" fill="black"> + <tspan font-family="Candara" font-size="12" font-weight="500" x="7.416992" y="11" textLength="47.572266">nfvbench</tspan> + </text> + <rect x="723.375" y="360.661" width="137.25" height="21.375" fill="#dae68e"/> + <rect x="723.375" y="360.661" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 364.43103)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="21.618164" y="10" textLength="84.01367">Compute node 1</tspan> + </text> + <rect x="507.375" y="344.49533" width="73.125" height="45.305643" fill="#d1d9e6"/> + <rect x="507.375" y="344.49533" width="73.125" height="45.305643" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(512.375 360.23067)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="10.559082" y="10" textLength="42.006836">N9K TOR</tspan> + </text> + <rect x="260.14062" y="346.10956" width="50.625" height="43.69141" fill="#e7d9fe"/> + <rect x="260.14062" y="346.10956" width="50.625" height="43.69141" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(265.14062 361.0378)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="5.3100586" y="10" textLength="30.004883">T-rex</tspan> + </text> + <path d="M 285.06086 417.03247 C 284.49295 405.99827 285.21095 406.6487 285.4074 396.29963" marker-end="url(#FilledBall_Marker)" marker-start="url(#FilledBall_Marker_2)" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <rect x="348.065" y="346.10956" width="62.40625" height="43.69141" fill="#eae9dd"/> + <rect x="348.065" y="346.10956" width="62.40625" height="43.69141" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(353.065 347.20282)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="11.200684" y="10" textLength="30.004883">Intel</tspan> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="14.201172" y="23.83496" textLength="24.003906">X710</tspan> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="17.20166" y="37.66992" textLength="18.00293">NIC</tspan> + </text> + <path d="M 507.375 308.9902 L 499.375 308.9902 L 458.875 308.9902 L 458.875 360.67336 L 418.47127 360.67336 L 410.47127 360.67336" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <rect x="723.375" y="217.125" width="137.25" height="21.375" fill="#fcc1b3"/> + <rect x="723.375" y="217.125" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 220.89502)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="27.61914" y="10" textLength="72.01172">Control Node</tspan> + </text> + <rect x="723.375" y="288.893" width="137.25" height="21.375" fill="#bbcee3"/> + <rect x="723.375" y="288.893" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 292.66303)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="42.62158" y="10" textLength="42.006836">Storage</tspan> + </text> + <line x1="507.375" y1="374.6991" x2="410.47127" y2="375.23717" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <rect x="723.375" y="238.5" width="137.25" height="21.375" fill="#fcc1b3"/> + <rect x="723.375" y="238.5" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 242.27002)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="27.61914" y="10" textLength="72.01172">Control Node</tspan> + </text> + <rect x="723.375" y="259.875" width="137.25" height="21.375" fill="#fcc1b3"/> + <rect x="723.375" y="259.875" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 263.64502)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="27.61914" y="10" textLength="72.01172">Control Node</tspan> + </text> + <rect x="723.375" y="310.268" width="137.25" height="21.375" fill="#bbcee3"/> + <rect x="723.375" y="310.268" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 314.03803)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="42.62158" y="10" textLength="42.006836">Storage</tspan> + </text> + <rect x="723.375" y="331.643" width="137.25" height="21.375" fill="#bbcee3"/> + <rect x="723.375" y="331.643" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 335.41303)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="42.62158" y="10" textLength="42.006836">Storage</tspan> + </text> + <rect x="723.375" y="432.429" width="137.25" height="21.375" fill="#dae68e"/> + <rect x="723.375" y="432.429" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 436.19904)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="21.618164" y="10" textLength="84.01367">Compute node i</tspan> + </text> + <rect x="507.375" y="286.33736" width="73.125" height="45.305643" fill="#d1d9e6"/> + <rect x="507.375" y="286.33736" width="73.125" height="45.305643" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(512.375 302.0727)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="10.559082" y="10" textLength="42.006836">N9K TOR</tspan> + </text> + <line x1="543.9375" y1="343.99533" x2="543.9375" y2="331.643" stroke="#2370ba" stroke-linecap="round" stroke-linejoin="round" stroke-width="6"/> + <path d="M 723.375 227.8125 L 716.875 227.8125 L 651.875 227.8125 L 651.875 308.9902 L 587 308.9902 L 580.5 308.9902" stroke="#2370ba" stroke-linecap="round" stroke-linejoin="round" stroke-width=".5"/> + <path d="M 723.375 231.375 L 716.875 231.375 L 657 231.375 L 657 353.018 L 657 359.5972 L 587 359.5972 L 580.5 359.5972" stroke="#2370ba" stroke-linecap="round" stroke-linejoin="round" stroke-width=".5"/> + <path d="M 723.375 443.1165 L 715.375 443.1165 L 672 443.1165 L 672 417.66667 L 672 374.6991 L 588.5 374.6991 L 580.5 374.6991" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <path d="M 723.375 435.9915 L 715.375 435.9915 L 679.3333 435.9915 L 679.3333 382.036 L 679.3333 315 L 580.5 315" stroke="#82645f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/> + <rect x="723.375" y="482.822" width="137.25" height="21.375" fill="#dae68e"/> + <rect x="723.375" y="482.822" width="137.25" height="21.375" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <text transform="translate(728.375 486.59205)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="21.618164" y="10" textLength="84.01367">Compute node N</tspan> + </text> + <line x1="317.26562" y1="367.95526" x2="341.565" y2="367.95526" marker-end="url(#FilledBall_Marker)" marker-start="url(#FilledBall_Marker_2)" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/> + <path d="M 607.375 328.5 L 638 328.5 C 643.52285 328.5 648 332.97715 648 338.5 L 648 338.5 C 648 344.02285 643.52285 348.5 638 348.5 L 607.375 348.5 C 601.85215 348.5 597.375 344.02285 597.375 338.5 L 597.375 338.5 C 597.375 332.97715 601.85215 328.5 607.375 328.5 Z" fill="#e4e4e4"/> + <text transform="translate(607.375 331.5)" fill="#424242"> + <tspan font-family="Helvetica" font-size="12" font-weight="500" fill="#424242" x="3.977539" y="11" textLength="22.669922">vPC</tspan> + </text> + <path d="M 348.5 378.5715 L 355.5 378.5715 C 360.47056 378.5715 364.5 382.60094 364.5 387.5715 L 364.5 389.5715 C 364.5 394.54207 360.47056 398.5715 355.5 398.5715 L 348.5 398.5715 C 343.52944 398.5715 339.5 394.54207 339.5 389.5715 L 339.5 387.5715 C 339.5 382.60094 343.52944 378.5715 348.5 378.5715 Z" fill="#c75d5b"/> + <text transform="translate(348.5 380.89746)" fill="white"> + <tspan font-family="Helvetica Neue" font-size="12" font-weight="bold" fill="white" x="0" y="12" textLength="6.672">1</tspan> + </text> + <path d="M 450 357.14815 L 457 357.14815 C 461.97056 357.14815 466 361.1776 466 366.14815 L 466 368.14815 C 466 373.1187 461.97056 377.14815 457 377.14815 L 450 377.14815 C 445.02944 377.14815 441 373.1187 441 368.14815 L 441 366.14815 C 441 361.1776 445.02944 357.14815 450 357.14815 Z" fill="#c75d5b"/> + <text transform="translate(450 359.4741)" fill="white"> + <tspan font-family="Helvetica Neue" font-size="12" font-weight="bold" fill="white" x="0" y="12" textLength="6.672">2</tspan> + </text> + <path d="M 320.625 443.25 L 327.625 443.25 C 332.59556 443.25 336.625 447.27944 336.625 452.25 L 336.625 454.25 C 336.625 459.22056 332.59556 463.25 327.625 463.25 L 320.625 463.25 C 315.65444 463.25 311.625 459.22056 311.625 454.25 L 311.625 452.25 C 311.625 447.27944 315.65444 443.25 320.625 443.25 Z" fill="#c75d5b"/> + <text transform="translate(320.625 445.57596)" fill="white"> + <tspan font-family="Helvetica Neue" font-size="12" font-weight="bold" fill="white" x="0" y="12" textLength="6.672">3</tspan> + </text> + <text transform="translate(451.625 452.9575)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x=".49121094" y="10" textLength="108.01758">add Intel X710 NIC</tspan> + </text> + <line x1="364.5" y1="388.5715" x2="446.625" y2="459.875" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(415.625 496.2075)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x=".48876953" y="10" textLength="138.02246">pull nfvbench container</tspan> + </text> + <line x1="336.625" y1="453.25" x2="410.625" y2="505.45833" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(492.75 406.65463)" fill="black"> + <tspan font-family="Monaco" font-size="10" font-weight="500" x=".4926758" y="10" textLength="90.01465">add a 10G cable</tspan> + <tspan font-family="Monaco" font-size="10" font-weight="500" x="12.494629" y="23.83496" textLength="66.01074">to each TOR</tspan> + </text> + <line x1="453.5" y1="377.14815" x2="492.75" y2="420.4896" stroke="#847b5a" stroke-linecap="round" stroke-linejoin="round" stroke-width="1" stroke-dasharray="4,4"/> + <text transform="translate(295.375 222.99854)" fill="black"> + <tspan font-family="Monaco" font-size="18" font-weight="500" x=".4824219" y="18" textLength="216.03516">nfvbench/T-rex setup</tspan> + </text> + </g> + </g> +</svg> diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst new file mode 100644 index 0000000..a7eb1e9 --- /dev/null +++ b/docs/testing/user/userguide/index.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + + +.. NFVBench documentation master file, created by + sphinx-quickstart on Thu Sep 29 14:25:18 2016. + + +NFVbench: A Network Performance Benchmarking Tool for NFVi Stacks +***************************************************************** + +The NFVbench tool provides an automated way to measure the network performance for the most common data plane packet flows on any OpenStack system. +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). + + +Table of Content +---------------- +.. toctree:: + :maxdepth: 2 + + readme + installation + examples + advanced + server + faq + + + diff --git a/docs/testing/user/userguide/installation.rst b/docs/testing/user/userguide/installation.rst new file mode 100644 index 0000000..8a0511a --- /dev/null +++ b/docs/testing/user/userguide/installation.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +=================================== +Installation and Quick Start Guides +=================================== + +.. toctree:: + :maxdepth: 2 + + hw_requirements + quickstart_docker + diff --git a/docs/testing/user/userguide/quickstart_docker.rst b/docs/testing/user/userguide/quickstart_docker.rst new file mode 100644 index 0000000..2c9f762 --- /dev/null +++ b/docs/testing/user/userguide/quickstart_docker.rst @@ -0,0 +1,224 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +=========================================== +NFVbench Installation and Quick Start Guide +=========================================== + +.. _docker_installation: + +Make sure you satisfy the `hardware and software requirements <requirements>` before you start . + + +1. Container installation +------------------------- + +To pull the latest NFVbench container image: + +.. code-block:: bash + + docker pull opnfv/nfvbench/nfvbench + +2. Docker Container configuration +--------------------------------- + +The NFVbench container requires the following Docker options to operate properly. + ++------------------------------------------------------+------------------------------------------------------+ +| Docker options | Description | ++======================================================+======================================================+ +| -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) | needed by kernel modules in the container | ++------------------------------------------------------+------------------------------------------------------+ +| -v /dev:/dev | needed by kernel modules in the container | ++------------------------------------------------------+------------------------------------------------------+ +| -v $PWD:/tmp/nfvbench | optional but recommended to pass files between the | +| | host and the docker space (see examples below) | +| | Here we map the current directory on the host to the | +| | /tmp/nfvbench director in the container but any | +| | other similar mapping can work as well | ++------------------------------------------------------+------------------------------------------------------+ +| --net=host | (optional) needed if you run the NFVbench REST | +| | server in the container (or use any appropriate | +| | docker network mode other than "host") | ++------------------------------------------------------+------------------------------------------------------+ +| --privilege | (optional) required if SELinux is enabled on the host| ++------------------------------------------------------+------------------------------------------------------+ + +It can be convenient to write a shell script (or an alias) to automatically insert the necessary options. + +3. Start the Docker container +----------------------------- +As for any Docker container, you can execute NFVbench measurement sessions using a temporary container ("docker run" - which exits after each NFVbench run) +or you can decide to run the NFVbench container in the background then execute one or more NFVbench measurement sessions on that container ("docker exec"). + +The former approach is simpler to manage (since each container is started and terminated after each command) but incurs a small delay at start time (several seconds). +The second approach is more responsive as the delay is only incurred once when starting the container. + +We will take the second approach and start the NFVbench container in detached mode with the name "nfvbench" (this works with bash, prefix with "sudo" if you do not use the root login) + +.. code-block:: bash + + docker run --detach --net=host --privileged -v $PWD:/tmp/nfvbench -v /dev:/dev -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) --name nfvbench opnfv/nfvbench tail -f /dev/null + +The tail command simply prevents the container from exiting. + +The create an alias to make it easy to execute nfvbench commands directly from the host shell prompt: + +.. code-block:: bash + + alias nfvbench='docker exec -it nfvbench nfvbench' + +The next to last "nfvbench" refers to the name of the container while the last "nfvbench" refers to the NFVbench binary that is available to run in the container. + +To verify it is working: + +.. code-block:: bash + + nfvbench --version + nfvbench --help + + +4. NFVbench configuration +------------------------- + +Create a new file containing the minimal configuration for NFVbench, we can call it any name, for example "my_nfvbench.cfg" and paste the following yaml template in the file: + +.. code-block:: bash + + openrc_file: + traffic_generator: + generator_profile: + - name: trex-local + tool: TRex + ip: 127.0.0.1 + cores: 3 + interfaces: + - port: 0 + switch_port: + pci: + - port: 1 + switch_port: + pci: + intf_speed: 10Gbps + +NFVbench requires an ``openrc`` file to connect to OpenStack using the OpenStack API. This file can be downloaded from the OpenStack Horizon dashboard (refer to the OpenStack documentation on how to +retrieve the openrc file). The file pathname in the container must be stored in the "openrc_file" property. If it is stored on the host in the current directory, its full pathname must start with /tmp/nfvbench (since the current directory is mapped to /tmp/nfvbench in the container). + +The required configuration is the PCI address of the 2 physical interfaces that will be used by the traffic generator. The PCI address can be obtained for example by using the "lspci" Linux command. For example: + +.. code-block:: bash + + [root@sjc04-pod6-build ~]# lspci | grep 710 + 0a:00.0 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01) + 0a:00.1 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01) + 0a:00.2 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01) + 0a:00.3 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01) + + +Example of edited configuration with an OpenStack RC file stored in the current directory with the "openrc" name, and +PCI addresses "0a:00.0" and "0a:00.1" (first 2 ports of the quad port NIC): + +.. code-block:: bash + + openrc_file: /tmp/nfvbench/openrc + traffic_generator: + generator_profile: + - name: trex-local + tool: TRex + ip: 127.0.0.1 + cores: 3 + interfaces: + - port: 0 + switch_port: + pci: 0a:00.0 + - port: 1 + switch_port: + pci: 0a:00.1 + intf_speed: 10Gbps + +Alternatively, the full template with comments can be obtained using the --show-default-config option in yaml format: + +.. code-block:: bash + + nfvbench --show-default-config > my_nfvbench.cfg + +Edit the nfvbench.cfg file to only keep those properties that need to be modified (preserving the nesting) + + +5. Upload the NFVbench loopback VM image to OpenStack +----------------------------------------------------- +[TBP URL to NFVbench VM image in the OPNFV artifact repository] + + +6. Run NFVbench +--------------- + +To do a single run at 5000pps bi-directional using the PVP packet path: + +.. code-block:: bash + + nfvbench -c /tmp/nfvbench/my_nfvbench.cfg --rate 5kpps + +NFVbench options used: + +* ``-c /tmp/nfvbench/my_nfvbench.cfg`` : specify the config file to use (this must reflect the file path from inside the container) +* ``--rate 5kpps`` : specify rate of packets for test using the kpps unit (thousands of packets per second) + +This should produce a result similar to this (a simple run with the above options should take less than 5 minutes): + +.. code-block:: none + + ========== nfvbench Summary ========== + Date: 2016-10-05 21:43:30 + nfvbench version 0.0.1.dev128 + Mercury version: 5002 + Benchmarks: + > Networks: + > N9K version: {'10.28.108.249': {'BIOS': '07.34', 'NXOS': '7.0(3)I2(2b)'}, '10.28.108.248': {'BIOS': '07.34', 'NXOS': '7.0(3)I2(2b)'}} + Traffic generator profile: trex-c45 + Traffic generator tool: TRex + Traffic generator API version: {u'build_date': u'Aug 24 2016', u'version': u'v2.08', u'built_by': u'hhaim', u'build_time': u'16:32:13'} + Flows: + > PVP: + VPP version: {u'sjc04-pod3-compute-6': 'v16.06-rc1~27-gd175728'} + > Bidirectional: False + Profile: traffic_profile_64B + + +-----------------+-------------+----------------------+----------------------+----------------------+ + | L2 Frame Size | Drop Rate | Avg Latency (usec) | Min Latency (usec) | Max Latency (usec) | + +=================+=============+======================+======================+======================+ + | 64 | 0.0000% | 22.1885 | 10 | 503 | + +-----------------+-------------+----------------------+----------------------+----------------------+ + + + > L2 frame size: 64 + Flow analysis duration: 70.0843 seconds + + Run Config: + + +-------------+------------------+--------------+-----------+ + | Direction | Duration (sec) | Rate | Rate | + +=============+==================+==============+===========+ + | Forward | 60 | 1.0080 Mbps | 1,500 pps | + +-------------+------------------+--------------+-----------+ + | Reverse | 60 | 672.0000 bps | 1 pps | + +-------------+------------------+--------------+-----------+ + + +----------------------+----------+-----------------+---------------+---------------+-----------------+---------------+---------------+ + | Interface | Device | Packets (fwd) | Drops (fwd) | Drop% (fwd) | Packets (rev) | Drops (rev) | Drop% (rev) | + +======================+==========+=================+===============+===============+=================+===============+===============+ + | traffic-generator | trex | 90,063 | | | 61 | 0 | - | + +----------------------+----------+-----------------+---------------+---------------+-----------------+---------------+---------------+ + | traffic-generator | trex | 90,063 | 0 | - | 61 | | | + +----------------------+----------+-----------------+---------------+---------------+-----------------+---------------+---------------+ + +7. Terminating the NFVbench container +------------------------------------- +When no longer needed, the container can be terminated using the usual docker commands: + +.. code-block:: bash + + docker kill nfvbench + docker rm nfvbench + diff --git a/docs/testing/user/userguide/readme.rst b/docs/testing/user/userguide/readme.rst new file mode 100644 index 0000000..17ce889 --- /dev/null +++ b/docs/testing/user/userguide/readme.rst @@ -0,0 +1,163 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +Features +******** + +Data Plane Performance Measurement Features +------------------------------------------- + +NFVbench supports the following main measurement capabilities: + +- supports 2 measurement modes: + - *fixed rate* mode to generate traffic at a fixed rate for a fixed duration + - NDR (No Drop Rate) and PDR (Partial Drop Rate) measurement mode +- configurable frame sizes (any list of fixed sizes or 'IMIX') +- built-in packet paths +- built-in loopback VNFs based on fast L2 or L3 forwarders running in VMs +- configurable number of flows and service chains +- configurable traffic direction (single or bi-directional) + + +NDR is the highest throughput achieved without dropping packets. +PDR is the highest throughput achieved without dropping more than a pre-set limit (called PDR threshold or allowance, expressed in %). + +Results of each run include the following data: + +- Aggregated achieved throughput in bps +- Aggregated achieved packet rate in pps (or fps) +- Actual drop rate in % +- Latency in usec (min, max, average in the current version) + +Built-in OpenStack support +-------------------------- +NFVbench can stage OpenStack resources to build 1 or more service chains using direct OpenStack APIs. Each service chain is composed of: + +- 1 or 2 loopback VM instances per service chain +- 2 Neutron networks per loopback VM + +OpenStack resources are staged before traffic is measured using OpenStack APIs (Nova and Neutron) then disposed after completion of measurements. + +The loopback VM flavor to use can be configured in the NFVbench configuration file. + +Note that NFVbench does not use OpenStack Heat nor any higher level service (VNFM or NFVO) to create the service chains because its +main purpose is to measure the performance of the NFVi infrastructure which is mainly focused on L2 forwarding performance. + +External Chains +--------------- +NFVbench also supports settings that involve externally staged packet paths with or without OpenStack: + +- run benchmarks on existing service chains at the L3 level that are staged externally by any other tool (e.g. any VNF capable of L3 routing) +- run benchmarks on existing L2 chains that are configured externally (e.g. pure L2 forwarder such as DPDK testpmd) + + +Traffic Generation +------------------ + +NFVbench currently integrates with the open source TRex traffic generator: + +- `TRex <https://trex-tgn.cisco.com>`_ (pre-built into the NFVbench container) + + +Supported Packet Paths +---------------------- +Packet paths describe where packets are flowing in the NFVi platform. The most commonly used paths are identified by 3 or 4 letter abbreviations. +A packet path can generally describe the flow of packets associated to one or more service chains, with each service chain composed of 1 or more VNFs. + +The following packet paths are currently supported by NFVbench: + +- PVP (Physical interface to VM to Physical interface) +- PVVP (Physical interface to VM to VM to Physical interface) +- N*PVP (N concurrent PVP packet paths) +- N*PVVP (N concurrent PVVP packet paths) + +The traffic is made of 1 or more flows of L3 frames (UDP packets) with different payload sizes. Each flow is identified by a unique source and destination MAC/IP tuple. + + +Loopback VM +^^^^^^^^^^^ + +NFVbench provides a loopback VM image that runs CentOS with 2 pre-installed forwarders: + +- DPDK testpmd configured to do L2 cross connect between 2 virtual interfaces +- FD.io VPP configured to perform L3 routing between 2 virtual interfaces + +Frames are just forwarded from one interface to the other. +In the case of testpmd, the source and destination MAC are rewritten, which corresponds to the mac forwarding mode (--forward-mode=mac). +In the case of VPP, VPP will act as a real L3 router, and the packets are routed from one port to the other using static routes. + +Which forwarder and what Nova flavor to use can be selected in the NFVbench configuration. Be default the DPDK testpmd forwarder is used with 2 vCPU per VM. +The configuration of these forwarders (such as MAC rewrite configuration or static route configuration) is managed by NFVbench. + + +PVP Packet Path +^^^^^^^^^^^^^^^ + +This packet path represents a single service chain with 1 loopback VNF and 2 Neutron networks: + +.. image:: images/nfvbench-pvp.svg + + +PVVP Packet Path +^^^^^^^^^^^^^^^^ + +This packet path represents a single service chain with 2 loopback VNFs in sequence and 3 Neutron networks. +The 2 VNFs can run on the same compute node (PVVP intra-node): + +.. image:: images/nfvbench-pvvp-intra.svg + +or on different compute nodes (PVVP inter-node) based on a configuration option: + +.. image:: images/nfvbench-pvvp-inter.svg + + + +Multi-Chaining (N*PVP or N*PVVP) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Multiple service chains can be setup by NFVbench without any limit on the concurrency (other than limits imposed by available resources on compute nodes). +In the case of multiple service chains, NFVbench will instruct the traffic generator to use multiple L3 packet streams (frames directed to each path will have a unique destination MAC address). + +Example of multi-chaining with 2 concurrent PVP service chains: + +.. image:: images/nfvbench-npvp.svg + +This innovative feature will allow to measure easily the performance of a fully loaded compute node running multiple service chains. + +Multi-chaining is currently limited to 1 compute node (PVP or PVVP intra-node) or 2 compute nodes (for PVVP inter-node). +The 2 edge interfaces for all service chains will share the same 2 networks. + + +Other Misc Packet Paths +^^^^^^^^^^^^^^^^^^^^^^^ + +P2P (Physical interface to Physical interface - no VM) can be supported using the external chain/L2 forwarding mode. + +V2V (VM to VM) is not supported but PVVP provides a more complete (and mroe realistic) alternative. + + +Supported Neutron Network Plugins and vswitches +----------------------------------------------- + +Any Virtual Switch, Any Encapsulation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +NFVbench is agnostic of the virtual switch implementation and has been tested with the following virtual switches: + +- ML2/VPP/VLAN (networking-vpp) +- OVS/VLAN and OVS-DPDK/VLAN +- ML2/ODL/VPP (OPNFV Fast Data Stack) + +SR-IOV +^^^^^^ + +By default, service chains will be based on virtual switch interfaces. + +NFVbench provides an option to select SR-IOV based virtual interfaces instead (thus bypassing any virtual switch) for those OpenStack system that include and support SR-IOV capable NICs on compute nodes. + + + + + + diff --git a/docs/testing/user/userguide/server.rst b/docs/testing/user/userguide/server.rst new file mode 100644 index 0000000..4495e19 --- /dev/null +++ b/docs/testing/user/userguide/server.rst @@ -0,0 +1,445 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Cisco Systems, Inc + +NFVbench Server mode and NFVbench client API +============================================ + +NFVbench can run as an HTTP server to: + +- optionally provide access to any arbitrary HTLM files (HTTP server function) - this is optional +- service fully parameterized aynchronous run requests using the HTTP protocol (REST/json with polling) +- service fully parameterized run requests with interval stats reporting using the WebSocket/SocketIO protocol. + +Start the NFVbench server +------------------------- +To run in server mode, simply use the --server <http_root_path> and optionally the listen address to use (--host <ip>, default is 0.0.0.0) and listening port to use (--port <port>, default is 7555). + + +If HTTP files are to be serviced, they must be stored right under the http root path. +This root path must contain a static folder to hold static files (css, js) and a templates folder with at least an index.html file to hold the template of the index.html file to be used. +This mode is convenient when you do not already have a WEB server hosting the UI front end. +If HTTP files servicing is not needed (REST only or WebSocket/SocketIO mode), the root path can point to any dummy folder. + +Once started, the NFVbench server will be ready to service HTTP or WebSocket/SocketIO requests at the advertised URL. + +Example of NFVbench server start in a container: + +.. code-block:: bash + + # get to the container shell (assume the container name is "nfvbench") + docker exec -it nfvbench bash + # from the container shell start the NFVbench server in the background + nfvbench -c /tmp/nfvbench/nfvbench.cfg --server /tmp & + # exit container + exit + + + +HTTP Interface +-------------- + +<http-url>/echo (GET) +^^^^^^^^^^^^^^^^^^^^^ + +This request simply returns whatever content is sent in the body of the request (only used for testing) + +<http-url>/start_run (POST) +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This request will initiate a new NFVbench run asynchornously and can optionally pass the NFVbench configuration to run in the body (in JSON format). +See "NFVbench configuration JSON parameter" below for details on how to format this parameter. + +The request returns immediately with a json content indicating if there was an error (status=ERROR) or if the request was submitted successfully (status=PENDING). Example of return when the submission is successful: + +.. code-block:: bash + + { + "error_message": "nfvbench run still pending", + "status": "PENDING" + } + +<http-url>/status (GET) +^^^^^^^^^^^^^^^^^^^^^^^ + +This request fetches the status of an asynchronous run. It will return in json format: + +- a request pending reply (if the run is still not completed) +- an error reply if there is no run pending +- or the complete result of the run + +The client can keep polling until the run completes. + +Example of return when the run is still pending: + +.. code-block:: bash + + { + "error_message": "nfvbench run still pending", + "status": "PENDING" + } + +Example of return when the run completes: + +.. code-block:: bash + + { + "result": {...} + "status": "OK" + } + + + +WebSocket/SocketIO events +------------------------- + +List of SocketIO events supported: + +Client to Server +^^^^^^^^^^^^^^^^ + +start_run: + + sent by client to start a new run with the configuration passed in argument (JSON). + The configuration can be any valid NFVbench configuration passed as a JSON document (see "NFVbench configuration JSON parameter" below) + +Server to Client +^^^^^^^^^^^^^^^^ + +run_interval_stats: + + sent by server to report statistics during a run + the message contains the statistics {'time_ms': time_ms, 'tx_pps': tx_pps, 'rx_pps': rx_pps, 'drop_pct': drop_pct} + +ndr_found: + + (during NDR-PDR search) + sent by server when the NDR rate is found + the message contains the NDR value {'rate_pps': ndr_pps} + +ndr_found: + + (during NDR-PDR search) + sent by server when the PDR rate is found + the message contains the PDR value {'rate_pps': pdr_pps} + + +run_end: + + sent by server to report the end of a run + the message contains the complete results in JSON format + +NFVbench configuration JSON parameter +------------------------------------- +The NFVbench configuration describes the parameters of an NFVbench run and can be passed to the NFVbench server as a JSON document. + +Default configuration +^^^^^^^^^^^^^^^^^^^^^ + +The simplest JSON document is the empty dictionary "{}" which indicates to use the default NFVbench configuration: + +- PVP +- NDR-PDR measurement +- 64 byte packets +- 1 flow per direction + +The entire default configuration can be viewed using the --show-json-config option on the cli: + +.. code-block:: bash + + # nfvbench --show-json-config + { + "availability_zone": null, + "compute_node_user": "root", + "compute_nodes": null, + "debug": false, + "duration_sec": 60, + "flavor": { + "disk": 0, + "extra_specs": { + "hw:cpu_policy": "dedicated", + "hw:mem_page_size": 2048 + }, + "ram": 8192, + "vcpus": 2 + }, + "flavor_type": "nfv.medium", + "flow_count": 1, + "generic_poll_sec": 2, + "generic_retry_count": 100, + "image_name": "nfvbenchvm", + "inter_node": false, + "internal_networks": { + "left": { + "name": "nfvbench-net0", + "subnet": "nfvbench-subnet0", + "cidr": "192.168.1.0/24", + }, + "right": { + "name": "nfvbench-net1", + "subnet": "nfvbench-subnet1", + "cidr": "192.168.2.0/24", + }, + "middle": { + "name": "nfvbench-net2", + "subnet": "nfvbench-subnet2", + "cidr": "192.168.3.0/24", + } + }, + "interval_sec": 10, + "json": null, + "loop_vm_name": "nfvbench-loop-vm", + "measurement": { + "NDR": 0.001, + "PDR": 0.1, + "load_epsilon": 0.1 + }, + "name": "(built-in default config)", + "no_cleanup": false, + "no_int_config": false, + "no_reset": false, + "no_tor_access": false, + "no_traffic": false, + "no_vswitch_access": false, + "openrc_file": "/tmp/nfvbench/openstack/openrc", + "openstack_defaults": "/tmp/nfvbench/openstack/defaults.yaml", + "openstack_setup": "/tmp/nfvbench/openstack/setup_data.yaml", + "rate": "ndr_pdr", + "service_chain": "PVP", + "service_chain_count": 1, + "sriov": false, + "std_json": null, + "tor": { + "switches": [ + { + "host": "172.26.233.12", + "password": "lab", + "port": 22, + "username": "admin" + } + ], + "type": "N9K" + }, + "traffic": { + "bidirectional": true, + "profile": "traffic_profile_64B" + }, + "traffic_generator": { + "default_profile": "trex-local", + "gateway_ip_addrs": [ + "1.1.0.2", + "2.2.0.2" + ], + "gateway_ip_addrs_step": "0.0.0.1", + "generator_profile": [ + { + "cores": 3, + "interfaces": [ + { + "pci": "0a:00.0", + "port": 0, + "switch_port": "Ethernet1/33", + "vlan": null + }, + { + "pci": "0a:00.1", + "port": 1, + "switch_port": "Ethernet1/34", + "vlan": null + } + ], + "intf_speed": "10Gbps", + "ip": "127.0.0.1", + "name": "trex-local", + "tool": "TRex" + } + ], + "host_name": "nfvbench_tg", + "ip_addrs": [ + "10.0.0.0/8", + "20.0.0.0/8" + ], + "ip_addrs_step": "0.0.0.1", + "mac_addrs": [ + "00:10:94:00:0A:00", + "00:11:94:00:0A:00" + ], + "step_mac": null, + "tg_gateway_ip_addrs": [ + "1.1.0.100", + "2.2.0.100" + ], + "tg_gateway_ip_addrs_step": "0.0.0.1" + }, + "traffic_profile": [ + { + "l2frame_size": [ + "64" + ], + "name": "traffic_profile_64B" + }, + { + "l2frame_size": [ + "IMIX" + ], + "name": "traffic_profile_IMIX" + }, + { + "l2frame_size": [ + "1518" + ], + "name": "traffic_profile_1518B" + }, + { + "l2frame_size": [ + "64", + "IMIX", + "1518" + ], + "name": "traffic_profile_3sizes" + } + ], + "unidir_reverse_traffic_pps": 1, + "vlan_tagging": true, + "vm_image_file": "file://172.29.172.152/downloads/nfvbench/nfvbenchvm-latest.qcow2", + "vts_ncs": { + "host": null, + "password": "secret", + "port": 22, + "username": "admin" + } + } + + +Common examples of JSON configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Use the default configuration but use 10000 flows per direction (instead of 1): + +.. code-block:: bash + + { "flow_count": 10000 } + + +Use default confguration but with 10000 flows, "EXT" chain and IMIX packet size: + +.. code-block:: bash + + { + "flow_count": 10000, + "service_chain": "EXT", + "traffic": { + "profile": "traffic_profile_IMIX" + }, + } + +A short run of 5 seconds at a fixed rate of 1Mpps (and everything else same as the default configuration): + +.. code-block:: bash + + { + "duration": 5, + "rate": "1Mpps" + } + +Example of interaction with the NFVbench server using HTTP and curl +------------------------------------------------------------------- +HTTP requests can be sent directly to the NFVbench server from CLI using curl from any host that can connect to the server (here we run it from the local host). + +This is a POST request to start a run using the default NFVbench configuration but with traffic generation disabled ("no_traffic" property is set to true): + +.. code-block:: bash + + [root@sjc04-pod3-mgmt ~]# curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"no_traffic":true}' http://127.0.0.1:7555/start_run + { + "error_message": "nfvbench run still pending", + "status": "PENDING" + } + [root@sjc04-pod3-mgmt ~]# + +This request will return immediately with status set to "PENDING" if the request was started successfully. + +The status can be polled until the run completes. Here the poll returns a "PENDING" status, indicating the run is still not completed: + +.. code-block:: bash + + [root@sjc04-pod3-mgmt ~]# curl -G http://127.0.0.1:7555/status + { + "error_message": "nfvbench run still pending", + "status": "PENDING" + } + [root@sjc04-pod3-mgmt ~]# + +Finally, the status request returns a "OK" status along with the full results (truncated here): + +.. code-block:: bash + + [root@sjc04-pod3-mgmt ~]# curl -G http://127.0.0.1:7555/status + { + "result": { + "benchmarks": { + "network": { + "service_chain": { + "PVP": { + "result": { + "bidirectional": true, + "compute_nodes": { + "nova:sjc04-pod3-compute-4": { + "bios_settings": { + "Adjacent Cache Line Prefetcher": "Disabled", + "All Onboard LOM Ports": "Enabled", + "All PCIe Slots OptionROM": "Enabled", + "Altitude": "300 M", + ... + + "date": "2017-03-31 22:15:41", + "nfvbench_version": "0.3.5", + "openstack_spec": { + "encaps": "VxLAN", + "vswitch": "VTS" + } + }, + "status": "OK" + } + [root@sjc04-pod3-mgmt ~]# + + + +Example of interaction with the NFVbench server using a python CLI app (nfvbench_client) +---------------------------------------------------------------------------------------- +The module client/client.py contains an example of python class that can be used to control the NFVbench server from a python app using HTTP or WebSocket/SocketIO. + +The module client/nfvbench_client.py has a simple main application to control the NFVbench server from CLI. +The "nfvbench_client" wrapper script can be used to invoke the client front end (this wrapper is pre-installed in the NFVbench container) + +Example of invocation of the nfvbench_client front end, from the host (assume the name of the NFVbench container is "nfvbench"), +use the default NFVbench configuration but do not generate traffic (no_traffic property set to true, the full json result is truncated here): + +.. code-block:: bash + + [root@sjc04-pod3-mgmt ~]# docker exec -it nfvbench nfvbench_client -c '{"no_traffic":true}' http://127.0.0.1:7555 + {u'status': u'PENDING', u'error_message': u'nfvbench run still pending'} + {u'status': u'PENDING', u'error_message': u'nfvbench run still pending'} + {u'status': u'PENDING', u'error_message': u'nfvbench run still pending'} + + {u'status': u'OK', u'result': {u'date': u'2017-03-31 22:04:59', u'nfvbench_version': u'0.3.5', + u'config': {u'compute_nodes': None, u'compute_node_user': u'root', u'vts_ncs': {u'username': u'admin', u'host': None, u'password': u'secret', u'port': 22}, u'traffic_generator': {u'tg_gateway_ip_addrs': [u'1.1.0.100', u'2.2.0.100'], u'ip_addrs_step': u'0.0.0.1', u'step_mac': None, u'generator_profile': [{u'intf_speed': u'10Gbps', u'interfaces': [{u'pci': u'0a:00.0', u'port': 0, u'vlan': 1998, u'switch_port': None}, + + ... + + [root@sjc04-pod3-mgmt ~]# + +The http interface is used unless --use-socketio is defined. + +Example of invocation using Websocket/SocketIO, execute NFVbench using the default configuration but with a duration of 5 seconds and a fixed rate run of 5kpps. + +.. code-block:: bash + + [root@sjc04-pod3-mgmt ~]# docker exec -it nfvbench nfvbench_client -c '{"duration":5,"rate":"5kpps"}' --use-socketio http://127.0.0.1:7555 >results.json + + + + + + + |
