summaryrefslogtreecommitdiffstats
path: root/docs/INSTALL.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/INSTALL.rst')
-rw-r--r--docs/INSTALL.rst34
1 files changed, 34 insertions, 0 deletions
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.