d4ee81143b82f1efaad85b39f5b1ce5cde833834
[kvmfornfv.git] / docs / userguide / introduction.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. http://creativecommons.org/licenses/by/4.0
4
5 ======================
6 Userguide Introduction
7 ======================
8
9 Overview
10 --------
11
12 The project "NFV Hypervisors-KVM" makes collaborative efforts to enable NFV
13 features for existing hypervisors, which are not necessarily designed or
14 targeted to meet the requirements for the NFVI.The KVM4NFV scenario
15 consists of Continuous Integration builds, deployments and testing
16 combinations of virtual infrastructure components.
17
18 KVM4NFV Features
19 ----------------
20
21 Using this project, the following areas are targeted-
22
23 * Minimal Interrupt latency variation for data plane VNFs:
24    * Minimal Timing Variation for Timing correctness of real-time VNFs
25    * Minimal packet latency variation for data-plane VNFs
26 * Inter-VM communication
27 * Fast live migration
28
29 Some of the above items would require software development and/or specific
30 hardware features, and some need just configurations information for the
31 system (hardware, BIOS, OS, etc.).
32
33 We include a requirements gathering stage as a formal part of the project.
34 For each subproject, we will start with an organized requirement stage so
35 that we can determine specific use cases (e.g. what kind of VMs should be
36 live migrated) and requirements (e.g. interrupt latency, jitters, Mpps,
37 migration-time, down-time, etc.) to set out the performance goals.
38
39 Potential future projects would include:
40
41 * Dynamic scaling (via scale-out) using VM instantiation
42 * Fast live migration for SR-IOV
43
44 The user guide outlines how to work with key components and features in
45 the platform, each feature description section will indicate the scenarios
46 that provide the components and configurations required to use it.
47
48 The configuration guide details which scenarios are best for you and how to
49 install and configure them.
50
51 General usage guidelines
52 ------------------------
53
54 The user guide for KVM4NFV features and capabilities provide step by step
55 instructions for using features that have been configured according to the
56 installation and configuration instructions.
57
58 Scenarios User Guide
59 --------------------
60
61 The procedure to deploy/test `KVM4NFV scenarios`_ in a nested virtualization
62 or on bare-metal environment is mentioned in the below link. The kvm4nfv user guide can
63 be found at docs/scenarios
64
65 .. code:: bash
66
67     http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description
68
69 .. _KVM4NFV scenarios: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description
70
71 The deployment has been verified for `os-nosdn-kvm-ha`_, os-nosdn-kvm-noha, `os-nosdn-kvm_ovs_dpdk-ha`_,
72 `os-nosdn-kvm_ovs_dpdk-noha`_ and `os-nosdn-kvm_ovs_dpdk_bar-ha`_, `os-nosdn-kvm_ovs_dpdk_bar-noha`_ test scenarios.
73
74 For brief view of the above scenarios use:
75
76 .. code:: bash
77
78   http://artifacts.opnfv.org/kvmfornfv/docs/index.html#scenario-abstract
79
80 .. _os-nosdn-kvm-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description
81
82 .. _os-nosdn-kvm_ovs_dpdk-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk-ha-overview-and-description
83
84 .. _os-nosdn-kvm_ovs_dpdk-noha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk-noha-overview-and-description
85
86 .. _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
87
88 .. _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