summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/vCGNAPT/INSTALL.rst
diff options
context:
space:
mode:
authorDeepak S <deepak.s@linux.intel.com>2017-08-18 14:59:46 -0700
committerDeepak S <deepak.s@linux.intel.com>2017-08-20 15:55:06 -0700
commitbeecf87fb9e9b862994e5e3e6db2b1c378c971c1 (patch)
treeb8ce7029f060654c8768ceb8db1d6daae3adc900 /docs/testing/user/userguide/vCGNAPT/INSTALL.rst
parent5046e1f7b1533506a480ba8d000c78e147d4b8aa (diff)
Remove unwanted files in docs folder
JIRA: SAMPLEVNF-73 Change-Id: Ia147cfef9f7bcacd50477b6ea3c7d0a1c6e93952 Signed-off-by: Deepak S <deepak.s@linux.intel.com>
Diffstat (limited to 'docs/testing/user/userguide/vCGNAPT/INSTALL.rst')
-rw-r--r--docs/testing/user/userguide/vCGNAPT/INSTALL.rst230
1 files changed, 0 insertions, 230 deletions
diff --git a/docs/testing/user/userguide/vCGNAPT/INSTALL.rst b/docs/testing/user/userguide/vCGNAPT/INSTALL.rst
deleted file mode 100644
index 85873109..00000000
--- a/docs/testing/user/userguide/vCGNAPT/INSTALL.rst
+++ /dev/null
@@ -1,230 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International
-.. License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, National Center of Scientific Research "Demokritos" and others.
-
-============================
-vCGNAPT - Installation Guide
-============================
-
-
-vCGNAPT Compilation
-===================
-
-After downloading (or doing a git clone) in a directory (samplevnf)
-
-Dependencies
--------------
-
-- DPDK supported versions ($DPDK_RTE_VER = 16.04, 16.11, 17.02 or 17.05) Downloaded and installed via vnf_build.sh or manually from [here] (http://fast.dpdk.org/rel/)
-- libpcap-dev
-- libzmq
-- libcurl
-
-Environment variables
----------------------
-
-Apply all the additional patches in 'patches/dpdk_custom_patch/' and build dpdk
-required only for DPDK version 16.04.
-
-::
-
- export RTE_SDK=<dpdk directory>
- export RTE_TARGET=x86_64-native-linuxapp-gcc
-
-This is done by vnf_build.sh script.
-
-Auto Build:
-===========
-$ ./tools/vnf_build.sh in samplevnf root folder
-
-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 vCGNAPT 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)
-
- [9] Exit Script
-
-An vCGNAPT executable will be created at the following location
-samplevnf/VNFs/vCGNAPT/build/vCGNAPT
-
-
-Manual Build:
-=============
-1. Download DPDK supported version from dpdk.org
-
- - http://dpdk.org/browse/dpdk/snapshot/dpdk-$DPDK_RTE_VER.zip
-2. unzip dpdk-$DPDK_RTE_VER.zip and apply dpdk patches only in case of 16.04
- (Not required for other DPDK versions)
-
- - cd dpdk
-
- - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-management.patch
- - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-Rx-hang-when-disable-LLDP.patch
- - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-status-change-interrupt.patch
- - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-VF-bonded-device-link-down.patch
- - patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/disable-acl-debug-logs.patch
- - patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/set-log-level-to-info.patch
-
- - build dpdk
-
- - make config T=x86_64-native-linuxapp-gcc O=x86_64-native-linuxapp-gcc
- - cd x86_64-native-linuxapp-gcc
- - make
-
- - Setup huge pages
-
- - For 1G/2M hugepage sizes, for example 1G pages, the size must be specified
- explicitly and can also be optionally set as the default hugepage size for
- the system. For example, to reserve 8G of hugepage memory in the form of
- eight 1G pages, the following options should be passed to the kernel:
- * default_hugepagesz=1G hugepagesz=1G hugepages=8 hugepagesz=2M hugepages=2048
- - Add this to Go to /etc/default/grub configuration file.
- - Append "default_hugepagesz=1G hugepagesz=1G hugepages=8 hugepagesz=2M hugepages=2048"
- to the GRUB_CMDLINE_LINUX entry.
-
-3. Setup Environment Variable
-
- - export RTE_SDK=<samplevnf>/dpdk
- - export RTE_TARGET=x86_64-native-linuxapp-gcc
- - export VNF_CORE=<samplevnf>
- or using ./tools/setenv.sh
-
-4. Build vCGNAPT VNFs
-
- - cd <samplevnf>/VNFs/vCGNAPT
- - make clean
- - make
-
-5. An vCGNAPT executable will be created at the following location
-
- - <samplevnf>/VNFs/vCGNAPT/build/vCGNAPT
-
-Run
-====
-
-Setup Port to run VNF
-----------------------
-
-::
-
- For DPDK versions 16.04
- 1. cd <samplevnf>/dpdk
- 2. ./tools/dpdk_nic_bind.py --status <--- List the network device
- 3. ./tools/dpdk_nic_bind.py -b igb_uio <PCI Port 0> <PCI Port 1>
- .. _More details: http://dpdk.org/doc/guides-16.04/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules
-
- For DPDK versions 16.11
- 1. cd <samplevnf>/dpdk
- 2. ./tools/dpdk-devbind.py --status <--- List the network device
- 3. ./tools/dpdk-devbind.py -b igb_uio <PCI Port 0> <PCI Port 1>
- .. _More details: http://dpdk.org/doc/guides-16.11/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules
-
- For DPDK versions 17.xx
- 1. cd <samplevnf>/dpdk
- 2. ./usertools/dpdk-devbind.py --status <--- List the network device
- 3. ./usertools/dpdk-devbind.py -b igb_uio <PCI Port 0> <PCI Port 1>
- .. _More details: http://dpdk.org/doc/guides-17.05/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules
-
- Make the necessary changes to the config files to run the vCGNAPT VNF
- eg: ports_mac_list = 00:00:00:30:21:F0 00:00:00:30:21:F1
-
-Dynamic CGNAPT
---------------
-Update the configuration according to system configuration.
-
-::
-
- ./vCGNAPT -p <port mask> -f <config> -s <script> - SW_LoadB
- ./vCGNAPT -p <port mask> -f <config> -s <script> -hwlb <num_WT> - HW_LoadB
-
-Static CGNAPT
--------------
-Update the script file and add Static NAT Entry
-
-::
-
- e.g,
- ;p <pipeline id> entry addm <prv_ipv4/6> prvport> <pub_ip> <pub_port> <phy_port> <ttl> <no_of_entries> <end_prv_port> <end_pub_port>
- ;p 3 entry addm 152.16.100.20 1234 152.16.40.10 1 0 500 65535 1234 65535
-
-Run IPv4
-----------
-
-::
-
- Software LoadB:
-
- cd <samplevnf>/VNFs/vCGNAPT/build
- ./vCGNAPT -p 0x3 -f ./config/arp_txrx-2P-1T.cfg -s ./config/arp_txrx_ScriptFile_2P.cfg
-
-
- Hardware LoadB:
-
- cd <samplevnf>/VNFs/vCGNAPT/build
- ./vCGNAPT -p 0x3 -f ./config/arp_hwlb-2P-1T.cfg -s ./config/arp_hwlb_scriptfile_2P.cfg --hwlb 1
-
-Run IPv6
----------
-
-::
-
- Software LoadB:
-
- cd <samplevnf>/VNFs/vCGNAPT/build
- ./vCGNAPT -p 0x3 -f ./config/arp_txrx-2P-1T-ipv6.cfg -s ./config/arp_txrx_ScriptFile_2P.cfg
-
-
- Hardware LoadB:
-
- cd <samplevnf>/VNFs/vCGNAPT/build
- ./vCGNAPT -p 0x3 -f ./config/arp_hwlb-2P-1T-ipv6.cfg -s ./config/arp_hwlb_scriptfile_2P.cfg --hwlb 1
-
-vCGNAPT execution on BM & SRIOV
---------------------------------
-
-::
-
- To run the VNF, execute the following:
- samplevnf/VNFs/vCGNAPT# ./build/vCGNAPT -p 0x3 -f ./config/arp_txrx-2P-1T.cfg -s ./config/arp_txrx_ScriptFile_2P.cfg
- Command Line Params:
- -p PORTMASK: Hexadecimal bitmask of ports to configure
- -f CONFIG FILE: vCGNAPT configuration file
- -s SCRIPT FILE: vCGNAPT script file
-
-vCGNAPT execution on OVS
--------------------------
-To run the VNF, execute the following:
-
-::
-
- samplevnf/VNFs/vCGNAPT# ./build/vCGNAPT -p 0x3 ./config/arp_txrx-2P-1T.cfg -s ./config/arp_txrx_ScriptFile_2P.cfg --disable-hw-csum
- Command Line Params:
- -p PORTMASK: Hexadecimal bitmask of ports to configure
- -f CONFIG FILE: vCGNAPT configuration file
- -s SCRIPT FILE: vCGNAPT script file
- --disable-hw-csum :Disable TCP/UDP hw checksum