Moving the current docs to userguide

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

4 files changed, 0 insertions, 484 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
diff --git a/docs/vACL/README.rst b/docs/vACL/README.rst
deleted file mode 100644
index f8c3e817..00000000
--- a/docs/vACL/README.rst
+++ /dev/null
@@ -1,159 +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 - Readme
-========================================================
-
-Introduction
-=================
-This application implements Access Control List (ACL). ACL is typically
-used for rule based policy enforcement. It restricts access to a destination
-IP address/port based on various header fields, such as source IP address/port,
-destination IP address/port and protocol. It is built on top of DPDK and
-uses the packet framework infrastructure.
-
-
-----------
-About DPDK
-----------
-The DPDK IP Pipeline Framework provides a set of libraries to build a pipeline
-application. In this document, vACL will be explained in detail with its own
-building blocks.
-
-This document assumes the reader possesses the knowledge of DPDK concepts and
-packet framework. For more details, read DPDK Getting Started Guide, DPDK
-Programmers Guide, DPDK Sample Applications Guide.
-
-Scope
-==========
-This application provides a standalone DPDK based high performance vACL Virtual
-Network Function implementation.
-
-Features
-===========
-The vACL VNF currently supports the following functionality
-  • CLI based Run-time rule configuration.(Add, Delete, List,  Display,  Clear, Modify)
-  • Ipv4 and ipv6 standard 5 tuple packet Selector support.
-  • Multithread support
-  • Multiple physical port support
-  • Hardware and Software Load Balancing
-  • L2L3 stack support for ARP/ICMP handling
-  • ARP (request, response, gratuitous)
-  • ICMP (terminal echo, echo response, passthrough)
-  • ICMPv6 and ND (Neighbor Discovery)
-
-High Level Design
-====================
-The ACL Filter performs bulk filtering of incoming packets based on rules in current ruleset,
-discarding any packets not permitted by the rules. The mechanisms needed for building the
-rule database and performing lookups are provided by the DPDK API.
-http://dpdk.org/doc/api/rte__acl_8h.html
-
-The Input FIFO contains all the incoming packets for ACL filtering. Packets will be dequeued
-from the FIFO in bulk for processing by the ACL. Packets will be enqueued to the output FIFO.
-The Input and Output FIFOs will be implemented using DPDK Ring Buffers.
-
-The DPDK ACL example: http://dpdk.org/doc/guides/sample_app_ug/l3_forward_access_ctrl.html
-#figure-ipv4-acl-rule contains a suitable syntax and parser for ACL rules.
-
-Components of vACL
-=======================
-In vACL, each component is constructed using packet framework pipelines.
-It includes Rx and Tx Driver, Master pipeline, load balancer pipeline and
-vACL worker pipeline components. A Pipeline framework is a collection of input
-ports, table(s),output ports and actions (functions).
-
----------------------------
-Receive and Transmit Driver
----------------------------
-Packets will be received in bulk and provided to LoadBalancer(LB) thread.
-Transimit takes packets from worker threads in a dedicated ring and sent to
-hardware queue.
-
----------------------------
-Master Pipeline
----------------------------
-The Master component is part of all the IP Pipeline applications. This component
-does not process any packets and should configure with Core 0, to allow
-other cores for processing of the traffic. This component is responsible for
-1. Initializing each component of the Pipeline application in different threads
-2. Providing CLI shell for the user control/debug
-3. Propagating the commands from user to the corresponding components
-
----------------------------
-ARPICMP Pipeline
----------------------------
-This pipeline processes the APRICMP packets.
-
----------------------------
-TXRX Pipelines
----------------------------
-The TXTX and RXRX pipelines are pass through pipelines to forward both ingress
-and egress traffic to Loadbalancer. This is required when the Software
-Loadbalancer is used.
-
----------------------------
-Load Balancer Pipeline
----------------------------
-The vACL support both hardware and software balancing for load blalcning of
-traffic across multiple VNF threads. The Hardware load balncing require support
-from hardware like Flow Director for steering of packets to application through
-hardware queues.
-
-The Software Load balancer is also supported if hardware loadbalancing can't be
-used for any reason. The TXRX along with LOADB pipeline provides support for
-software load balancing by distributing the flows to Multiple vACL worker
-threads.
-Loadbalancer (HW or SW) distributes traffic based on the 5 tuple (src addr, src
-port, dest addr, dest port and protocol) applying an XOR logic distributing to
-active worker threads, thereby maintaining an affinity of flows to worker
-threads.
-
----------------------------
-vACL Pipeline
----------------------------
-The vACL performs the rule-based packet filtering.
-
-vACL Topology
-------------------------
-
-::
-
-  IXIA(Port 0)-->(Port 0)VNF(Port 1)-->(Port 1) IXIA
-  operation:
-
-    Egress --> The packets sent out from ixia(port 0) will be sent through ACL to ixia(port 1).
-
-    Igress --> The packets sent out from ixia(port 1) will be sent through ACL to ixia(port 0).
-
-vACL Topology (L4REPLAY)
-------------------------------------
-
-::
-
-  IXIA(Port 0)-->(Port 0)VNF(Port 1)-->(Port 0)L4REPLAY
-
-  operation:
-
-    Egress --> The packets sent out from ixia will pass through vACL to L3FWD/L4REPLAY.
-
-    Ingress --> The L4REPLAY upon reception of packets (Private to Public Network),
-    will immediately replay back the traffic to IXIA interface. (Pub -->Priv).
-
-How to run L4Replay
---------------------
-After the installation of samplevnf
-
-::
-
-     go to <samplevnf/VNFs/L4Replay>
-     ./buid/L4replay -c  core_mask -n no_of_channels(let it be as 2) -- -p PORT_MASK --config="(port,queue,lcore)"
-     eg: ./L4replay -c 0xf -n 4 -- -p 0x3 --config="(0,0,1)"
-
-Installation, Compile and Execution
-=======================================
-Plase refer to <samplevnf>/docs/vACL/INSTALL.rst for installation, configuration, compilation
-and execution.
diff --git a/docs/vACL/RELEASE_NOTES.rst b/docs/vACL/RELEASE_NOTES.rst
deleted file mode 100644
index c947a371..00000000
--- a/docs/vACL/RELEASE_NOTES.rst
+++ /dev/null
@@ -1,81 +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 - Release Notes
-=========================================================
-
-Introduction
-===================
-
-This is a beta release for Sample Virtual ACL VNF.
-This vACL can application can be run independently (refer INSTALL.rst).
-
-User Guide
-===============
-Refer to README.rst for further details on vACL, HLD, features supported, test
-plan. For build configurations and execution requisites please refer to
-INSTALL.rst.
-
-Feature for this release
-===========================
-The vACL VNF currently supports the following functionality:
-  • CLI based Run-time rule configuration.(Add,Delete,List,Display,Clear,Modify)
-  • Ipv4 and ipv6 standard 5 tuple packet Selector support.
-  • Multithread support
-  • Multiple physical port support
-  • Hardware and Software Load Balancing
-  • L2L3 stack support for ARP/ICMP handling
-  • ARP (request, response, gratuitous)
-  • ICMP (terminal echo, echo response, passthrough)
-  • ICMPv6 and ND (Neighbor Discovery)
-
-System requirements - OS and kernel version
-==============================================
-This is supported on Ubuntu 14.04 and 16.04 and kernel version less than 4.5
-
-   VNFs on BareMetal support:
-         OS: Ubuntu 14.04 or 16.04 LTS
-         kernel: < 4.5
-         http://releases.ubuntu.com/16.04/
-         Download/Install the image: ubuntu-16.04.1-server-amd64.iso
-
-   VNFs on Standalone Hypervisor
-         HOST OS: Ubuntu 14.04 or 16.04 LTS
-         http://releases.ubuntu.com/16.04/
-         Download/Install the image: ubuntu-16.04.1-server-amd64.iso
-
-            -   OVS (DPDK) - 2.5
-            -   kernel: < 4.5
-            -   Hypervisor - KVM
-            -   VM OS - Ubuntu 16.04/Ubuntu 14.04
-
-Known Bugs and limitations
-=============================
- - Hardware Load Balancer feature is supported on Fortville nic ACL
-   version 4.53 and below.
- - Hardware Checksum offload is not supported for IPv6 traffic.
- - vACL on sriov is tested upto 4 threads
-
-Future Work
-==============
-Following would be possible enhancements
- - Performance optimization on different platforms
-
-References
-=============
-Following links provides additional information for differenet version of DPDKs
-
-.. _QUICKSTART:
-                        http://dpdk.org/doc/guides-16.04/linux_gsg/quick_start.html
-                        http://dpdk.org/doc/guides-16.11/linux_gsg/quick_start.html
-                        http://dpdk.org/doc/guides-17.02/linux_gsg/quick_start.html
-                        http://dpdk.org/doc/guides-17.05/linux_gsg/quick_start.html
-
-.. _DPDKGUIDE:
-                        http://dpdk.org/doc/guides-16.04/prog_guide/index.html
-                        http://dpdk.org/doc/guides-16.11/prog_guide/index.html
-                        http://dpdk.org/doc/guides-17.02/prog_guide/index.html
-                        http://dpdk.org/doc/guides-17.05/prog_guide/index.html
diff --git a/docs/vACL/index.rst b/docs/vACL/index.rst
deleted file mode 100644
index c1ae029b..00000000
--- a/docs/vACL/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-####################
-vACL samplevnf
-####################
-
-.. toctree::
-   :numbered:
-   :maxdepth: 2
-
-   RELEASE_NOTES.rst
-   README.rst
-   INSTALL.rst