diff options
Diffstat (limited to 'docs/testing/user/userguide/04-installation.rst')
| -rw-r--r-- | docs/testing/user/userguide/04-installation.rst | 144 |
1 files changed, 78 insertions, 66 deletions
diff --git a/docs/testing/user/userguide/04-installation.rst b/docs/testing/user/userguide/04-installation.rst index 5b8b9322..d7c26c9d 100644 --- a/docs/testing/user/userguide/04-installation.rst +++ b/docs/testing/user/userguide/04-installation.rst @@ -6,7 +6,6 @@ SampleVNF Installation ====================== - Abstract -------- @@ -19,17 +18,17 @@ optimized VNF + NFVi Infrastructure libraries, with Performance Characterization of Sample† Traffic Flows. :: - • * Not a commercial product. Encourage the community to contribute and close the feature gaps. - • † No Vendor/Proprietary Workloads + + * Not a commercial product. Encourage the community to contribute and close the feature gaps. + † No Vendor/Proprietary Workloads SampleVNF supports installation directly in Ubuntu. The installation procedure are detailed in the sections below. The steps needed to run SampleVNF are: -1. Install and Build SampleVNF. -2. deploy the VNF on the target and modify the config based on the - Network under test -3. Run the traffic generator to generate the traffic. + 1) Install and Build SampleVNF. + 2) deploy the VNF on the target and modify the config based on the Network under test + 3) Run the traffic generator to generate the traffic. Prerequisites ------------- @@ -47,13 +46,17 @@ simulation platform to generate packet traffic to the DUT ports and determine the throughput/latency at the tester side. Below are the supported/tested (:term `VNF`) deployment type. + .. image:: images/deploy_type.png :width: 800px :alt: SampleVNF supported topology Hardware & Software Ingredients ------------------------------- -.. code-block:: console + +SUT requirements: +^^^^^^^^^^^^^^^^ +:: +-----------+------------------+ | Item | Description | +-----------+------------------+ @@ -65,10 +68,12 @@ Hardware & Software Ingredients +-----------+------------------+ | kernel | 4.4.0-34-generic| +-----------+------------------+ - |DPD | 17.02 | + | DPDK | 17.02 | +-----------+------------------+ - Boot and BIOS settings +Boot and BIOS settings: +^^^^^^^^^^^^^^^^^^^^^^ +:: +------------------+---------------------------------------------------+ | Boot settings | default_hugepagesz=1G hugepagesz=1G hugepages=16 | | | hugepagesz=2M hugepages=2048 isolcpus=1-11,22-33 | @@ -92,20 +97,24 @@ The ethernet cables should be connected between traffic generator and the VNF se SRIOV or OVS) setup based on the test profile. The connectivity could be -1. Single port pair : One pair ports used for traffic +1) Single port pair : One pair ports used for traffic :: e.g. Single port pair link0 and link1 of VNF are used - TG:port 0 ------ VNF:Port 0 - TG:port 1 ------ VNF:Port 1 + TG:port 0 <------> VNF:Port 0 + TG:port 1 <------> VNF:Port 1 -2. Multi port pair : More than one pair of traffic +2) Multi port pair : More than one pair of traffic :: e.g. Two port pair link 0, link1, link2 and link3 of VNF are used - TG:port 0 ------ VNF:Port 0 - TG:port 1 ------ VNF:Port 1 - TG:port 2 ------ VNF:Port 2 - TG:port 3 ------ VNF:Port 3 - + TG:port 0 <------> VNF:Port 0 + TG:port 1 <------> VNF:Port 1 + TG:port 2 <------> VNF:Port 2 + TG:port 3 <------> VNF:Port 3 + + For correalted traffic, use below configuration + TG_1:port 0 <------> VNF:Port 0 + VNF:Port 1 <------> TG_2:port 0 (UDP Replay) + (TG_2(UDP_Replay) reflects all the traffic on the given port) * Bare-Metal Refer: http://fast.dpdk.org/doc/pdf-guides/ to setup the DUT for VNF to run @@ -114,55 +123,57 @@ The connectivity could be Refer below link to setup sriov https://software.intel.com/en-us/articles/using-sr-iov-to-share-an-ethernet-port-among-multiple-vms - * OVS/OVS/DPDK - Refer below link to setup ovs/ovs-dpdk + * OVS_DPDK + Refer below link to setup ovs-dpdk http://docs.openvswitch.org/en/latest/intro/install/general/ http://docs.openvswitch.org/en/latest/intro/install/dpdk/ * Openstack - Use OPNFV installer to deploy the openstack. + Use any OPNFV installer to deploy the openstack. Build VNFs on the DUT: ---------------------- - * Clone sampleVNF project repository - git clone https://git.opnfv.org/samplevnf - Auto Build - ---------- - * Interactive options: - :: - ./tools/vnf_build.sh -i - Follow the steps in the screen from option [1] –> [9] and - select option [8] to build the vnfs. - It will automatically download selected DPDK version and any - required patches and will setup everything and build VNFs. - - Following are the options for setup: - ---------------------------------------------------------- - Step 1: Environment setup. - ---------------------------------------------------------- - [1] Check OS and network connection - [2] Select DPDK RTE version - - ---------------------------------------------------------- - Step 2: Download and Install - ---------------------------------------------------------- - [3] Agree to download - [4] Download packages - [5] Download DPDK zip - [6] Build and Install DPDK - [7] Setup hugepages - - ---------------------------------------------------------- - Step 3: Build VNFs - ---------------------------------------------------------- - [8] Build all VNFs (vACL, vCGNAPT, vFW, UDP_Replay, DPPD-PROX) - - [9] Exit Script - * non-Interactive options: - :: - ./tools/vnf_build.sh -s -d=<dpdk version eg 17.02> -Manual Build ------------- +1) Clone sampleVNF project repository - git clone https://git.opnfv.org/samplevnf + + Auto Build - Using script to build VNFs + ^^^^^^^^^^ + * Interactive options: + :: + ./tools/vnf_build.sh -i + Follow the steps in the screen from option [1] –> [9] and + select option [8] to build the vnfs. + It will automatically download selected DPDK version and any + required patches and will setup everything and build VNFs. + + Following are the options for setup: + ---------------------------------------------------------- + Step 1: Environment setup. + ---------------------------------------------------------- + [1] Check OS and network connection + [2] Select DPDK RTE version + + ---------------------------------------------------------- + Step 2: Download and Install + ---------------------------------------------------------- + [3] Agree to download + [4] Download packages + [5] Download DPDK zip + [6] Build and Install DPDK + [7] Setup hugepages + + ---------------------------------------------------------- + Step 3: Build VNFs + ---------------------------------------------------------- + [8] Build all VNFs (vACL, vCGNAPT, vFW, UDP_Replay, DPPD-PROX) + + [9] Exit Script + * non-Interactive options: + :: + ./tools/vnf_build.sh -s -d=<dpdk version eg 17.02> + + Manual Build + ^^^^^^^^^^^^ :: 1.Download DPDK supported version from dpdk.org http://dpdk.org/browse/dpdk/snapshot/dpdk-$DPDK_RTE_VER.zip @@ -191,11 +202,12 @@ Manual Build The vACL executable will be created at the following location <samplevnf>/VNFs/vACL/build/vACL -Standalone virtualization/Openstack: - :: - * Build image from yardstick - git clone https://git.opnfv.org/yardstick - * cd yardstick and run - ./tools/yardstick-img-modify tools/ubuntu-server-cloudimg-samplevnf-modify.sh +2) Standalone virtualization/Openstack: + + Build VM image from script in yardstick + :: + 1) git clone https://git.opnfv.org/yardstick + 2) cd yardstick and run + ./tools/yardstick-img-modify tools/ubuntu-server-cloudimg-samplevnf-modify.sh To run VNFs. Please refer chapter `05-How_to_run_SampleVNFs.rst` |