Add the documentation for kvm4nfv project

[kvmfornfv.git] / docs / all / index.rst

diff --git a/docs/all/index.rst b/docs/all/index.rst
new file mode 100644 (file)
index 0000000..fed745e
--- /dev/null
+++ b/docs/all/index.rst
@@ -0,0 +1,44 @@
+===============
+KVM4NFV project
+===============
+
+Welcome to KVM4NFV_ project!
+
+
+
+.. _KVM4NFV: https://wiki.opnfv.org/nfv-kvm
+
+Contents:
+
+KVM4NFV Project Description
+===========================
+
+The NFV hypervisors provide crucial functionality in the NFV Infrastructure
+(NFVI). The existing hypervisors, however, are not necessarily designed or
+targeted to meet the requirements for the NFVI, and we need to make
+collaborative efforts toward enabling the NFV features.
+
+The KVM4NFV project focuses on the KVM hypervisor to enhance it for NFV, by
+looking at the following areas
+
++ Minimal Interrupt latency variation for data plane VNFs
+    * Minimal Timing Variation for Timing correctness of real-time VNFs
+    * Minimal packet latency variation for data-plane VNFs
++ Fast live migration
+
+hile these items require software development and/or specific hardware features
+there are also some adjustments that need to be made to system configuration
+information, like hardware, BIOS, OS, etc.
+
+.. toctree::
+        :numbered:
+        :maxdepth: 1
+
+Setup Guides
+============
+.. toctree::
+        :maxdepth: 2
+
+        environment-setup
+        tunning
+