diff options
Diffstat (limited to 'docs/testing/user/configguide/installation.rst')
| -rw-r--r-- | docs/testing/user/configguide/installation.rst | 40 |
1 files changed, 21 insertions, 19 deletions
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 |