docs/vFW/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 Firewall - vFW
   8 =========================================================
   9
  10 1.      Introduction
  11 ================
  12
  13 This is a beta release for Sample Virtual Firewall VNF.
  14 This vFW can application can be run independently (refer INSTALL.rst).
  15
  16 2.      User Guide
  17 ===============
  18 Refer to README.rst for further details on vFW, 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 This release supports following features as part of vFW:
  25   - Basic packet filtering (malformed packets, IP fragments)
  26   - Connection tracking for TCP and UDP
  27   - Access Control List for rule based policy enforcement
  28   - SYN-flood protection via Synproxy* for TCP
  29   - UDP, TCP and ICMP protocol pass-through
  30   - CLI based enable/disable connection tracking, synproxy, basic packet
  31     filtering
  32   - L2L3 stack support for ARP/ICMP handling
  33   - ARP (request, response, gratuitous)
  34   - ICMP (terminal echo, echo response, passthrough)
  35   - ICMPv6 and ND (Neighbor Discovery)
  36   - Hardware and Software Load Balancing
  37   - Multithread support
  38   - Multiple physical port support
  39
  40 4. System requirements - OS and kernel version
  41 ==============================================
  42 This is supported on Ubuntu 14.04 and Ubuntu 16.04 and kernel version less than 4.5
  43
  44    VNFs on BareMetal support:
  45                 OS: Ubuntu 14.04 or 16.04 LTS
  46                 kernel: < 4.5
  47                 http://releases.ubuntu.com/16.04/
  48                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  49
  50    VNFs on Standalone Hypervisor
  51                 HOST OS: Ubuntu 14.04 or 16.04 LTS
  52                 http://releases.ubuntu.com/16.04/
  53                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  54              -   OVS (DPDK) - 2.5
  55                    -   kernel: < 4.5
  56              -   Hypervisor - KVM
  57              -   VM OS - Ubuntu 16.04/Ubuntu 14.04
  58
  59 5. Known Bugs and limitations
  60 =============================
  61  - Hadware Load Balancer feature is supported on fortville nic FW version 4.53 and below.
  62  - Hardware Checksum offload is not supported for IPv6 traffic.
  63  - vFW on sriov is tested upto 4 threads
  64  - Http Multiple clients/server with HWLB is not working
  65
  66 6. Future Work
  67 ==============
  68 Following would be possible enhancement functionalities
  69  - Automatic enable/disable of synproxy
  70  - Support TCP timestamps with synproxy
  71  - FTP ALG integration
  72  - Performance optimization on different platforms
  73
  74 7. References
  75 =============
  76 Following links provides additional information
  77         .. _QUICKSTART: http://dpdk.org/doc/guides-16.04/linux_gsg/quick_start.html
  78         .. _DPDKGUIDE: http://dpdk.org/doc/guides-16.04/prog_guide/index.html