diff options
Diffstat (limited to 'docs/testing/developer/devguide')
10 files changed, 84 insertions, 68 deletions
diff --git a/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst index 671c7fd8..0ab5b848 100644 --- a/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst +++ b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst @@ -33,7 +33,7 @@ Step 2 - create a trafficgen module =================================== Every trafficgen class must inherit from generic **ITrafficGenerator** -interface class. VSPERF during its initialization scans content of pkt_gen +interface class. ViNePerf during its initialization scans content of pkt_gen directory for all python modules, that inherit from **ITrafficGenerator**. These modules are automatically added into the list of supported traffic generators. @@ -51,7 +51,7 @@ Let us create a draft of tools/pkt_gen/sample_tg/sample_tg.py module. """ pass -VSPERF is immediately aware of the new class: +ViNePerf is immediately aware of the new class: .. code-block:: console @@ -83,14 +83,14 @@ Step 3 - configuration ====================== All configuration values, required for correct traffic generator function, are passed -from VSPERF to the traffic generator in a dictionary. Default values shared among +from ViNePerf to the traffic generator in a dictionary. Default values shared among all traffic generators are defined in **conf/03_traffic.conf** within **TRAFFIC** dictionary. Default values are loaded by **ITrafficGenerator** interface class automatically, so it is not needed to load them explicitly. In case that there are any traffic generator specific default values, then they should be set within class specific **__init__** function. -VSPERF passes test specific configuration within **traffic** dictionary to every +ViNePerf passes test specific configuration within **traffic** dictionary to every start and send function. So implementation of these functions must ensure, that default values are updated with the testcase specific values. Proper merge of values is assured by call of **merge_spec** function from **conf** module. @@ -140,7 +140,7 @@ Example in **tools/pkt_gen/sample_tg/sample_tg.py** module: Step 5 - supported traffic types ================================ -Currently VSPERF supports three different types of tests for traffic generators, +Currently ViNePerf supports three different types of tests for traffic generators, these are identified in vsperf through the traffic type, which include: * RFC2544 throughput - Send fixed size packets at different rates, using diff --git a/docs/testing/developer/devguide/design/vswitchperf_design.rst b/docs/testing/developer/devguide/design/vswitchperf_design.rst index 5fa892e0..f0f9401d 100644 --- a/docs/testing/developer/devguide/design/vswitchperf_design.rst +++ b/docs/testing/developer/devguide/design/vswitchperf_design.rst @@ -4,9 +4,9 @@ .. _vsperf-design: -====================== -VSPERF Design Document -====================== +======================== +ViNePerf Design Document +======================== Intended Audience ================= @@ -21,11 +21,11 @@ Usage Example Connectivity to DUT --------------------------- -Establish connectivity to the VSPERF DUT Linux host. If this is in an OPNFV lab +Establish connectivity to the ViNePerf DUT Linux host. If this is in an OPNFV lab following the steps provided by `Pharos <https://www.opnfv.org/community/projects/pharos>`_ to `access the POD <https://wiki.opnfv.org/display/INF/INFRA+Lab+Support>`_ -The followign steps establish the VSPERF environment. +The followign steps establish the ViNePerf environment. Example Command Lines --------------------- @@ -111,13 +111,13 @@ convention. Configuration of PATHS dictionary --------------------------------- -VSPERF uses external tools like Open vSwitch and Qemu for execution of testcases. These +ViNePerf uses external tools like Open vSwitch and Qemu for execution of testcases. These tools may be downloaded and built automatically (see :ref:`vsperf-installation-script`) or installed manually by user from binary packages. It is also possible to use a combination of both approaches, but it is essential to correctly set paths to all required tools. These paths are stored within a PATHS dictionary, which is evaluated before execution of each testcase, in order to setup testcase specific environment. Values selected for testcase -execution are internally stored inside TOOLS dictionary, which is used by VSPERF to execute +execution are internally stored inside TOOLS dictionary, which is used by ViNePerf to execute external tools, load kernel modules, etc. The default configuration of PATHS dictionary is spread among three different configuration files @@ -180,11 +180,11 @@ of configuration options: * option ``type`` - is a string, which defines the type of configured paths ('src' or 'bin') to be selected for a given section: - * value ``src`` means, that VSPERF will use vswitch, DPDK or QEMU built from sources - e.g. by execution of ``systems/build_base_machine.sh`` script during VSPERF + * value ``src`` means, that ViNePerf will use vswitch, DPDK or QEMU built from sources + e.g. by execution of ``systems/build_base_machine.sh`` script during ViNePerf installation - * value ``bin`` means, that VSPERF will use vswitch, DPDK or QEMU binaries installed + * value ``bin`` means, that ViNePerf will use vswitch, DPDK or QEMU binaries installed directly in the operating system, e.g. via OS specific packaging system * option ``path`` - is a string with a valid system path; Its content is checked for @@ -258,7 +258,7 @@ of configuration options: TOOLS['ovsdb-server'] = '/tmp/vsperf/src_vanilla/ovs/ovs/ovsdb/ovsdb-server' Note: In case that ``bin`` type is set for DPDK, then ``TOOLS['dpdk_src']`` will be set to -the value of ``PATHS['dpdk']['src']['path']``. The reason is, that VSPERF uses downloaded +the value of ``PATHS['dpdk']['src']['path']``. The reason is, that ViNePerf uses downloaded DPDK sources to copy DPDK and testpmd into the GUEST, where testpmd is built. In case, that DPDK sources are not available, then vsperf will continue with test execution, but testpmd can't be used as a guest loopback. This is useful in case, that other guest @@ -497,11 +497,11 @@ Detailed description of ``TRAFFIC`` dictionary items follows: Configuration of GUEST options ------------------------------ -VSPERF is able to setup scenarios involving a number of VMs in series or in parallel. +ViNePerf is able to setup scenarios involving a number of VMs in series or in parallel. All configuration options related to a particular VM instance are defined as lists and prefixed with ``GUEST_`` label. It is essential, that there is enough items in all ``GUEST_`` options to cover all VM instances involved in the test. -In case there is not enough items, then VSPERF will use the first item of +In case there is not enough items, then ViNePerf will use the first item of particular ``GUEST_`` option to expand the list to required length. Example of option expansion for 4 VMs: @@ -605,7 +605,7 @@ PXP Deployment Every testcase uses one of the supported deployment scenarios to setup test environment. The controller responsible for a given scenario configures flows in the vswitch to route traffic among physical interfaces connected to the traffic generator and virtual -machines. VSPERF supports several deployments including PXP deployment, which can +machines. ViNePerf supports several deployments including PXP deployment, which can setup various scenarios with multiple VMs. These scenarios are realized by VswitchControllerPXP class, which can configure and @@ -716,7 +716,7 @@ by deployment name as follows: * ``pvpv[number]`` - configures scenario with VMs connected in parallel with optional ``number`` of VMs. In case that ``number`` is not specified, then 2 VMs will be used. Multistream feature is used to route traffic to particular - VMs (or NIC pairs of every VM). It means, that VSPERF will enable multistream + VMs (or NIC pairs of every VM). It means, that ViNePerf will enable multistream feature and sets the number of streams to the number of VMs and their NIC pairs. Traffic will be dispatched based on Stream Type, i.e. by UDP port, IP address or MAC address. @@ -805,7 +805,7 @@ are modified inside VM (e.g. MAC swap or IP change). VM, vSwitch, Traffic Generator Independence =========================================== -VSPERF supports different VSwitches, Traffic Generators, VNFs +ViNePerf supports different VSwitches, Traffic Generators, VNFs and Forwarding Applications by using standard object-oriented polymorphism: * Support for vSwitches is implemented by a class inheriting from IVSwitch. diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index 64a4758c..ad82e3ce 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -2,46 +2,46 @@ .. 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. -**************************** -OPNFV VSPERF Developer Guide -**************************** +******************************* +Anuket ViNePerf Developer Guide +******************************* ============ Introduction ============ -VSPERF is an OPNFV testing project. +ViNePerf is an Anuket 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 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 +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/ ============= Design Guides ============= .. toctree:: - :caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan + :caption: Traffic Gen Integration, ViNePerf Design, Test Design, Test Plan :maxdepth: 2 ./design/trafficgen_integration_guide.rst @@ -55,22 +55,22 @@ IETF RFC 8204 ============= .. toctree:: - :caption: VSPERF contributions to Industry Specifications + :caption: ViNePerf contributions to Industry Specifications :maxdepth: 2 :numbered: The IETF Benchmarking Methodology Working Group (BMWG) was re-chartered in 2014 to include benchmarking for -Virtualized Network Functions (VNFs) and their infrastructure. A version of the VSPERF test specification was +Virtualized Network Functions (VNFs) and their infrastructure. A version of the ViNePerf test specification was summarized in an Internet Draft ... `Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_ and contributed to the BMWG. In June 2017 the Internet Engineering Steering Group of the IETF approved the most recent version of the draft for publication as a new test specification (RFC 8204). -==================== -VSPERF CI Test Cases -==================== +====================== +ViNePerf CI Test Cases +====================== .. toctree:: - :caption: VSPERF Scenarios & Results + :caption: ViNePerf Scenarios & Results :maxdepth: 2 :numbered: -CI Test cases run daily on the VSPERF Pharos POD for master and stable branches. +CI Test cases run daily on the ViNePerf Pharos POD for master and stable branches. diff --git a/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst b/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst index 10b07d54..201c8415 100644 --- a/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst +++ b/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst @@ -6,12 +6,12 @@ IETF benchmarking specification RFC8204 *************************************** -The directory /ietf_draft was used to store draft versions of the VSPERF test specification proposed +The directory /ietf_draft was used to store draft versions of the ViNePerf test specification proposed as an Internet Draft and subsequently approved for publication as RFC8204. The draft versions have been removed. "Benchmarking Virtual Switches in the Open Platform for NFV (OPNFV)" is an informational RFC published by the IETF available here https://tools.ietf.org/html/rfc8204. -For more information about VSPERF refer to: +For more information about ViNePerf refer to: * Wiki: https://wiki.opnfv.org/display/vsperf * Repository: https://git.opnfv.org/vswitchperf diff --git a/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst index 1ea99f7e..5796b399 100644 --- a/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst +++ b/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -****************************** -VSPERF LEVEL TEST DESIGN (LTD) -****************************** +******************************** +ViNePerf LEVEL TEST DESIGN (LTD) +******************************** .. 3.1 diff --git a/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst index c0b63859..fe57ddc5 100644 --- a/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst +++ b/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst @@ -4,16 +4,16 @@ .. 3.1 -***************************** -VSPERF LEVEL TEST PLAN (LTP) -***************************** +****************************** +ViNePerf LEVEL TEST PLAN (LTP) +****************************** =============== Introduction =============== -The objective of the OPNFV project titled -**Characterize vSwitch Performance for Telco NFV Use Cases**, is to +The objective of the Anuket project titled +**Characterize Virtual Networking Performance for Telco NFV Use Cases**, is to evaluate the performance of virtual switches to identify its suitability for a Telco Network Function Virtualization (NFV) environment. The intention of this Level Test Plan (LTP) document is to specify the scope, approach, resources, @@ -1295,9 +1295,9 @@ vsperf also identified an alternative configuration for the final step: Environment/infrastructure ============================ -VSPERF CI jobs are run using the OPNFV lab infrastructure as described by the +ViNePerf CI jobs are run using the Anuket lab infrastructure as described by the 'Pharos Project <https://www.opnfv.org/community/projects/pharos>`_ . -A VSPERF POD is described here https://wiki.opnfv.org/display/pharos/VSPERF+in+Intel+Pharos+Lab+-+Pod+12 +A ViNePerf POD is described here https://wiki.opnfv.org/display/pharos/ViNePerf+in+Intel+Pharos+Lab+-+Pod+12 vsperf CI --------- @@ -1322,15 +1322,15 @@ vsperf CI jobs are broken down into: Scripts: -------- -There are 2 scripts that are part of VSPERFs CI: +There are 2 scripts that are part of ViNePerfs CI: - * build-vsperf.sh: Lives in the VSPERF repository in the ci/ directory and is + * build-vsperf.sh: Lives in the ViNePerf repository in the ci/ directory and is used to run vsperf with the appropriate cli parameters. * vswitchperf.yml: YAML description of our jenkins job. lives in the RELENG repository. More info on vsperf CI can be found here: -https://wiki.opnfv.org/display/vsperf/VSPERF+CI +https://wiki.opnfv.org/display/vsperf/ViNePerf+CI .. 3.3.3: diff --git a/docs/testing/developer/devguide/results/index.rst b/docs/testing/developer/devguide/results/index.rst index 04899b5a..d9ae1466 100644 --- a/docs/testing/developer/devguide/results/index.rst +++ b/docs/testing/developer/devguide/results/index.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -************** -VSPERF Results -************** +**************** +ViNePerf Results +**************** .. toctree:: :numbered: @@ -12,3 +12,4 @@ VSPERF Results scenario.rst results.rst + osk8s.rst diff --git a/docs/testing/developer/devguide/results/osk8s.rst b/docs/testing/developer/devguide/results/osk8s.rst new file mode 100644 index 00000000..81d2f3c8 --- /dev/null +++ b/docs/testing/developer/devguide/results/osk8s.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Spirent, AT&T, Ixia and others. + +.. Anuket ViNePerf Openstack/Kubernetes Documentation file + +Reporting for Openstack and Kubernetes Usecases +=============================================== + +For Openstack and Kubernetes scenarios, ViNePerf will providing for the following as part of the reporting: + +1. Cloud-Information: Detailed information about the Openstack or Kubernetes environment. +2. Cloud Identifier: Identifying whether the cloud was Openstack based or Kubernetes based. + +These information are saved in the same location as the test-results. diff --git a/docs/testing/developer/devguide/results/results.rst b/docs/testing/developer/devguide/results/results.rst index 0a0ab75d..ee99410f 100644 --- a/docs/testing/developer/devguide/results/results.rst +++ b/docs/testing/developer/devguide/results/results.rst @@ -2,13 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -OPNFV Test Results +Anuket Test Results ========================= -VSPERF CI jobs are run daily and sample results can be found at +ViNePerf CI jobs are run daily and sample results can be found at https://wiki.opnfv.org/display/vsperf/Vsperf+Results Testcase names shown in the dashboard are combination of orignal testcase -name from VSPERF framework and indication of used vswitch. +name from ViNePerf framework and indication of used vswitch. Example: diff --git a/docs/testing/developer/devguide/results/scenario.rst b/docs/testing/developer/devguide/results/scenario.rst index f7eadd33..99ba19ff 100644 --- a/docs/testing/developer/devguide/results/scenario.rst +++ b/docs/testing/developer/devguide/results/scenario.rst @@ -2,8 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -VSPERF Test Scenarios -===================== +ViNePerf Test Scenarios +======================= Predefined Tests suitable for automated execution with CI: |