Moving the current docs to userguide

Change-Id: I500d70b7ed2a17e21548a27810ac7e51e44b7841
Signed-off-by: Deepak S <deepak.s@linux.intel.com>

1 files changed, 0 insertions, 233 deletions

diff --git a/docs/vACL/INSTALL.rst b/docs/vACL/INSTALL.rst
deleted file mode 100644
index 7f21fc1f..00000000
--- a/docs/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=<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 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=<samplevnf>/dpdk
-   - export RTE_TARGET=x86_64-native-linuxapp-gcc
-   - export VNF_CORE=<samplevnf>
-
-     or using ./tools/setenv.sh
-
-4. Build vACL VNFs
-
-   - cd <samplevnf>/VNFs/vACL
-   - make clean
-   - make
-
-5. The vACL executable will be created at the following location
-
-   - <samplevnf>/VNFs/vACL/build/vACL
-
-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 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 <port mask> -f <config> -s <script> - SW_LoadB
-
-  ./build/vACL -p <port mask> -f <config> -s <script> -hwlb <num_WT> - HW_LoadB
-
-
-Run IPv4
---------
-
-::
-
- Software LoadB
-
-  cd <samplevnf>/VNFs/vACL/
-
-  ./build/vACL -p 0x3 -f ./config/IPv4_swlb_acl_1LB_1t.cfg  -s ./config/ IPv4_swlb_acl.tc
-
-
- Hardware LoadB
-
-  cd <samplevnf>/VNFs/vACL/
-
-  ./build/vACL -p 0x3 -f ./config/IPv4_hwlb_acl_1LB_1t.cfg  -s ./config/IPv4_hwlb_acl.tc --hwlb 1
-
-Run IPv6
---------
-
-::
-
-  Software LoadB
-
-  cd <samplevnf>/VNFs/vACL/
-
-  ./build/vACL -p 0x3 -f ./config/IPv6_swlb_acl_1LB_1t.cfg  -s ./config/IPv6_swlb_acl.tc
-
-
-  Hardware LoadB
-
-  cd <samplevnf>/VNFs/vACL/
-
-  ./build/vACL -p 0x3 -f ./config/IPv6_hwlb_acl_1LB_1t.cfg  -s ./config/IPv6_hwlb_acl.tc --hwlb 1
-
-vACL execution on BM & SRIOV
---------------------------------
-To run the VNF, execute the following
-
-::
-
-  samplevnf/VNFs/vACL# ./build/vACL -p 0x3 -f ./config/IPv4_swlb_acl_1LB_1t.cfg  -s ./config/ IPv4_swlb_acl.tc
-
-  Command Line Params:
-  -p PORTMASK: Hexadecimal bitmask of ports to configure
-  -f CONFIG FILE: vACL configuration file
-  -s SCRIPT FILE: vACL script file
-
-vACL execution on OVS
--------------------------
-To run the VNF, execute the following:
-
-::
-
-  samplevnf/VNFs/vACL# ./build/vACL -p 0x3 -f ./config/IPv4_swlb_acl_1LB_1t.cfg  -s ./config/ IPv4_swlb_acl.tc --disable-hw-csum
-
-  Command Line Params:
-  -p PORTMASK: Hexadecimal bitmask of ports to configure
-  -f CONFIG FILE: vACL configuration file
-  -s SCRIPT FILE: vACL script file
-  --disable-hw-csum :Disable TCP/UDP hw checksum