docs/vACL/RELEASE_NOTES.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International
   2 .. License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) OPNFV, National Center of Scientific Research "Demokritos" and others.
   5
   6 =========================================================
   7 Virtual ACL - vACL
   8 =========================================================
   9
  10 1.      Introduction
  11 ================
  12
  13 This is a beta release for Sample Virtual ACL VNF.
  14 This vACL can application can be run independently (refer INSTALL.rst).
  15
  16 2.      User Guide
  17 ===============
  18 Refer to README.rst for further details on vACL, HLD, features supported, test
  19 plan. For build configurations and execution requisites please refer to
  20 INSTALL.rst.
  21
  22 3. Feature for this release
  23 ===========================
  24 The vACL VNF currently supports the following functionality:
  25   • CLI based Run-time rule configuration.(Add, Delete, List,  Display,  Clear, Modify)
  26   • Ipv4 and ipv6 standard 5 tuple packet Selector support.
  27   • Multithread support
  28   • Multiple physical port support
  29   • Hardware and Software Load Balancing
  30   • L2L3 stack support for ARP/ICMP handling
  31   • ARP (request, response, gratuitous)
  32   • ICMP (terminal echo, echo response, passthrough)
  33   • ICMPv6 and ND (Neighbor Discovery)
  34
  35 4. System requirements - OS and kernel version
  36 ==============================================
  37 This is supported on Ubuntu 14.04 and Ubuntu 16.04 and kernel version less than 4.5
  38
  39    VNFs on BareMetal support:
  40                 OS: Ubuntu 14.04 or 16.04 LTS
  41                 kernel: < 4.5
  42                 http://releases.ubuntu.com/16.04/
  43                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  44
  45    VNFs on Standalone Hypervisor
  46                 HOST OS: Ubuntu 14.04 or 16.04 LTS
  47                 http://releases.ubuntu.com/16.04/
  48                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  49              -   OVS (DPDK) - 2.5
  50                    -   kernel: < 4.5
  51              -   Hypervisor - KVM
  52              -   VM OS - Ubuntu 16.04/Ubuntu 14.04
  53
  54 5. Known Bugs and limitations
  55 =============================
  56  - Hardware Load Balancer feature is supported on Fortville nic ACL version 4.53 and below.
  57  - Hardware Checksum offload is not supported for IPv6 traffic.
  58  - vACL on sriov is tested upto 4 threads
  59
  60 6. Future Work
  61 ==============
  62 Following would be possible enhancements
  63  - Performance optimization on different platforms
  64
  65 7. References
  66 =============
  67 Following links provides additional information
  68         .. _QUICKSTART: http://dpdk.org/doc/guides-16.04/linux_gsg/quick_start.html
  69         .. _DPDKGUIDE: http://dpdk.org/doc/guides-16.04/prog_guide/index.html