From 29bfcbc9b8c1d9b1ebe62e3170524f0c53467110 Mon Sep 17 00:00:00 2001 From: Anand B Jyoti Date: Tue, 4 Jul 2017 10:26:39 +0530 Subject: docs: Update install and release docs for DPDK migration support JIRA: SAMPLEVNF-48 Updating INSTALL.rst and RELEASE_NOTES.rst for DPDK migration support. The additional files are created to make it as per the opnfv document standard to generate the html files. Change-Id: I4b0af4c3afeef91fc806285b02c0ce47d61ebfbd Signed-off-by: Anand B Jyoti --- docs/INSTALL.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/INSTALL.rst (limited to 'docs/INSTALL.rst') diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst new file mode 100644 index 00000000..6c321846 --- /dev/null +++ b/docs/INSTALL.rst @@ -0,0 +1,34 @@ +.. 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. + +============================ +samplevf Installation Guide +============================ + +Introduction +============ +This project provides a placeholder for various sample VNF (Virtual Network Function) +development which includes example reference architecture and optimization methods +related to VNF/Network service for high performance VNF + +The sample VNFs are Open Source approximations* of Telco grade VNF’s using +optimized VNF + NFVi Infrastructure libraries, with Performance Characterization +of Sample† Traffic Flows. + +:: + + * Not a commercial product. Encourage the community to contribute and close the feature gaps. + † No Vendor/Proprietary Workloads + +VNF supported +============= + + - Carrier Grade Network Address Translation (CG-NAT) VNF + - Firewall (vFW) VNF + - Access Control List (vACL) VNF + +Please refer docs folder for individual VNF Installation guide. + +Note:- Each VNF should include a installation document explain the process to install and run VNF. -- cgit 1.2.3-korg