Merge "conntrack: timer reset in reply traffic causes performance impact"
[samplevnf.git] / INSTALL.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 SAMPLEVNF Installation Guide
8 ============================
9
10 Introduction
11 ============
12 This project provides a placeholder for various sample VNF (Virtual Network Function)
13 development which includes example reference architecture and optimization methods
14 related to VNF/Network service for high performance VNFs. 
15
16 The sample VNFs are Open Source approximations* of Telco grade VNF’s using
17 optimized VNF + NFVi Infrastructure libraries, with Performance Characterization
18 of Sample† Traffic Flows.
19 • * Not a commercial product. Encourage the community to contribute and close the feature gaps.
20 • † No Vendor/Proprietary Workloads 
21
22 VNF supported
23 =============
24  1. CG-NAT (Carrier Grade Network Address Translation) VNF
25  2. Firewall (vFW) VNF
26  4. Access Control List (vACL) VNF
27
28 Please refer docs folder for individual VNF Installation guide.
29
30 Note:- Each VNF should include a installation document explain the process to install and run VNF.