docs/vCGNAPT/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 Carrier Grade Network Address Port Translation - vCGNAPT
   8 =========================================================
   9
  10 1.      Introduction
  11 ================
  12 This is the beta release for vCGNAPT VNF.
  13 vCGNAPT application can be run independently (refer INSTALL.rst).
  14
  15 2.      User Guide
  16 ===============
  17 Refer to README.rst for further details on vCGNAPT, HLD, features supported, test
  18 plan. For build configurations and execution requisites please refer to
  19 INSTALL.rst.
  20
  21 3. Feature for this release
  22 ===========================
  23 This release supports following features as part of vCGNAPT:
  24 -       vCGNAPT can run as a standalone application on bare-metal linux server or on a
  25         virtual machine using SRIOV and OVS dpdk.
  26 - Static NAT
  27 - Dynamic NAT
  28 - Static NAPT
  29 - Dynamic NAPT
  30 - ARP (request, response, gratuitous)
  31 - ICMP (terminal echo, echo response, passthrough)
  32 - ICMPv6 and ND (Neighbor Discovery)
  33 - UDP, TCP and ICMP protocol passthrough
  34 - Multithread support
  35 - Multiple physical port support
  36 - Limiting max ports per client
  37 - Limiting max clients per public IP address
  38 - Live Session tracking to NAT flow
  39 - PCP support
  40 - NAT64
  41 - ALG SIP
  42 - ALG FTP
  43
  44 4. System requirements - OS and kernel version
  45 ==============================================
  46 This is supported on Ubuntu 14.04 and Ubuntu 16.04 and kernel version less than 4.5
  47
  48    VNFs on BareMetal support:
  49                 OS: Ubuntu 14.04 or 16.04 LTS
  50                 kernel: < 4.5
  51                 http://releases.ubuntu.com/16.04/
  52                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  53
  54    VNFs on Standalone Hypervisor
  55                 HOST OS: Ubuntu 14.04 or 16.04 LTS
  56                 http://releases.ubuntu.com/16.04/
  57                 Download/Install the image: ubuntu-16.04.1-server-amd64.iso
  58              -   OVS (DPDK) - 2.5
  59                    -   kernel: < 4.5
  60              -   Hypervisor - KVM
  61              -   VM OS - Ubuntu 16.04/Ubuntu 14.04
  62
  63 5. Known Bugs and limitations
  64 =============================
  65 -       Hadware Loab Balancer feature is supported on fortville nic FW version 4.53 and below.
  66 - L4 UDP Replay is used to capture throughput for dynamic cgnapt
  67 - Hardware Checksum offload is not supported for IPv6 traffic.
  68 - CGNAPT on sriov is tested till 4 threads
  69
  70 6. Future Work
  71 ==============
  72 - SCTP passthrough support
  73 - Multi-homing support
  74 - Performance optimization on different platforms
  75
  76 7. References
  77 =============
  78 Following links provides additional information
  79         .. _QUICKSTART: http://dpdk.org/doc/guides-16.04/linux_gsg/quick_start.html
  80         .. _DPDKGUIDE: http://dpdk.org/doc/guides-16.04/prog_guide/index.html