docs/UDP_Replay/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 UDP_Replay
   8 =========================================================
   9
  10 1. Introduction
  11 ================
  12
  13 This is a beta release for Sample UDP_Replay application.
  14 This UDP_Replay can application can be run independently (refer INSTALL.rst).
  15
  16 2. User Guide
  17 ===============
  18 Refer to README.rst for further details on UDP_Replay, 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 UDP_Replay:
  25   - L2l3 stack
  26   - Interface Manager
  27   - ARP solicitation & response. implements ARP states
  28   - Implements ICMPv4 support handling echo request/response messages
  29   - ICMPv6 support handling echo request/response messages
  30   - ND handling neighbour solicitation & neighbour advertisement messages
  31
  32 4. System requirements - OS and kernel version
  33 ==============================================
  34 This is supported on Ubuntu 14.04 and Ubuntu 16.04 and kernel version less than 4.5
  35
  36    VNFs on BareMetal support:
  37                 OS: Ubuntu 14.04 or 16.04 LTS
  38                 kernel: < 4.5
  39                 http://releases.ubuntu.com/16.04/
  40                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  41
  42    VNFs on Standalone Hypervisor
  43                 HOST OS: Ubuntu 14.04 or 16.04 LTS
  44                 http://releases.ubuntu.com/16.04/
  45                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  46              -   OVS (DPDK) - 2.5
  47                    -   kernel: < 4.5
  48              -   Hypervisor - KVM
  49              -   VM OS - Ubuntu 16.04/Ubuntu 14.04
  50
  51 5. Known Bugs and limitations
  52 =============================
  53  - Hadware Load Balancer feature is supported on fortville nic FW version 4.53 and below.
  54  - Hardware Checksum offload is not supported for IPv6 traffic.
  55
  56 6. Future Work
  57 ==============
  58 Following would be possible enhancement functionalities
  59  - Automatic enable/disable of synproxy
  60  - Support TCP timestamps with synproxy
  61  - FTP ALG integration
  62  - Performance optimization on different platforms
  63
  64 7. References
  65 =============
  66 Following links provides additional information
  67         .. _QUICKSTART: http://dpdk.org/doc/guides-16.04/linux_gsg/quick_start.html
  68         .. _DPDKGUIDE: http://dpdk.org/doc/guides-16.04/prog_guide/index.html