diff options
Diffstat (limited to 'docs/testing/user/configguide')
| -rw-r--r-- | docs/testing/user/configguide/index.rst | 52 | ||||
| -rw-r--r-- | docs/testing/user/configguide/installation.rst | 40 | ||||
| -rw-r--r-- | docs/testing/user/configguide/tools.rst | 34 | ||||
| -rw-r--r-- | docs/testing/user/configguide/trafficgen.rst | 72 | ||||
| -rw-r--r-- | docs/testing/user/configguide/upgrade.rst | 20 |
5 files changed, 111 insertions, 107 deletions
diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst index 87c32d11..2a69cbe1 100644 --- a/docs/testing/user/configguide/index.rst +++ b/docs/testing/user/configguide/index.rst @@ -2,46 +2,48 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others. -.. OPNFV VSPERF Documentation master file. +.. Anuket ViNePerf Documentation master file. -*********************************** -VSPERF Configuration and User Guide -*********************************** +************************************* +ViNePerf Configuration and User Guide +************************************* ============ Introduction ============ -VSPERF is an OPNFV testing project. +ViNePerf is an OPNFV testing project. -VSPERF provides an automated test-framework and comprehensive test suite based on Industry +ViNePerf provides an automated test-framework and comprehensive test suite based on Industry Test Specifications for measuring NFVI data-plane performance. The data-path includes switching technologies with -physical and virtual network interfaces. The VSPERF architecture is switch and traffic generator agnostic and test -cases can be easily customized. VSPERF was designed to be independent of OpenStack therefore OPNFV installer scenarios -are not required. VSPERF can source, configure and deploy the device-under-test using specified software versions and -network topology. VSPERF is used as a development tool for optimizing switching technologies, qualification of packet +physical and virtual network interfaces. The ViNePerf architecture is switch and traffic generator agnostic and test +cases can be easily customized. ViNePerf was designed to be independent of OpenStack therefore OPNFV installer scenarios +are not required. ViNePerf can source, configure and deploy the device-under-test using specified software versions and +network topology. ViNePerf is used as a development tool for optimizing switching technologies, qualification of packet processing functions and for evaluation of data-path performance. -The Euphrates release adds new features and improvements that will help advance high performance packet processing +The Kali release adds new features and improvements that will help advance high performance packet processing on Telco NFV platforms. This includes new test cases, flexibility in customizing test-cases, new results display options, improved tool resiliency, additional traffic generator support and VPP support. -VSPERF provides a framework where the entire NFV Industry can learn about NFVI data-plane performance and try-out -new techniques together. A new IETF benchmarking specification (RFC8204) is based on VSPERF work contributed since -2015. VSPERF is also contributing to development of ETSI NFV test specifications through the Test and Open Source +The support for Openstack and Kubernetes was added in Jerma release, and Kali release adds additional testcases to it. + +ViNePerf provides a framework where the entire NFV Industry can learn about NFVI data-plane performance and try-out +new techniques together. A new IETF benchmarking specification (RFC8204) is based on ViNePerf work contributed since +2015. ViNePerf is also contributing to development of ETSI NFV test specifications through the Test and Open Source Working Group. -* Wiki: https://wiki.opnfv.org/display/vsperf -* Repository: https://git.opnfv.org/vswitchperf +* Wiki: https://wiki.anuket.io/display/HOME/ViNePERF +* Repository: https://git.opnfv.org/vineperf * Artifacts: https://artifacts.opnfv.org/vswitchperf.html -* Continuous Integration: https://build.opnfv.org/ci/view/vswitchperf/ +* Continuous Integration: https://build.opnfv.org/ci/view/vineperf/ -================================ -VSPERF Install and Configuration -================================ +================================== +ViNePerf Install and Configuration +================================== .. toctree:: - :caption: VSPERF Install, Upgrade, Traffic Generator Guide + :caption: ViNePerf Install, Upgrade, Traffic Generator Guide :maxdepth: 2 :numbered: @@ -50,12 +52,12 @@ VSPERF Install and Configuration ./trafficgen.rst ./tools.rst -================= -VSPERF Test Guide -================= +=================== +ViNePerf Test Guide +=================== .. toctree:: - :caption: VSPERF Test Execution + :caption: ViNePerf Test Execution :maxdepth: 2 ../userguide/testusage.rst diff --git a/docs/testing/user/configguide/installation.rst b/docs/testing/user/configguide/installation.rst index b950442e..4665c9e9 100644 --- a/docs/testing/user/configguide/installation.rst +++ b/docs/testing/user/configguide/installation.rst @@ -5,15 +5,15 @@ .. _vsperf-installation: ====================== -Installing vswitchperf +Installing ViNePerf ====================== -Downloading vswitchperf +Downloading ViNeperf ----------------------- -The vswitchperf can be downloaded from its official git repository, which is +The ViNePerf can be downloaded from its official git repository, which is hosted by OPNFV. It is necessary to install a ``git`` at your DUT before downloading -vswitchperf. Installation of ``git`` is specific to the packaging system used by +vineperf. Installation of ``git`` is specific to the packaging system used by Linux OS installed at DUT. Example of installation of GIT package and its dependencies: @@ -31,14 +31,14 @@ Example of installation of GIT package and its dependencies: sudo apt-get install git -After the ``git`` is successfully installed at DUT, then vswitchperf can be downloaded +After the ``git`` is successfully installed at DUT, then vineperf can be downloaded as follows: .. code:: bash - git clone http://git.opnfv.org/vswitchperf + git clone https://gerrit.opnfv.org/gerrit/vineperf -The last command will create a directory ``vswitchperf`` with a local copy of vswitchperf +The last command will create a directory ``vineperf`` with a local copy of vineperf repository. Supported Operating Systems @@ -47,6 +47,7 @@ Supported Operating Systems * CentOS 7.3 * Fedora 24 (kernel 4.8 requires DPDK 16.11 and newer) * Fedora 25 (kernel 4.9 requires DPDK 16.11 and newer) +* Fedora 33 * openSUSE 42.2 * openSUSE 42.3 * openSUSE Tumbleweed @@ -57,6 +58,7 @@ Supported Operating Systems * Ubuntu 14.04 * Ubuntu 16.04 * Ubuntu 16.10 (kernel 4.8 requires DPDK 16.11 and newer) +* Ubuntu 20.04 Supported vSwitches ------------------- @@ -79,8 +81,8 @@ Supported VNFs In theory, it is possible to use any VNF image, which is compatible with supported hypervisor. However such VNF must ensure, that appropriate number of network interfaces is configured and that traffic is properly -forwarded among them. For new vswitchperf users it is recommended to start -with official vloop-vnf_ image, which is maintained by vswitchperf community. +forwarded among them. For new ViNePerf users it is recommended to start +with official vloop-vnf_ image, which is maintained by ViNePerf community. .. _vloop-vnf: @@ -162,23 +164,23 @@ automatically. Script **build_base_machine.sh** will install all the vsperf dependencies in terms of system packages, Python 3.x and required Python modules. -In case of CentOS 7 or RHEL it will install Python 3.3 from an additional +In case of CentOS 7 or RHEL it will install Python 3.8 from an additional repository provided by Software Collections (`a link`_). The installation script will also use `virtualenv`_ to create a vsperf virtual environment, which is isolated from the default Python environment, using the Python3 package located in **/usr/bin/python3**. This environment will reside in a directory called -**vsperfenv** in $HOME. +**vsperfenv** in $HOME. It will ensure, that system wide Python installation is not modified or -broken by VSPERF installation. +broken by ViNePerf installation. The complete list of Python packages installed inside virtualenv can be found in the file -``requirements.txt``, which is located at the vswitchperf repository. +``requirements.txt``, which is located at the ViNePerf repository. **NOTE:** For RHEL 7.3 Enterprise and CentOS 7.3 OVS Vanilla is not built from upstream source due to kernel incompatibilities. Please see the -instructions in the vswitchperf_design document for details on configuring +instructions in the ViNePerf_design document for details on configuring OVS Vanilla for binary package usage. **NOTE:** For RHEL 7.5 Enterprise DPDK and Openvswitch are not built from @@ -202,7 +204,7 @@ issue by simply downloading the file. $ wget https://dl.fedoraproject.org/pub/epel/RPM-GPG-KEY-EPEL-7 -Using vswitchperf +Using ViNePerf ----------------- You will need to activate the virtual environment every time you start a @@ -221,12 +223,12 @@ new shell session. Its activation is specific to your OS: $ source $HOME/vsperfenv/bin/activate -After the virtual environment is configued, then VSPERF can be used. +After the virtual environment is configued, then ViNePerf can be used. For example: .. code:: bash - (vsperfenv) $ cd vswitchperf + (vsperfenv) $ cd vineperf (vsperfenv) $ ./vsperf --help Gotcha @@ -237,7 +239,7 @@ In case you will see following error during environment activation: .. code:: bash $ source $HOME/vsperfenv/bin/activate - Badly placed ()'s. + Badly placed ()s. then check what type of shell you are using: @@ -284,7 +286,7 @@ VSPerf supports the default DPDK bind tool, but also supports driverctl. The driverctl tool is a new tool being used that allows driver binding to be persistent across reboots. The driverctl tool is not provided by VSPerf, but can be downloaded from upstream sources. Once installed set the bind tool to -driverctl to allow VSPERF to correctly bind cards for DPDK tests. +driverctl to allow ViNePerf to correctly bind cards for DPDK tests. .. code:: python diff --git a/docs/testing/user/configguide/tools.rst b/docs/testing/user/configguide/tools.rst index 72e515fa..617d67bc 100644 --- a/docs/testing/user/configguide/tools.rst +++ b/docs/testing/user/configguide/tools.rst @@ -5,19 +5,19 @@ .. _additional-tools-configuration: ============================================= -'vsperf' Additional Tools Configuration Guide +ViNePerf Additional Tools Configuration Guide ============================================= Overview -------- -VSPERF supports the following categories additional tools: +ViNePerf supports the following categories additional tools: * `Infrastructure Metrics Collectors`_ * `Load Generators`_ * `L3 Cache Management`_ -Under each category, there are one or more tools supported by VSPERF. +Under each category, there are one or more tools supported by ViNePerf. This guide provides the details of how to install (if required) and configure the above mentioned tools. @@ -26,13 +26,13 @@ and configure the above mentioned tools. Infrastructure Metrics Collection --------------------------------- -VSPERF supports following two tools for collecting and reporting the metrics: +ViNePerf supports following two tools for collecting and reporting the metrics: * pidstat * collectd *pidstat* is a command in linux systems, which is used for monitoring individual -tasks currently being managed by Linux kernel. In VSPERF this command is used to +tasks currently being managed by Linux kernel. In ViNePerf this command is used to monitor *ovs-vswitchd*, *ovsdb-server* and *kvm* processes. *collectd* is linux application that collects, stores and transfers various system @@ -46,10 +46,10 @@ Installation No installation is required for *pidstat*, whereas, collectd has to be installed separately. For installation of collectd, we recommend to follow the process described -in *OPNFV-Barometer* project, which can be found here `Barometer <https://opnfv-barometer.readthedocs.io/en/latest/release/userguide>`_ +in *Anuket-Barometer* project, which can be found here `Barometer <https://opnfv-barometer.readthedocs.io/en/latest/release/userguide>`_ recent release. -VSPERF assumes that collectd is installed and configured to send metrics over localhost. +ViNePerf assumes that collectd is installed and configured to send metrics over localhost. The metrics sent should be for the following categories: CPU, Processes, Interface, OVS, DPDK, Intel-RDT. @@ -97,9 +97,9 @@ The *collectd* configuration option includes: Load Generation --------------- -In VSPERF, load generation refers to creating background cpu and memory loads to +In ViNePerf, load generation refers to creating background cpu and memory loads to study the impact of these loads on system under test. There are two options to -create loads in VSPERF. These options are used for different use-cases. The options are: +create loads in ViNePerf. These options are used for different use-cases. The options are: * stress or stress-ng * Stressor-VMs @@ -148,12 +148,12 @@ load-generation. However, for StressorVMs, following configurations apply: Last Level Cache Management --------------------------- -VSPERF support last-level cache management using Intel's RDT tool(s) - the +ViNePerf support last-level cache management using Intel's RDT tool(s) - the relavant ones are `Intel CAT-CMT <https://github.com/intel/intel-cmt-cat>`_ and `Intel RMD <https://github.com/intel/rmd>`_. RMD is a linux daemon that runs on individual hosts, and provides a REST API for control/orchestration layer to request LLC for the VMs/Containers/Applications. RDT receives resource policy -form orchestration layer - in this case, from VSPERF - and enforce it on the host. +form orchestration layer - in this case, from ViNePerf - and enforce it on the host. It achieves this enforcement via kernel interfaces such as resctrlfs and libpqos. The resource here refer to the last-level cache. User can configure policies to define how much of cache a CPU can get. The policy configuration is described below. @@ -170,7 +170,7 @@ Configuration The configuration file for cache management can be found in **conf/08_llcmanagement.conf**. -VSPERF provides following configuration options, for user to define and enforce policies via RMD. +ViNePerf provides following configuration options, for user to define and enforce policies via RMD. * ``LLC_ALLOCATION`` - Enable or Disable LLC management. * ``RMD_PORT`` - RMD port (port number on which API server is listening) @@ -186,15 +186,15 @@ VSPERF provides following configuration options, for user to define and enforce * ``PMD_CA`` - [min-cache-value, max-cache-value] for PMD * ``NOISEVM_CA`` - [min-cache-value, max-cache-value] for Noisy VM -VSPERF Containers ------------------ +ViNePerf Containers +------------------- -VSPERF containers are found in tools/docker folder. +ViNePerf containers are found in tools/docker folder. RESULTS CONTAINER ^^^^^^^^^^^^^^^^^ -The results container includes multiple services - ELK Stack, Barometer-Grafana, OPNFV-TestAPI & Jupyter. +The results container includes multiple services - ELK Stack, Barometer-Grafana, Anuket-TestAPI & Jupyter. Pre-Deployment Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -205,7 +205,7 @@ Pre-Deployment Configuration 2. You may want to modify the IP address from 0.0.0.0 to appropriate host-ip in ``docker-compose.yml`` -3. Please add dashboards folder from OPNFV-Barometer-Grafana into the grafana folder. It can be found in `Barometer Grafana <https://github.com/opnfv/barometer/tree/master/docker/barometer-grafana` +3. Please add dashboards folder from Anuket-Barometer-Grafana into the grafana folder. It can be found in `Barometer Grafana <https://github.com/opnfv/barometer/tree/master/docker/barometer-grafana` Build ~~~~~ diff --git a/docs/testing/user/configguide/trafficgen.rst b/docs/testing/user/configguide/trafficgen.rst index 3bb09d52..b018d37d 100644 --- a/docs/testing/user/configguide/trafficgen.rst +++ b/docs/testing/user/configguide/trafficgen.rst @@ -5,13 +5,13 @@ .. _trafficgen-installation: =========================== -'vsperf' Traffic Gen Guide +ViNePerf Traffic Gen Guide =========================== Overview -------- -VSPERF supports the following traffic generators: +ViNePerf supports the following traffic generators: * Dummy_ (DEFAULT) * Ixia_ @@ -136,15 +136,15 @@ If you use imix, set the TRAFFICGEN_PKT_SIZES to 0. Dummy ----- -The Dummy traffic generator can be used to test VSPERF installation or -to demonstrate VSPERF functionality at DUT without connection +The Dummy traffic generator can be used to test ViNePerf installation or +to demonstrate ViNePerf functionality at DUT without connection to a real traffic generator. You could also use the Dummy generator in case, that your external -traffic generator is not supported by VSPERF. In such case you could -use VSPERF to setup your test scenario and then transmit the traffic. +traffic generator is not supported by ViNePerf. In such case you could +use ViNePerf to setup your test scenario and then transmit the traffic. After the transmission is completed you could specify values for all -collected metrics and VSPERF will use them to generate final reports. +collected metrics and ViNePerf will use them to generate final reports. Setup ~~~~~ @@ -204,7 +204,7 @@ when the setup is complete. What was the result for 'frames tx'? When your traffic generator has completed traffic transmission and provided -the results please input these at the VSPERF prompt. VSPERF will try +the results please input these at the ViNePerf prompt. ViNePerf will try to verify the input: .. code-block:: console @@ -213,7 +213,7 @@ to verify the input: Please answer with y OR n. -VSPERF will ask you to provide a value for every of collected metrics. The list +ViNePerf will ask you to provide a value for every of collected metrics. The list of metrics can be found at traffic-type-metrics_. Finally vsperf will print out the results for your test and generate the appropriate logs and report files. @@ -223,7 +223,7 @@ appropriate logs and report files. Metrics collected for supported traffic types ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Below you could find a list of metrics collected by VSPERF for each of supported +Below you could find a list of metrics collected by ViNePerf for each of supported traffic types. RFC2544 Throughput and Continuous: @@ -286,9 +286,9 @@ in case, that the Dummy traffic generator is used. Otherwise the option Ixia ---- -VSPERF can use both IxNetwork and IxExplorer TCL servers to control Ixia chassis. +ViNePerf can use both IxNetwork and IxExplorer TCL servers to control Ixia chassis. However, usage of IxNetwork TCL server is a preferred option. The following sections -will describe installation and configuration of IxNetwork components used by VSPERF. +will describe installation and configuration of IxNetwork components used by ViNePerf. Installation ~~~~~~~~~~~~ @@ -309,11 +309,11 @@ installation you should configure it as follows: 3. Hit Ok and start the TCL server application -VSPERF configuration -~~~~~~~~~~~~~~~~~~~~ +ViNePerf configuration +~~~~~~~~~~~~~~~~~~~~~~ There are several configuration options specific to the IxNetwork traffic generator -from IXIA. It is essential to set them correctly, before the VSPERF is executed +from IXIA. It is essential to set them correctly, before the ViNePerf is executed for the first time. Detailed description of options follows: @@ -326,25 +326,25 @@ Detailed description of options follows: * ``TRAFFICGEN_IXIA_HOST`` - IP address of IXIA traffic generator chassis * ``TRAFFICGEN_IXIA_CARD`` - identification of card with dedicated ports at IXIA chassis * ``TRAFFICGEN_IXIA_PORT1`` - identification of the first dedicated port at ``TRAFFICGEN_IXIA_CARD`` - at IXIA chassis; VSPERF uses two separated ports for traffic generation. In case of + at IXIA chassis; ViNePerf uses two separated ports for traffic generation. In case of unidirectional traffic, it is essential to correctly connect 1st IXIA port to the 1st NIC at DUT, i.e. to the first PCI handle from ``WHITELIST_NICS`` list. Otherwise traffic may not be able to pass through the vSwitch. **NOTE**: In case that ``TRAFFICGEN_IXIA_PORT1`` and ``TRAFFICGEN_IXIA_PORT2`` are set to the - same value, then VSPERF will assume, that there is only one port connection between IXIA + same value, then ViNePerf will assume, that there is only one port connection between IXIA and DUT. In this case it must be ensured, that chosen IXIA port is physically connected to the first NIC from ``WHITELIST_NICS`` list. * ``TRAFFICGEN_IXIA_PORT2`` - identification of the second dedicated port at ``TRAFFICGEN_IXIA_CARD`` - at IXIA chassis; VSPERF uses two separated ports for traffic generation. In case of + at IXIA chassis; ViNePerf uses two separated ports for traffic generation. In case of unidirectional traffic, it is essential to correctly connect 2nd IXIA port to the 2nd NIC at DUT, i.e. to the second PCI handle from ``WHITELIST_NICS`` list. Otherwise traffic may not be able to pass through the vSwitch. **NOTE**: In case that ``TRAFFICGEN_IXIA_PORT1`` and ``TRAFFICGEN_IXIA_PORT2`` are set to the - same value, then VSPERF will assume, that there is only one port connection between IXIA + same value, then ViNePerf will assume, that there is only one port connection between IXIA and DUT. In this case it must be ensured, that chosen IXIA port is physically connected to the first NIC from ``WHITELIST_NICS`` list. * ``TRAFFICGEN_IXNET_LIB_PATH`` - path to the DUT specific installation of IxNetwork TCL API - * ``TRAFFICGEN_IXNET_TCL_SCRIPT`` - name of the TCL script, which VSPERF will use for + * ``TRAFFICGEN_IXNET_TCL_SCRIPT`` - name of the TCL script, which ViNePerf will use for communication with IXIA TCL server * ``TRAFFICGEN_IXNET_TESTER_RESULT_DIR`` - folder accessible from IxNetwork TCL server, where test results are stored, e.g. ``c:/ixia_results``; see test-results-share_ @@ -357,11 +357,11 @@ Detailed description of options follows: Test results share ~~~~~~~~~~~~~~~~~~ -VSPERF is not able to retrieve test results via TCL API directly. Instead, all test +ViNePerf is not able to retrieve test results via TCL API directly. Instead, all test results are stored at IxNetwork TCL server. Results are stored at folder defined by ``TRAFFICGEN_IXNET_TESTER_RESULT_DIR`` configuration parameter. Content of this folder must be shared (e.g. via samba protocol) between TCL Server and DUT, where -VSPERF is executed. VSPERF expects, that test results will be available at directory +ViNePerf is executed. ViNePerf expects, that test results will be available at directory configured by ``TRAFFICGEN_IXNET_DUT_RESULT_DIR`` configuration parameter. Example of sharing configuration: @@ -370,7 +370,7 @@ Example of sharing configuration: * Modify sharing options of ``ixia_results`` folder to share it with everybody * Create a new directory at DUT, where shared directory with results will be mounted, e.g. ``/mnt/ixia_results`` - * Update your custom VSPERF configuration file as follows: + * Update your custom ViNePerf configuration file as follows: .. code-block:: python @@ -387,7 +387,7 @@ Example of sharing configuration: yum install cifs-utils - * Mount shared directory, so VSPERF can access test results. + * Mount shared directory, so ViNePerf can access test results. e.g. by adding new record into ``/etc/fstab`` @@ -733,9 +733,9 @@ can be found here: https://github.com/emmericp/MoonGen -* Note: Today, MoonGen with VSPERF only supports 10Gbps line speeds. +* Note: Today, MoonGen with ViNePerf only supports 10Gbps line speeds. -For VSPERF use, MoonGen should be cloned from here (as opposed to the +For ViNePerf use, MoonGen should be cloned from here (as opposed to the previously mentioned GitHub): .. code-block:: console @@ -748,7 +748,7 @@ and use the master branch: git checkout master -VSPERF uses a particular Lua script with the MoonGen project: +ViNePerf uses a particular Lua script with the MoonGen project: trafficgen.lua @@ -757,8 +757,8 @@ Follow MoonGen set up and execution instructions here: https://github.com/atheurer/trafficgen/blob/master/README.md Note one will need to set up ssh login to not use passwords between the server -running MoonGen and the device under test (running the VSPERF test -infrastructure). This is because VSPERF on one server uses 'ssh' to +running MoonGen and the device under test (running the ViNePerf test +infrastructure). This is because ViNePerf on one server uses 'ssh' to configure and run MoonGen upon the other server. One can set up this ssh access by doing the following on both servers: @@ -802,7 +802,7 @@ You can directly download from GitHub: and use the same Trex version for both server and client API. -**NOTE:** The Trex API version used by VSPERF is defined by variable ``TREX_TAG`` +**NOTE:** The Trex API version used by ViNePerf is defined by variable ``TREX_TAG`` in file ``src/package-list.mk``. .. code-block:: console @@ -842,7 +842,7 @@ For additional information about configuration file see official documentation ( https://trex-tgn.cisco.com/trex/doc/trex_manual.html#_creating_minimum_configuration_file After compilation and configuration it is possible to run trex server in stateless mode. -It is neccesary for proper connection between Trex server and VSPERF. +It is neccesary for proper connection between Trex server and ViNePerf. .. code-block:: console @@ -850,7 +850,7 @@ It is neccesary for proper connection between Trex server and VSPERF. ./t-rex-64 -i **NOTE:** Please check your firewall settings at both DUT and T-Rex server. -Firewall must allow a connection from DUT (VSPERF) to the T-Rex server running +Firewall must allow a connection from DUT (ViNePerf) to the T-Rex server running at TCP port 4501. **NOTE:** For high speed cards it may be advantageous to start T-Rex with more transmit queues/cores. @@ -865,8 +865,8 @@ For additional information about Trex stateless mode see Trex stateless document https://trex-tgn.cisco.com/trex/doc/trex_stateless.html **NOTE:** One will need to set up ssh login to not use passwords between the server -running Trex and the device under test (running the VSPERF test -infrastructure). This is because VSPERF on one server uses 'ssh' to +running Trex and the device under test (running the ViNePerf test +infrastructure). This is because ViNePerf on one server uses 'ssh' to configure and run Trex upon the other server. One can set up this ssh access by doing the following on both servers: @@ -912,7 +912,7 @@ place. This can be adjusted with the following configurations: TRAFFICGEN_TREX_LEARNING_MODE=True TRAFFICGEN_TREX_LEARNING_DURATION=5 -Latency measurements have impact on T-Rex performance. Thus vswitchperf uses a separate +Latency measurements have impact on T-Rex performance. Thus ViNePerf uses a separate latency stream for each direction with limited speed. This workaround is used for RFC2544 **Throughput** and **Continuous** traffic types. In case of **Burst** traffic type, the latency statistics are measured for all frames in the burst. Collection of latency @@ -984,7 +984,7 @@ Scapy frame definition It is possible to use a SCAPY frame definition to generate various network protocols by the **T-Rex** traffic generator. In case that particular network protocol layer is disabled by the TRAFFIC dictionary (e.g. TRAFFIC['vlan']['enabled'] = False), -then disabled layer will be removed from the scapy format definition by VSPERF. +then disabled layer will be removed from the scapy format definition by ViNePerf. The scapy frame definition can refer to values defined by the TRAFFIC dictionary by following keywords. These keywords are used in next examples. diff --git a/docs/testing/user/configguide/upgrade.rst b/docs/testing/user/configguide/upgrade.rst index a41683ee..362de82b 100644 --- a/docs/testing/user/configguide/upgrade.rst +++ b/docs/testing/user/configguide/upgrade.rst @@ -3,20 +3,20 @@ .. (c) OPNFV, Intel Corporation, AT&T and others. ===================== -Upgrading vswitchperf +Upgrading ViNePerf ===================== Generic ------- -In case, that VSPERF is cloned from git repository, then it is easy to +In case, that ViNePerf is cloned from git repository, then it is easy to upgrade it to the newest stable version or to the development version. You could get a list of stable releases by ``git`` command. It is necessary to update local git repository first. -**NOTE:** Git commands must be executed from directory, where VSPERF repository -was cloned, e.g. ``vswitchperf``. +**NOTE:** Git commands must be executed from directory, where ViNePerf repository +was cloned, e.g. ``vineperf``. Update of local git repository: @@ -44,7 +44,7 @@ You could select which stable release should be used. For example, select ``danu $ git checkout danube.1.0 -Development version of VSPERF can be selected by: +Development version of ViNePerf can be selected by: .. code:: bash @@ -73,7 +73,7 @@ or In case that ``QemuDpdkVhostCuse`` is found, it must be modified to ``QemuDpdkVhostUser``. -**NOTE:** In case that execution of VSPERF is automated by scripts (e.g. for +**NOTE:** In case that execution of ViNePerf is automated by scripts (e.g. for CI purposes), then these scripts must be checked and updated too. It means, that any occurrence of: @@ -96,10 +96,10 @@ important changes are discussed below. Paths to DPDK, OVS and QEMU =========================== -VSPERF uses external tools for proper testcase execution. Thus it is important +ViNePerf uses external tools for proper testcase execution. Thus it is important to properly configure paths to these tools. In case that tools are installed by installation scripts and are located inside ``./src`` directory inside -VSPERF home, then no changes are needed. On the other hand, if path settings +ViNePerf home, then no changes are needed. On the other hand, if path settings was changed by custom configuration file, then it is required to update configuration accordingly. Please check your configuration files for following configuration options: @@ -135,7 +135,7 @@ and it is required to specify configuration parameter name in the same form as it is defined inside configuration file, i.e. in uppercase. Please refer to the :ref:`overriding-parameters-documentation` for additional details. -**NOTE:** In case that execution of VSPERF is automated by scripts (e.g. for +**NOTE:** In case that execution of ViNePerf is automated by scripts (e.g. for CI purposes), then these scripts must be checked and updated too. It means, that any occurrence of @@ -165,7 +165,7 @@ release and it is now possible to modify all traffic specific options via CLI or by ``TRAFFIC`` dictionary in configuration file. Detailed description is available at :ref:`configuration-of-traffic-dictionary` section of documentation. -Please check your automated scripts for VSPERF execution for following CLI +Please check your automated scripts for ViNePerf execution for following CLI parameters and update them according to the documentation: .. code:: bash |