summaryrefslogtreecommitdiffstats
path: root/docs/userguide/introduction.rst
diff options
context:
space:
mode:
authorkalyanreddy <reddyx.gundarapu@intel.com>2017-03-28 11:34:11 +0530
committerJiang, Yunhong <yunhong.jiang@intel.com>2017-03-28 14:27:51 +0000
commitb04935b08394a9b64b69429215e27f0323065bfa (patch)
treecf0d1e241a2d01a187e408d0cb52b5cf4c3c986e /docs/userguide/introduction.rst
parent9f343782f79512bb6423c973f591dcc90b63ab6b (diff)
Update documentation structure.
This patch is used to update documentation structure. Change-Id: I50d4ef4256ccfc57a0434123e7532a50000582cf Co-Authored by:Srinivas <srinivas.atmakuri@tcs.com> Co-Authored by:RajithaY<rajithax.yerrumsetty@intel.com> Co-Authored by:shravani paladugula <shravanix.paladugula@intel.com> Co-Authored by:Navya Bathula <navyax.bathula@intel.com> Signed-off-by: Gundarapu Kalyan Reddy <reddyx.gundarapu@intel.com> (cherry picked from commit f1f3cc27f23bdde81c37d8142d4288d811bd5e45)
Diffstat (limited to 'docs/userguide/introduction.rst')
-rw-r--r--docs/userguide/introduction.rst88
1 files changed, 0 insertions, 88 deletions
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
deleted file mode 100644
index d4ee81143..000000000
--- a/docs/userguide/introduction.rst
+++ /dev/null
@@ -1,88 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-.. http://creativecommons.org/licenses/by/4.0
-
-======================
-Userguide Introduction
-======================
-
-Overview
---------
-
-The project "NFV Hypervisors-KVM" makes collaborative efforts to enable NFV
-features for existing hypervisors, which are not necessarily designed or
-targeted to meet the requirements for the NFVI.The KVM4NFV scenario
-consists of Continuous Integration builds, deployments and testing
-combinations of virtual infrastructure components.
-
-KVM4NFV Features
-----------------
-
-Using this project, the following areas are targeted-
-
-* 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
-* Inter-VM communication
-* Fast live migration
-
-Some of the above items would require software development and/or specific
-hardware features, and some need just configurations information for the
-system (hardware, BIOS, OS, etc.).
-
-We include a requirements gathering stage as a formal part of the project.
-For each subproject, we will start with an organized requirement stage so
-that we can determine specific use cases (e.g. what kind of VMs should be
-live migrated) and requirements (e.g. interrupt latency, jitters, Mpps,
-migration-time, down-time, etc.) to set out the performance goals.
-
-Potential future projects would include:
-
-* Dynamic scaling (via scale-out) using VM instantiation
-* Fast live migration for SR-IOV
-
-The user guide outlines how to work with key components and features in
-the platform, each feature description section will indicate the scenarios
-that provide the components and configurations required to use it.
-
-The configuration guide details which scenarios are best for you and how to
-install and configure them.
-
-General usage guidelines
-------------------------
-
-The user guide for KVM4NFV features and capabilities provide step by step
-instructions for using features that have been configured according to the
-installation and configuration instructions.
-
-Scenarios User Guide
---------------------
-
-The procedure to deploy/test `KVM4NFV scenarios`_ in a nested virtualization
-or on bare-metal environment is mentioned in the below link. The kvm4nfv user guide can
-be found at docs/scenarios
-
-.. code:: bash
-
- http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description
-
-.. _KVM4NFV scenarios: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description
-
-The deployment has been verified for `os-nosdn-kvm-ha`_, os-nosdn-kvm-noha, `os-nosdn-kvm_ovs_dpdk-ha`_,
-`os-nosdn-kvm_ovs_dpdk-noha`_ and `os-nosdn-kvm_ovs_dpdk_bar-ha`_, `os-nosdn-kvm_ovs_dpdk_bar-noha`_ test scenarios.
-
-For brief view of the above scenarios use:
-
-.. code:: bash
-
- http://artifacts.opnfv.org/kvmfornfv/docs/index.html#scenario-abstract
-
-.. _os-nosdn-kvm-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description
-
-.. _os-nosdn-kvm_ovs_dpdk-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk-ha-overview-and-description
-
-.. _os-nosdn-kvm_ovs_dpdk-noha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk-noha-overview-and-description
-
-.. _os-nosdn-kvm_ovs_dpdk_bar-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk_bar-ha-overview-and-description
-
-.. _os-nosdn-kvm_ovs_dpdk_bar-noha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk_bar-noha-overview-and-description