diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/Ftrace.debugging.tool.userguide.rst | 35 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.render.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 8 | ||||
| -rw-r--r-- | docs/userguide/introduction.rst | 36 | ||||
| -rw-r--r-- | docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst | 16 | ||||
| -rw-r--r-- | docs/userguide/low_latency.userguide.rst | 19 | ||||
| -rw-r--r-- | docs/userguide/packet_forwarding.userguide.rst | 20 | ||||
| -rw-r--r-- | docs/userguide/pcm_utility.userguide.rst | 26 |
8 files changed, 105 insertions, 57 deletions
diff --git a/docs/userguide/Ftrace.debugging.tool.userguide.rst b/docs/userguide/Ftrace.debugging.tool.userguide.rst index fc0858a6d..95b7f8fe5 100644 --- a/docs/userguide/Ftrace.debugging.tool.userguide.rst +++ b/docs/userguide/Ftrace.debugging.tool.userguide.rst @@ -16,7 +16,7 @@ work of several assorted tracing utilities. One of the most common uses of ftrace is the event tracing. **Note:** -- For KVMFORNFV, Ftrace is preferred as it is in-built kernel tool +- For KVM4NFV, Ftrace is preferred as it is in-built kernel tool - More stable compared to other debugging tools Version Features @@ -28,10 +28,10 @@ Version Features | | | +=============================+===============================================+ | | - Ftrace Debugging tool is not implemented in | -| Colorado | Colorado release of KVMFORNFV | +| Colorado | Colorado release of KVM4NFV | | | | +-----------------------------+-----------------------------------------------+ -| | - Ftrace aids in debugging the KVMFORNFV | +| | - Ftrace aids in debugging the KVM4NFV | | Danube | 4.4-linux-kernel level issues | | | - Option to disable if not required | +-----------------------------+-----------------------------------------------+ @@ -155,31 +155,36 @@ Examples: [tracing]# echo 1 > tracing_on; -Ftrace in KVMFORNFV -------------------- -Ftrace is part of KVMFORNFV D-Release. KVMFORNFV built 4.4-linux-Kernel will be tested by +Ftrace in KVM4NFV +----------------- +Ftrace is part of KVM4NFV D-Release. KVM4NFV built 4.4-linux-Kernel will be tested by executing cyclictest and analyzing the results/latency values (max, min, avg) generated. -Ftrace (or) function tracer is a stable kernel inbuilt debugging tool which tests kernel in real -time and outputs a log as part of the code. These output logs are useful in following ways. +Ftrace (or) function tracer is a stable kernel inbuilt debugging tool which tests real time +kernel and outputs a log as part of the code. These output logs are useful in following ways. - Kernel Debugging. - Helps in Kernel code optimization and - Can be used to better understand the kernel level code flow -Ftrace logs for KVMFORNFV can be found `here`_: +Ftrace logs for KVM4NFV can be found `here`_: .. _here: http://artifacts.opnfv.org/kvmfornfv.html -Ftrace Usage in KVMFORNFV Kernel Debugging: -------------------------------------------- -Kvmfornfv has two scripts in /ci/envs to provide ftrace tool: +Ftrace Usage in KVM4NFV Kernel Debugging: +----------------------------------------- +Kvm4nfv has two scripts in /ci/envs to provide ftrace tool: - enable_trace.sh - disable_trace.sh -Enabling Ftrace in KVMFORNFV ----------------------------- +.. code:: bash + + Found at., + $ cd kvmfornfv/ci/envs + +Enabling Ftrace in KVM4NFV +-------------------------- The enable_trace.sh script is triggered by changing ftrace_enable value in test_kvmfornfv.sh script to 1 (which is zero by default). Change as below to enable Ftrace. @@ -241,7 +246,7 @@ In disable trace script the following are done: Publishing Ftrace logs: ----------------------- The generated trace log is pushed to `artifacts`_ by kvmfornfv-upload-artifact.sh -script available in releng which will be triggered as a part of kvmfornfv daily job. +script available in releng which will be triggered as a part of kvm4nfv daily job. The `trigger`_ in the script is., .. code:: bash diff --git a/docs/userguide/feature.userguide.render.rst b/docs/userguide/feature.userguide.render.rst index 0e2738ae3..3bed21fc9 100644 --- a/docs/userguide/feature.userguide.render.rst +++ b/docs/userguide/feature.userguide.render.rst @@ -7,7 +7,7 @@ Using Danube Features ========================== The following sections of the user guide provide feature specific usage -guidelines and references for KVM4NFV CICD project. +guidelines and references for KVM4NFV project. * <project>/docs/userguide/low_latency.userguide.rst * <project>/docs/userguide/live_migration.userguide.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 0d5089e01..ff6898746 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -2,9 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 -******************** -KVMforNFV User Guide -******************** +.. _kvmfornfv-userguide: + +****************** +KVM4NFV User Guide +****************** .. toctree:: :maxdepth: 3 diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst index 9a22bdebd..d4ee81143 100644 --- a/docs/userguide/introduction.rst +++ b/docs/userguide/introduction.rst @@ -11,7 +11,7 @@ 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 CICD scenario +targeted to meet the requirements for the NFVI.The KVM4NFV scenario consists of Continuous Integration builds, deployments and testing combinations of virtual infrastructure components. @@ -51,6 +51,38 @@ install and configure them. General usage guidelines ------------------------ -The user guide for KVM4NFV CICD features and capabilities provide step by step +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 diff --git a/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst b/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst index e7a516bff..468f471e7 100644 --- a/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst +++ b/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 -========================= -KVMFORNFV Dashboard Guide -========================= +======================= +KVM4NFV Dashboard Guide +======================= Dashboard for KVM4NFV Daily Test Results ---------------------------------------- @@ -48,11 +48,11 @@ Version Features Installation Steps: ------------------- -To configure Yardstick, InfluxDB and Grafana for KVMFORNFV project following sequence of steps are followed: +To configure Yardstick, InfluxDB and Grafana for KVM4NFV project following sequence of steps are followed: **Note:** -All the below steps are done as per the script, which is a part of CICD integration. +All the below steps are done as per the script, which is a part of CICD integration of kvmfornfv. .. code:: bash @@ -229,10 +229,10 @@ on Grafana need to be created by following the `Grafana-procedure`_ and then pus .. _GrafanaDoc: http://docs.grafana.org/ -Understanding Kvmfornfv Grafana Dashboard ------------------------------------------- +Understanding Kvm4nfv Grafana Dashboard +--------------------------------------- -The Kvmfornfv dashboard found at http://testresults.opnfv.org/ currently supports graphical view of cyclictest. For viewing Kvmfornfv dashboarduse, +The Kvm4nfv dashboard found at http://testresults.opnfv.org/ currently supports graphical view of cyclictest. For viewing Kvm4nfv dashboarduse, .. code:: bash diff --git a/docs/userguide/low_latency.userguide.rst b/docs/userguide/low_latency.userguide.rst index e65c8aa4f..f027b4939 100644 --- a/docs/userguide/low_latency.userguide.rst +++ b/docs/userguide/low_latency.userguide.rst @@ -73,7 +73,7 @@ more explanation. Test cases to measure Latency ----------------------------- -The performance of the kvmfornfv is assesed by the latency values. Cyclictest and Packet forwarding +The performance of the kvm4nfv is assesed by the latency values. Cyclictest and Packet forwarding Test cases result in real time latency values of average, minimum and maximum. * Cyclictest @@ -83,7 +83,7 @@ Test cases result in real time latency values of average, minimum and maximum. 1. Cyclictest case ------------------- Cyclictest results are the most frequently cited real-time Linux metric. The core concept of Cyclictest is very simple. -In KVMFORNFV cyclictest is implemented on the Guest-VM with 4.4-Kernel RPM installed. It generated Max,Min and Avg +In KVM4NFV cyclictest is implemented on the Guest-VM with 4.4-Kernel RPM installed. It generated Max,Min and Avg values which help in assesing the kernel used. Cyclictest in currently divided into the following test types, * Idle-Idle @@ -132,20 +132,19 @@ Version Features | | | | +-----------------------+------------------+-----------------+ | - Idle - Idle | ``Y`` | ``Y`` | -| | | | ++-----------------------+------------------+-----------------+ | - Cpustress - Idle | | ``Y`` | -| | | | ++-----------------------+------------------+-----------------+ | - Memorystress - Idle | | ``Y`` | -| | | | ++-----------------------+------------------+-----------------+ | - IOstress - Idle | | ``Y`` | -| | | | +-----------------------+------------------+-----------------+ Idle-Idle test-type ~~~~~~~~~~~~~~~~~~~ Cyclictest in run on the Guest VM when Host,Guest are not under any kind of stress. This is the basic -cyclictest of the KVMFORNFV project. Outputs Avg, Min and Max latency values. +cyclictest of the KVM4NFV project. Outputs Avg, Min and Max latency values. .. figure:: images/idle-idle-test-type.png :name: idle-idle test type @@ -199,10 +198,10 @@ Not implemented for Danube release. 2. Packet Forwarding Test cases ------------------------------- -Packet forwarding is an other test case of Kvmfornfv. It measures the time taken by a packet to return +Packet forwarding is an other test case of Kvm4nfv. It measures the time taken by a packet to return to source after reaching its destination. This test case uses automated test-framework provided by -OPNFV VSWITCHPERF project and a traffic generator (IXIA is used for kvmfornfv). Only latency results -generating test cases are triggered as a part of kvmfornfv daily job. +OPNFV VSWITCHPERF project and a traffic generator (IXIA is used for kvm4nfv). Only latency results +generating test cases are triggered as a part of kvm4nfv daily job. Latency test measures the time required for a frame to travel from the originating device through the network to the destination device. Please note that RFC2544 Latency measurement will be superseded with diff --git a/docs/userguide/packet_forwarding.userguide.rst b/docs/userguide/packet_forwarding.userguide.rst index 22f9b9447..31341a908 100644 --- a/docs/userguide/packet_forwarding.userguide.rst +++ b/docs/userguide/packet_forwarding.userguide.rst @@ -9,7 +9,7 @@ Packet Forwarding About Packet Forwarding ----------------------- -Packet Forwarding is a test suite of KVMFORNFV. These latency tests measures the time taken by a +Packet Forwarding is a test suite of KVM4NFV. These latency tests measures the time taken by a **Packet** generated by the traffic generator to travel from the originating device through the network to the destination device. Packet Forwarding is implemented using test framework implemented by OPNFV VSWITCHPERF project and an ``IXIA Traffic Generator``. @@ -23,12 +23,12 @@ Version Features | | | +=============================+===================================================+ | | - Packet Forwarding is not part of Colorado | -| Colorado | release of KVMFORNFV | +| Colorado | release of KVM4NFV | | | | +-----------------------------+---------------------------------------------------+ -| | - Packet Forwarding is a testcase in KVMFORNFV | +| | - Packet Forwarding is a testcase in KVM4NFV | | | - Implements three scenarios (Host/Guest/SRIOV) | -| | as part of testing in KVMFORNFV | +| | as part of testing in KVM4NFV | | Danube | - Uses automated test framework of OPNFV | | | VSWITCHPERF software (PVP/PVVP) | | | - Works with IXIA Traffic Generator | @@ -480,7 +480,7 @@ Example of execution of VSPERF in "trafficgen" mode: Packet Forwarding Test Scenarios -------------------------------- -KVMFORNFV currently implements three scenarios as part of testing: +KVM4NFV currently implements three scenarios as part of testing: * Host Scenario * Guest Scenario. @@ -621,3 +621,13 @@ PCI passthrough support. Note: Qemu with PCI passthrough support can be used only with PVP test deployment. + +Results +~~~~~~~ + +The results for the packet forwarding test cases are uploaded to artifacts. +The link for the same can be found below + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv.html diff --git a/docs/userguide/pcm_utility.userguide.rst b/docs/userguide/pcm_utility.userguide.rst index 1ae68516c..6695d50c0 100644 --- a/docs/userguide/pcm_utility.userguide.rst +++ b/docs/userguide/pcm_utility.userguide.rst @@ -2,13 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 -=========================== -PCM Utility in KVMFORNFV -=========================== +====================== +PCM Utility in KVM4NFV +====================== Collecting Memory Bandwidth Information using PCM utility --------------------------------------------------------- -This chapter includes how the PCM utility is used in kvmfornfv +This chapter includes how the PCM utility is used in kvm4nfv to collect memory bandwidth information About PCM utility @@ -34,17 +34,17 @@ Version Features | | - pcm-memory.x will be executed before the | | Danube | execution of every testcase | | | - pcm-memory.x provides the memory bandwidth | -| | data throught out the testcases | +| | data throughout out the testcases | | | - used for all test-types (stress/idle) | -| | - Generated memory bandwidth logs which are | -| | to published to the KVMFORFNV artifacts | +| | - Generated memory bandwidth logs are | +| | published to the KVMFORFNV artifacts | +-----------------------------+-----------------------------------------------+ Implementation of pcm-memory.x: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The tool measures the memory bandwidth observed for every channel reporting seperately throughputs -for reads from memory and writes to the memory.pcm-memory.x tool tends to report values slightly +The tool measures the memory bandwidth observed for every channel reporting seperate throughput +for reads from memory and writes to the memory. pcm-memory.x tool tends to report values slightly higher than the application's own measurement. Command: @@ -90,10 +90,10 @@ Parameters | - System Memory Throughput(MB/s): 72140.62 | +-------------------------------------------------------------------------------+ -pcm-memory.x in KVMFORNFV: +pcm-memory.x in KVM4NFV: ~~~~~~~~~~~~~~~~~~~~~~~~~~ -pcm-memory is a part of KVMFORNFV in D release.pcm-memory.x will be executed with delay of 60 seconds +pcm-memory is a part of KVM4NFV in D release.pcm-memory.x will be executed with delay of 60 seconds before starting every testcase to monitor the memory traffic intensity which was handled in collect_MBWInfo function .The memory bandwidth information will be collected into the logs through the testcase updating every 60 seconds. @@ -107,7 +107,7 @@ the testcase updating every 60 seconds. 3.Installing MSR registers -Memory Bandwidth logs for KVMFORNFV can be found `here`_: +Memory Bandwidth logs for KVM4NFV can be found `here`_: .. code:: bash @@ -138,4 +138,4 @@ signal will be passed to terminate the pcm-memory process which was executing th Future Scope ------------ -PCM information will be added to cyclictest of kvmfornfv in yardstick. +PCM information will be added to cyclictest of kvm4nfv in yardstick. |