.. 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