From beecf87fb9e9b862994e5e3e6db2b1c378c971c1 Mon Sep 17 00:00:00 2001 From: Deepak S Date: Fri, 18 Aug 2017 14:59:46 -0700 Subject: Remove unwanted files in docs folder JIRA: SAMPLEVNF-73 Change-Id: Ia147cfef9f7bcacd50477b6ea3c7d0a1c6e93952 Signed-off-by: Deepak S --- docs/testing/user/configguide/configguide.rst | 5 - docs/testing/user/configguide/index.rst | 5 - docs/testing/user/userguide/vACL/INSTALL.rst | 233 --------------------- docs/testing/user/userguide/vACL/README.rst | 159 -------------- docs/testing/user/userguide/vACL/RELEASE_NOTES.rst | 81 ------- docs/testing/user/userguide/vACL/index.rst | 11 - docs/testing/user/userguide/vCGNAPT/INSTALL.rst | 230 -------------------- docs/testing/user/userguide/vCGNAPT/README.rst | 197 ----------------- .../user/userguide/vCGNAPT/RELEASE_NOTES.rst | 90 -------- docs/testing/user/userguide/vCGNAPT/index.rst | 11 - docs/testing/user/userguide/vFW/INSTALL.rst | 229 -------------------- docs/testing/user/userguide/vFW/README.rst | 182 ---------------- docs/testing/user/userguide/vFW/RELEASE_NOTES.rst | 92 -------- docs/testing/user/userguide/vFW/index.rst | 11 - 14 files changed, 1536 deletions(-) delete mode 100644 docs/testing/user/configguide/configguide.rst delete mode 100644 docs/testing/user/configguide/index.rst delete mode 100644 docs/testing/user/userguide/vACL/INSTALL.rst delete mode 100644 docs/testing/user/userguide/vACL/README.rst delete mode 100644 docs/testing/user/userguide/vACL/RELEASE_NOTES.rst delete mode 100644 docs/testing/user/userguide/vACL/index.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/INSTALL.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/README.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/RELEASE_NOTES.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/index.rst delete mode 100644 docs/testing/user/userguide/vFW/INSTALL.rst delete mode 100644 docs/testing/user/userguide/vFW/README.rst delete mode 100644 docs/testing/user/userguide/vFW/RELEASE_NOTES.rst delete mode 100644 docs/testing/user/userguide/vFW/index.rst (limited to 'docs/testing') diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst deleted file mode 100644 index e3867864..00000000 --- a/docs/testing/user/configguide/configguide.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -.. OPNFV SAMPLEVNF Documentation configure guide file. diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst deleted file mode 100644 index 1998be3b..00000000 --- a/docs/testing/user/configguide/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -.. OPNFV SAMPLEVNF Documentation master file. diff --git a/docs/testing/user/userguide/vACL/INSTALL.rst b/docs/testing/user/userguide/vACL/INSTALL.rst deleted file mode 100644 index 7f21fc1f..00000000 --- a/docs/testing/user/userguide/vACL/INSTALL.rst +++ /dev/null @@ -1,233 +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. - -============================ -vACL - Installation Guide -============================ - -vACL 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 - -:: - - export RTE_SDK= - 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 vACL 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 vACL executable will be created at the following location -samplevnf/VNFs/vACL/build/vACL - - -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=/dpdk - - export RTE_TARGET=x86_64-native-linuxapp-gcc - - export VNF_CORE= - - or using ./tools/setenv.sh - -4. Build vACL VNFs - - - cd /VNFs/vACL - - make clean - - make - -5. The vACL executable will be created at the following location - - - /VNFs/vACL/build/vACL - -Run -==== - ----------------------- -Setup Port to run VNF ----------------------- - -:: - - For DPDK versions 16.04 - 1. cd /dpdk - 2. ./tools/dpdk_nic_bind.py --status <--- List the network device - 3. ./tools/dpdk_nic_bind.py -b igb_uio - .. _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 /dpdk - 2. ./tools/dpdk-devbind.py --status <--- List the network device - 3. ./tools/dpdk-devbind.py -b igb_uio - .. _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 /dpdk - 2. ./usertools/dpdk-devbind.py --status <--- List the network device - 3. ./usertools/dpdk-devbind.py -b igb_uio - .. _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 vACL VNF - eg: ports_mac_list = 00:00:00:30:21:00 00:00:00:30:21:00 - ------------------ -ACL run commands ------------------ -Update the configuration according to system configuration. - -:: - - ./build/vACL -p -f -s