From 3a2eb75a5ba494161655c84a23d11eb9f6a797e9 Mon Sep 17 00:00:00 2001 From: kalyanreddy Date: Tue, 28 Mar 2017 13:18:51 -0700 Subject: Update documentation structure. This patch includes adjusting docs directory structure for kvmfornfv project. Change-Id: Ic2f992cd5e8f6808ca3ba088172eb6da342182ba Signed-off-by: Gundarapu Kalyan Reddy --- docs/index.rst | 27 +- docs/release/configguide/abstract.rst | 16 + .../configguide/configuration.options.render.rst | 26 ++ .../images/brahmaputrafeaturematrix.jpg | Bin 0 -> 62966 bytes .../images/brahmaputrascenariomatrix.jpg | Bin 0 -> 51071 bytes docs/release/configguide/images/idle-idle-test.png | Bin 0 -> 14901 bytes .../configguide/images/stress-idle-test.png | Bin 0 -> 19033 bytes docs/release/configguide/images/weather-clear.jpg | Bin 0 -> 1286 bytes docs/release/configguide/images/weather-dash.jpg | Bin 0 -> 1010 bytes .../configguide/images/weather-few-clouds.jpg | Bin 0 -> 1348 bytes .../configguide/images/weather-overcast.jpg | Bin 0 -> 1215 bytes docs/release/configguide/index.rst | 19 + ...w-latency.feature.configuration.description.rst | 151 ++++++++ docs/release/configguide/scenariomatrix.rst | 129 +++++++ docs/release/configurationguide/abstract.rst | 16 - .../configuration.options.render.rst | 26 -- .../images/brahmaputrafeaturematrix.jpg | Bin 62966 -> 0 bytes .../images/brahmaputrascenariomatrix.jpg | Bin 51071 -> 0 bytes .../configurationguide/images/idle-idle-test.png | Bin 14901 -> 0 bytes .../configurationguide/images/stress-idle-test.png | Bin 19033 -> 0 bytes .../configurationguide/images/weather-clear.jpg | Bin 1286 -> 0 bytes .../configurationguide/images/weather-dash.jpg | Bin 1010 -> 0 bytes .../images/weather-few-clouds.jpg | Bin 1348 -> 0 bytes .../configurationguide/images/weather-overcast.jpg | Bin 1215 -> 0 bytes docs/release/configurationguide/index.rst | 19 - ...w-latency.feature.configuration.description.rst | 151 -------- docs/release/configurationguide/scenariomatrix.rst | 129 ------- docs/release/glossary/kvmfornfv_glossary.rst | 401 --------------------- docs/release/installation/abstract.rst | 11 + docs/release/installation/index.rst | 17 + .../kvm4nfv-cicd.installation.instruction.rst | 107 ++++++ .../installation/kvm4nfv-cicd.release.notes.rst | 103 ++++++ docs/release/installationprocedure/abstract.rst | 11 - docs/release/installationprocedure/index.rst | 16 - .../kvm4nfv-cicd.installation.instruction.rst | 107 ------ .../kvm4nfv-cicd.release.notes.rst | 103 ------ docs/release/release-notes/index.rst | 13 + docs/release/release-notes/release-notes.rst | 278 ++++++++++++++ docs/release/releasenotes/index.rst | 13 - docs/release/releasenotes/release-notes.rst | 280 -------------- docs/release/userguide/index.rst | 1 + .../kvmfornfv.cyclictest-dashboard.userguide.rst | 2 +- docs/release/userguide/kvmfornfv_glossary.rst | 401 +++++++++++++++++++++ 43 files changed, 1281 insertions(+), 1292 deletions(-) create mode 100644 docs/release/configguide/abstract.rst create mode 100644 docs/release/configguide/configuration.options.render.rst create mode 100644 docs/release/configguide/images/brahmaputrafeaturematrix.jpg create mode 100644 docs/release/configguide/images/brahmaputrascenariomatrix.jpg create mode 100644 docs/release/configguide/images/idle-idle-test.png create mode 100644 docs/release/configguide/images/stress-idle-test.png create mode 100644 docs/release/configguide/images/weather-clear.jpg create mode 100644 docs/release/configguide/images/weather-dash.jpg create mode 100644 docs/release/configguide/images/weather-few-clouds.jpg create mode 100644 docs/release/configguide/images/weather-overcast.jpg create mode 100644 docs/release/configguide/index.rst create mode 100644 docs/release/configguide/low-latency.feature.configuration.description.rst create mode 100644 docs/release/configguide/scenariomatrix.rst delete mode 100644 docs/release/configurationguide/abstract.rst delete mode 100644 docs/release/configurationguide/configuration.options.render.rst delete mode 100644 docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg delete mode 100644 docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg delete mode 100644 docs/release/configurationguide/images/idle-idle-test.png delete mode 100644 docs/release/configurationguide/images/stress-idle-test.png delete mode 100644 docs/release/configurationguide/images/weather-clear.jpg delete mode 100644 docs/release/configurationguide/images/weather-dash.jpg delete mode 100644 docs/release/configurationguide/images/weather-few-clouds.jpg delete mode 100644 docs/release/configurationguide/images/weather-overcast.jpg delete mode 100644 docs/release/configurationguide/index.rst delete mode 100644 docs/release/configurationguide/low-latency.feature.configuration.description.rst delete mode 100644 docs/release/configurationguide/scenariomatrix.rst delete mode 100644 docs/release/glossary/kvmfornfv_glossary.rst create mode 100644 docs/release/installation/abstract.rst create mode 100644 docs/release/installation/index.rst create mode 100644 docs/release/installation/kvm4nfv-cicd.installation.instruction.rst create mode 100644 docs/release/installation/kvm4nfv-cicd.release.notes.rst delete mode 100644 docs/release/installationprocedure/abstract.rst delete mode 100644 docs/release/installationprocedure/index.rst delete mode 100644 docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst delete mode 100644 docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst create mode 100644 docs/release/release-notes/index.rst create mode 100644 docs/release/release-notes/release-notes.rst delete mode 100644 docs/release/releasenotes/index.rst delete mode 100644 docs/release/releasenotes/release-notes.rst create mode 100644 docs/release/userguide/kvmfornfv_glossary.rst (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 1ae95533a..b597d04eb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,13 +23,13 @@ KVM4NFV Installation Procedure ****************************** .. toctree:: - :caption: Installation Procedure + :caption: Installation :numbered: :maxdepth: 4 - ./release/installationprocedure/abstract.rst - ./release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst - ./release/installationprocedure/kvm4nfv-cicd.release.notes.rst + ./release/installation/abstract.rst + ./release/installation/kvm4nfv-cicd.installation.instruction.rst + ./release/installation/kvm4nfv-cicd.release.notes.rst ******************** KVM4NFV Design Guide @@ -62,10 +62,10 @@ KVM4NFV Configuration Guide :numbered: :maxdepth: 4 - ./release/configurationguide/abstract.rst - ./release/configurationguide/configuration.options.render.rst - ./release/configurationguide/scenariomatrix.rst - ./release/configurationguide/low-latency.feature.configuration.description.rst + ./release/configguide/abstract.rst + ./release/configguide/configuration.options.render.rst + ./release/configguide/scenariomatrix.rst + ./release/configguide/low-latency.feature.configuration.description.rst ****************************************** KVM4NFV Scenarios Overview and Description @@ -155,14 +155,3 @@ KVM4NFV Releasenotes :maxdepth: 3 ./release/releasenotes/release-notes.rst - -**************** -KVM4NFV Glossary -**************** - -.. toctree:: - :caption: Glossary - :numbered: - :maxdepth: 3 - - ./release/glossary/kvmfornfv_glossary.rst diff --git a/docs/release/configguide/abstract.rst b/docs/release/configguide/abstract.rst new file mode 100644 index 000000000..3693bcab7 --- /dev/null +++ b/docs/release/configguide/abstract.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +====================== +Configuration Abstract +====================== + +This document provides guidance for the configurations available in the +Danube release of OPNFV + +The release includes four installer tools leveraging different technologies; +Apex, Compass4nfv, Fuel and JOID, which deploy components of the platform. + +This document also includes the selection of tools and components including +guidelines for how to deploy and configure the platform to an operational +state. diff --git a/docs/release/configguide/configuration.options.render.rst b/docs/release/configguide/configuration.options.render.rst new file mode 100644 index 000000000..71a78af2b --- /dev/null +++ b/docs/release/configguide/configuration.options.render.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +====================== +Configuration Options +====================== + +OPNFV provides a variety of virtual infrastructure deployments called scenarios +designed to host virtualised network functions (VNF's). KVM4NFV scenarios +provide specific capabilities and/or components aimed to solve specific +problems for the deployment of VNF's. KVM4NFV scenario includes components +such as OpenStack,KVM etc. which includes different source components or +configurations. + +.. note:: + + * Each KVM4NFV `scenario`_ provides unique features and capabilities, it is + important to understand your target platform capabilities before installing + and configuring. This configuration guide outlines how to configure components + in order to enable the features required. + + * More deatils of kvm4nfv scenarios installation and description can be found in the `scenario guide`_ of kvm4nfv docs + +.. _scenario: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description + +.. _scenario guide: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/abstract diff --git a/docs/release/configguide/images/brahmaputrafeaturematrix.jpg b/docs/release/configguide/images/brahmaputrafeaturematrix.jpg new file mode 100644 index 000000000..0d2a12279 Binary files /dev/null and b/docs/release/configguide/images/brahmaputrafeaturematrix.jpg differ diff --git a/docs/release/configguide/images/brahmaputrascenariomatrix.jpg b/docs/release/configguide/images/brahmaputrascenariomatrix.jpg new file mode 100644 index 000000000..84fc87a76 Binary files /dev/null and b/docs/release/configguide/images/brahmaputrascenariomatrix.jpg differ diff --git a/docs/release/configguide/images/idle-idle-test.png b/docs/release/configguide/images/idle-idle-test.png new file mode 100644 index 000000000..c9831df1d Binary files /dev/null and b/docs/release/configguide/images/idle-idle-test.png differ diff --git a/docs/release/configguide/images/stress-idle-test.png b/docs/release/configguide/images/stress-idle-test.png new file mode 100644 index 000000000..111c2a7d2 Binary files /dev/null and b/docs/release/configguide/images/stress-idle-test.png differ diff --git a/docs/release/configguide/images/weather-clear.jpg b/docs/release/configguide/images/weather-clear.jpg new file mode 100644 index 000000000..011ad52e9 Binary files /dev/null and b/docs/release/configguide/images/weather-clear.jpg differ diff --git a/docs/release/configguide/images/weather-dash.jpg b/docs/release/configguide/images/weather-dash.jpg new file mode 100644 index 000000000..3bf98dd27 Binary files /dev/null and b/docs/release/configguide/images/weather-dash.jpg differ diff --git a/docs/release/configguide/images/weather-few-clouds.jpg b/docs/release/configguide/images/weather-few-clouds.jpg new file mode 100644 index 000000000..51994ee84 Binary files /dev/null and b/docs/release/configguide/images/weather-few-clouds.jpg differ diff --git a/docs/release/configguide/images/weather-overcast.jpg b/docs/release/configguide/images/weather-overcast.jpg new file mode 100644 index 000000000..bdc1e0487 Binary files /dev/null and b/docs/release/configguide/images/weather-overcast.jpg differ diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 000000000..6aa2786fb --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _kvmfornfv-configguide: + +*************************** +Kvm4nfv Configuration Guide +*************************** + +Danube 1.0 +------------ + +.. toctree:: + :maxdepth: 2 + + ./abstract.rst + ./configuration.options.render.rst + ./low-latency.feature.configuration.description.rst + ./scenariomatrix.rst diff --git a/docs/release/configguide/low-latency.feature.configuration.description.rst b/docs/release/configguide/low-latency.feature.configuration.description.rst new file mode 100644 index 000000000..c53aa52f4 --- /dev/null +++ b/docs/release/configguide/low-latency.feature.configuration.description.rst @@ -0,0 +1,151 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +============================================= +Low Latency Feature Configuration Description +============================================= + +Introduction +------------ +In KVM4NFV project, we focus on the KVM hypervisor to enhance it for NFV, by +looking at the following areas initially + +* 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 + +Configuration of Cyclictest +--------------------------- + +Cyclictest measures Latency of response to a stimulus. Achieving low latency +with the KVM4NFV project requires setting up a special test environment. +This environment includes the BIOS settings, kernel configuration, kernel +parameters and the run-time environment. + +* For more information regarding the test environment, please visit + https://wiki.opnfv.org/display/kvm/KVM4NFV+Test++Environment + https://wiki.opnfv.org/display/kvm/Nfv-kvm-tuning + +Pre-configuration activities +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Intel POD10 is currently used as OPNFV-KVM4NFV test environment. The rpm +packages from the latest build are downloaded onto Intel-Pod10 jump server +from artifact repository. Yardstick running in a ubuntu docker container +on Intel Pod10-jump server will configure the host(intel pod10 node1/node2 +based on job type), the guest and triggers the cyclictest on the guest using +below sample yaml file. + + +.. code:: bash + + For IDLE-IDLE test, + + host_setup_seqs: + - "host-setup0.sh" + - "reboot" + - "host-setup1.sh" + - "host-run-qemu.sh" + + guest_setup_seqs: + - "guest-setup0.sh" + - "reboot" + - "guest-setup1.sh" + +.. figure:: images/idle-idle-test.png + :name: idle-idle-test + :width: 100% + :align: center + +.. code:: bash + + For [CPU/Memory/IO]Stress-IDLE tests, + + host_setup_seqs: + - "host-setup0.sh" + - "reboot" + - "host-setup1.sh" + - "stress_daily.sh" [cpustress/memory/io] + - "host-run-qemu.sh" + + guest_setup_seqs: + - "guest-setup0.sh" + - "reboot" + - "guest-setup1.sh" + +.. figure:: images/stress-idle-test.png + :name: stress-idle-test + :width: 100% + :align: center + +The following scripts are used for configuring host and guest to create a +special test environment and achieve low latency. + +Note: host-setup0.sh, host-setup1.sh and host-run-qemu.sh are run on the host, +followed by guest-setup0.sh and guest-setup1.sh scripts on the guest VM. + +**host-setup0.sh**: Running this script will install the latest kernel rpm +on host and will make necessary changes as following to create special test +environment. + + * Isolates CPUs from the general scheduler + * Stops timer ticks on isolated CPUs whenever possible + * Stops RCU callbacks on isolated CPUs + * Enables intel iommu driver and disables DMA translation for devices + * Sets HugeTLB pages to 1GB + * Disables machine check + * Disables clocksource verification at runtime + +**host-setup1.sh**: Running this script will make the following test +environment changes. + + * Disabling watchdogs to reduce overhead + * Disabling RT throttling + * Reroute interrupts bound to isolated CPUs to CPU 0 + * Change the iptable so that we can ssh to the guest remotely + +**stress_daily.sh**: Scripts gets triggered only for stress-idle tests. Running this script +make the following environment changes. + + * Triggers stress_script.sh, which runs the stress command with necessary options + * CPU,Memory or IO stress can be applied based on the test type + * Applying stress only on the Host is handled in D-Release + * For Idle-Idle test the stress script is not triggered + * Stress is applied only on the free cores to prevent load on qemu process + + **Note:** + - On Numa Node 1: 22,23 cores are allocated for QEMU process + - 24-43 are used for applying stress + +**host-run-qemu.sh**: Running this script will launch a guest vm on the host. + Note: download guest disk image from artifactory. + +**guest-setup0.sh**: Running this scrcipt on the guest vm will install the +latest build kernel rpm, cyclictest and make the following configuration on +guest vm. + + * Isolates CPUs from the general scheduler + * Stops timer ticks on isolated CPUs whenever possible + * Uses polling idle loop to improve performance + * Disables clocksource verification at runtime + +**guest-setup1.sh**: Running this script on guest vm will do the following +configurations. + + * Disable watchdogs to reduce overhead + * Routes device interrupts to non-RT CPU + * Disables RT throttling + +Hardware configuration +~~~~~~~~~~~~~~~~~~~~~~ + +Currently Intel POD10 is used as test environment for kvm4nfv to execute +cyclictest. As part of this test environment Intel pod10-jump is configured as +jenkins slave and all the latest build artifacts are downloaded on to it. + +* For more information regarding hardware configuration, please visit + https://wiki.opnfv.org/display/pharos/Intel+Pod10 + https://build.opnfv.org/ci/computer/intel-pod10/ + http://artifacts.opnfv.org/octopus/brahmaputra/docs/octopus_docs/opnfv-jenkins-slave-connection.html diff --git a/docs/release/configguide/scenariomatrix.rst b/docs/release/configguide/scenariomatrix.rst new file mode 100644 index 000000000..3da38ed60 --- /dev/null +++ b/docs/release/configguide/scenariomatrix.rst @@ -0,0 +1,129 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. http://creativecommons.org/licenses/by/4.0 + +============== +Scenariomatrix +============== + +Scenarios are implemented as deployable compositions through integration with an installation tool. +OPNFV supports multiple installation tools and for any given release not all tools will support all +scenarios. While our target is to establish parity across the installation tools to ensure they +can provide all scenarios, the practical challenge of achieving that goal for any given feature and +release results in some disparity. + +Danube scenario overeview +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following table provides an overview of the installation tools and available scenario's +in the Danube release of OPNFV. + +Scenario status is indicated by a weather pattern icon. All scenarios listed with +a weather pattern are possible to deploy and run in your environment or a Pharos lab, +however they may have known limitations or issues as indicated by the icon. + +Weather pattern icon legend: + ++---------------------------------------------+----------------------------------------------------------+ +| Weather Icon | Scenario Status | ++=============================================+==========================================================+ +| .. image:: images/weather-clear.jpg | Stable, no known issues | ++---------------------------------------------+----------------------------------------------------------+ +| .. image:: images/weather-few-clouds.jpg | Stable, documented limitations | ++---------------------------------------------+----------------------------------------------------------+ +| .. image:: images/weather-overcast.jpg | Deployable, stability or feature limitations | ++---------------------------------------------+----------------------------------------------------------+ +| .. image:: images/weather-dash.jpg | Not deployed with this installer | ++---------------------------------------------+----------------------------------------------------------+ + +Scenarios that are not yet in a state of "Stable, no known issues" will continue to be stabilised +and updates will be made on the stable/danube branch. While we intend that all Danube +scenarios should be stable it is worth checking regularly to see the current status. Due to +our dependency on upstream communities and code some issues may not be resolved prior to the D release. + +Scenario Naming +^^^^^^^^^^^^^^^ + +In OPNFV scenarios are identified by short scenario names, these names follow a scheme that +identifies the key components and behaviours of the scenario. The rules for scenario naming are as follows: + +.. code:: bash + + os-[controller]-[feature]-[mode]-[option] + +Details of the fields are + + * **[os]:** mandatory + + * Refers to the platform type used + * possible value: os (OpenStack) + + * **[controller]:** mandatory + + * Refers to the SDN controller integrated in the platform + * example values: nosdn, ocl, odl, onos + + * **[feature]:** mandatory + + * Refers to the feature projects supported by the scenario + * example values: nofeature, kvm, ovs, sfc + + * **[mode]:** mandatory + + * Refers to the deployment type, which may include for instance high availability + * possible values: ha, noha + + * **[option]:** optional + + * Used for the scenarios those do not fit into naming scheme. + * The optional field in the short scenario name should not be included if there is no optional scenario. + +Some examples of supported scenario names are: + + * **os-nosdn-kvm-noha** + + * This is an OpenStack based deployment using neutron including the OPNFV enhanced KVM hypervisor + + * **os-onos-nofeature-ha** + + * This is an OpenStack deployment in high availability mode including ONOS as the SDN controller + + * **os-odl_l2-sfc** + + * This is an OpenStack deployment using OpenDaylight and OVS enabled with SFC features + + * **os-nosdn-kvm_nfv_ovs_dpdk-ha** + + * This is an Openstack deployment with high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor + * This deployment has ``3-Contoller and 2-Compute nodes`` + + * **os-nosdn-kvm_nfv_ovs_dpdk-noha** + + * This is an Openstack deployment without high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor + * This deployment has ``1-Contoller and 3-Compute nodes`` + + * **os-nosdn-kvm_nfv_ovs_dpdk_bar-ha** + + * This is an Openstack deployment with high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor + and Barometer + * This deployment has ``3-Contoller and 2-Compute nodes`` + + * **os-nosdn-kvm_nfv_ovs_dpdk_bar-noha** + + * This is an Openstack deployment without high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor + and Barometer + * This deployment has ``1-Contoller and 3-Compute nodes`` + +Installing your scenario +^^^^^^^^^^^^^^^^^^^^^^^^ + +There are two main methods of deploying your target scenario, one method is to follow this guide which will +walk you through the process of deploying to your hardware using scripts or ISO images, the other method is +to set up a Jenkins slave and connect your infrastructure to the OPNFV Jenkins master. + +For the purposes of evaluation and development a number of Danube scenarios are able to be deployed +virtually to mitigate the requirements on physical infrastructure. Details and instructions on performing +virtual deployments can be found in the installer specific installation instructions. + +To set up a Jenkins slave for automated deployment to your lab, refer to the `Jenkins slave connect guide. +`_ diff --git a/docs/release/configurationguide/abstract.rst b/docs/release/configurationguide/abstract.rst deleted file mode 100644 index 3693bcab7..000000000 --- a/docs/release/configurationguide/abstract.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -====================== -Configuration Abstract -====================== - -This document provides guidance for the configurations available in the -Danube release of OPNFV - -The release includes four installer tools leveraging different technologies; -Apex, Compass4nfv, Fuel and JOID, which deploy components of the platform. - -This document also includes the selection of tools and components including -guidelines for how to deploy and configure the platform to an operational -state. diff --git a/docs/release/configurationguide/configuration.options.render.rst b/docs/release/configurationguide/configuration.options.render.rst deleted file mode 100644 index 71a78af2b..000000000 --- a/docs/release/configurationguide/configuration.options.render.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -====================== -Configuration Options -====================== - -OPNFV provides a variety of virtual infrastructure deployments called scenarios -designed to host virtualised network functions (VNF's). KVM4NFV scenarios -provide specific capabilities and/or components aimed to solve specific -problems for the deployment of VNF's. KVM4NFV scenario includes components -such as OpenStack,KVM etc. which includes different source components or -configurations. - -.. note:: - - * Each KVM4NFV `scenario`_ provides unique features and capabilities, it is - important to understand your target platform capabilities before installing - and configuring. This configuration guide outlines how to configure components - in order to enable the features required. - - * More deatils of kvm4nfv scenarios installation and description can be found in the `scenario guide`_ of kvm4nfv docs - -.. _scenario: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description - -.. _scenario guide: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/abstract diff --git a/docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg b/docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg deleted file mode 100644 index 0d2a12279..000000000 Binary files a/docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg and /dev/null differ diff --git a/docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg b/docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg deleted file mode 100644 index 84fc87a76..000000000 Binary files a/docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg and /dev/null differ diff --git a/docs/release/configurationguide/images/idle-idle-test.png b/docs/release/configurationguide/images/idle-idle-test.png deleted file mode 100644 index c9831df1d..000000000 Binary files a/docs/release/configurationguide/images/idle-idle-test.png and /dev/null differ diff --git a/docs/release/configurationguide/images/stress-idle-test.png b/docs/release/configurationguide/images/stress-idle-test.png deleted file mode 100644 index 111c2a7d2..000000000 Binary files a/docs/release/configurationguide/images/stress-idle-test.png and /dev/null differ diff --git a/docs/release/configurationguide/images/weather-clear.jpg b/docs/release/configurationguide/images/weather-clear.jpg deleted file mode 100644 index 011ad52e9..000000000 Binary files a/docs/release/configurationguide/images/weather-clear.jpg and /dev/null differ diff --git a/docs/release/configurationguide/images/weather-dash.jpg b/docs/release/configurationguide/images/weather-dash.jpg deleted file mode 100644 index 3bf98dd27..000000000 Binary files a/docs/release/configurationguide/images/weather-dash.jpg and /dev/null differ diff --git a/docs/release/configurationguide/images/weather-few-clouds.jpg b/docs/release/configurationguide/images/weather-few-clouds.jpg deleted file mode 100644 index 51994ee84..000000000 Binary files a/docs/release/configurationguide/images/weather-few-clouds.jpg and /dev/null differ diff --git a/docs/release/configurationguide/images/weather-overcast.jpg b/docs/release/configurationguide/images/weather-overcast.jpg deleted file mode 100644 index bdc1e0487..000000000 Binary files a/docs/release/configurationguide/images/weather-overcast.jpg and /dev/null differ diff --git a/docs/release/configurationguide/index.rst b/docs/release/configurationguide/index.rst deleted file mode 100644 index fa205f55a..000000000 --- a/docs/release/configurationguide/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. _kvmfornfv-configguide: - -*************************** -Kvm4nfv Configuration Guide -*************************** - -Danube 1.0 ------------- - -.. toctree:: - :maxdepth: 2 - - ./abstract.rst - ./configuration.options.render.rst - ./low-latency.feature.configuration.description.rst - ./os-nosdn-kvm-ha.description.rst diff --git a/docs/release/configurationguide/low-latency.feature.configuration.description.rst b/docs/release/configurationguide/low-latency.feature.configuration.description.rst deleted file mode 100644 index c53aa52f4..000000000 --- a/docs/release/configurationguide/low-latency.feature.configuration.description.rst +++ /dev/null @@ -1,151 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -============================================= -Low Latency Feature Configuration Description -============================================= - -Introduction ------------- -In KVM4NFV project, we focus on the KVM hypervisor to enhance it for NFV, by -looking at the following areas initially - -* 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 - -Configuration of Cyclictest ---------------------------- - -Cyclictest measures Latency of response to a stimulus. Achieving low latency -with the KVM4NFV project requires setting up a special test environment. -This environment includes the BIOS settings, kernel configuration, kernel -parameters and the run-time environment. - -* For more information regarding the test environment, please visit - https://wiki.opnfv.org/display/kvm/KVM4NFV+Test++Environment - https://wiki.opnfv.org/display/kvm/Nfv-kvm-tuning - -Pre-configuration activities -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Intel POD10 is currently used as OPNFV-KVM4NFV test environment. The rpm -packages from the latest build are downloaded onto Intel-Pod10 jump server -from artifact repository. Yardstick running in a ubuntu docker container -on Intel Pod10-jump server will configure the host(intel pod10 node1/node2 -based on job type), the guest and triggers the cyclictest on the guest using -below sample yaml file. - - -.. code:: bash - - For IDLE-IDLE test, - - host_setup_seqs: - - "host-setup0.sh" - - "reboot" - - "host-setup1.sh" - - "host-run-qemu.sh" - - guest_setup_seqs: - - "guest-setup0.sh" - - "reboot" - - "guest-setup1.sh" - -.. figure:: images/idle-idle-test.png - :name: idle-idle-test - :width: 100% - :align: center - -.. code:: bash - - For [CPU/Memory/IO]Stress-IDLE tests, - - host_setup_seqs: - - "host-setup0.sh" - - "reboot" - - "host-setup1.sh" - - "stress_daily.sh" [cpustress/memory/io] - - "host-run-qemu.sh" - - guest_setup_seqs: - - "guest-setup0.sh" - - "reboot" - - "guest-setup1.sh" - -.. figure:: images/stress-idle-test.png - :name: stress-idle-test - :width: 100% - :align: center - -The following scripts are used for configuring host and guest to create a -special test environment and achieve low latency. - -Note: host-setup0.sh, host-setup1.sh and host-run-qemu.sh are run on the host, -followed by guest-setup0.sh and guest-setup1.sh scripts on the guest VM. - -**host-setup0.sh**: Running this script will install the latest kernel rpm -on host and will make necessary changes as following to create special test -environment. - - * Isolates CPUs from the general scheduler - * Stops timer ticks on isolated CPUs whenever possible - * Stops RCU callbacks on isolated CPUs - * Enables intel iommu driver and disables DMA translation for devices - * Sets HugeTLB pages to 1GB - * Disables machine check - * Disables clocksource verification at runtime - -**host-setup1.sh**: Running this script will make the following test -environment changes. - - * Disabling watchdogs to reduce overhead - * Disabling RT throttling - * Reroute interrupts bound to isolated CPUs to CPU 0 - * Change the iptable so that we can ssh to the guest remotely - -**stress_daily.sh**: Scripts gets triggered only for stress-idle tests. Running this script -make the following environment changes. - - * Triggers stress_script.sh, which runs the stress command with necessary options - * CPU,Memory or IO stress can be applied based on the test type - * Applying stress only on the Host is handled in D-Release - * For Idle-Idle test the stress script is not triggered - * Stress is applied only on the free cores to prevent load on qemu process - - **Note:** - - On Numa Node 1: 22,23 cores are allocated for QEMU process - - 24-43 are used for applying stress - -**host-run-qemu.sh**: Running this script will launch a guest vm on the host. - Note: download guest disk image from artifactory. - -**guest-setup0.sh**: Running this scrcipt on the guest vm will install the -latest build kernel rpm, cyclictest and make the following configuration on -guest vm. - - * Isolates CPUs from the general scheduler - * Stops timer ticks on isolated CPUs whenever possible - * Uses polling idle loop to improve performance - * Disables clocksource verification at runtime - -**guest-setup1.sh**: Running this script on guest vm will do the following -configurations. - - * Disable watchdogs to reduce overhead - * Routes device interrupts to non-RT CPU - * Disables RT throttling - -Hardware configuration -~~~~~~~~~~~~~~~~~~~~~~ - -Currently Intel POD10 is used as test environment for kvm4nfv to execute -cyclictest. As part of this test environment Intel pod10-jump is configured as -jenkins slave and all the latest build artifacts are downloaded on to it. - -* For more information regarding hardware configuration, please visit - https://wiki.opnfv.org/display/pharos/Intel+Pod10 - https://build.opnfv.org/ci/computer/intel-pod10/ - http://artifacts.opnfv.org/octopus/brahmaputra/docs/octopus_docs/opnfv-jenkins-slave-connection.html diff --git a/docs/release/configurationguide/scenariomatrix.rst b/docs/release/configurationguide/scenariomatrix.rst deleted file mode 100644 index 3da38ed60..000000000 --- a/docs/release/configurationguide/scenariomatrix.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. http://creativecommons.org/licenses/by/4.0 - -============== -Scenariomatrix -============== - -Scenarios are implemented as deployable compositions through integration with an installation tool. -OPNFV supports multiple installation tools and for any given release not all tools will support all -scenarios. While our target is to establish parity across the installation tools to ensure they -can provide all scenarios, the practical challenge of achieving that goal for any given feature and -release results in some disparity. - -Danube scenario overeview -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The following table provides an overview of the installation tools and available scenario's -in the Danube release of OPNFV. - -Scenario status is indicated by a weather pattern icon. All scenarios listed with -a weather pattern are possible to deploy and run in your environment or a Pharos lab, -however they may have known limitations or issues as indicated by the icon. - -Weather pattern icon legend: - -+---------------------------------------------+----------------------------------------------------------+ -| Weather Icon | Scenario Status | -+=============================================+==========================================================+ -| .. image:: images/weather-clear.jpg | Stable, no known issues | -+---------------------------------------------+----------------------------------------------------------+ -| .. image:: images/weather-few-clouds.jpg | Stable, documented limitations | -+---------------------------------------------+----------------------------------------------------------+ -| .. image:: images/weather-overcast.jpg | Deployable, stability or feature limitations | -+---------------------------------------------+----------------------------------------------------------+ -| .. image:: images/weather-dash.jpg | Not deployed with this installer | -+---------------------------------------------+----------------------------------------------------------+ - -Scenarios that are not yet in a state of "Stable, no known issues" will continue to be stabilised -and updates will be made on the stable/danube branch. While we intend that all Danube -scenarios should be stable it is worth checking regularly to see the current status. Due to -our dependency on upstream communities and code some issues may not be resolved prior to the D release. - -Scenario Naming -^^^^^^^^^^^^^^^ - -In OPNFV scenarios are identified by short scenario names, these names follow a scheme that -identifies the key components and behaviours of the scenario. The rules for scenario naming are as follows: - -.. code:: bash - - os-[controller]-[feature]-[mode]-[option] - -Details of the fields are - - * **[os]:** mandatory - - * Refers to the platform type used - * possible value: os (OpenStack) - - * **[controller]:** mandatory - - * Refers to the SDN controller integrated in the platform - * example values: nosdn, ocl, odl, onos - - * **[feature]:** mandatory - - * Refers to the feature projects supported by the scenario - * example values: nofeature, kvm, ovs, sfc - - * **[mode]:** mandatory - - * Refers to the deployment type, which may include for instance high availability - * possible values: ha, noha - - * **[option]:** optional - - * Used for the scenarios those do not fit into naming scheme. - * The optional field in the short scenario name should not be included if there is no optional scenario. - -Some examples of supported scenario names are: - - * **os-nosdn-kvm-noha** - - * This is an OpenStack based deployment using neutron including the OPNFV enhanced KVM hypervisor - - * **os-onos-nofeature-ha** - - * This is an OpenStack deployment in high availability mode including ONOS as the SDN controller - - * **os-odl_l2-sfc** - - * This is an OpenStack deployment using OpenDaylight and OVS enabled with SFC features - - * **os-nosdn-kvm_nfv_ovs_dpdk-ha** - - * This is an Openstack deployment with high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor - * This deployment has ``3-Contoller and 2-Compute nodes`` - - * **os-nosdn-kvm_nfv_ovs_dpdk-noha** - - * This is an Openstack deployment without high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor - * This deployment has ``1-Contoller and 3-Compute nodes`` - - * **os-nosdn-kvm_nfv_ovs_dpdk_bar-ha** - - * This is an Openstack deployment with high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor - and Barometer - * This deployment has ``3-Contoller and 2-Compute nodes`` - - * **os-nosdn-kvm_nfv_ovs_dpdk_bar-noha** - - * This is an Openstack deployment without high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor - and Barometer - * This deployment has ``1-Contoller and 3-Compute nodes`` - -Installing your scenario -^^^^^^^^^^^^^^^^^^^^^^^^ - -There are two main methods of deploying your target scenario, one method is to follow this guide which will -walk you through the process of deploying to your hardware using scripts or ISO images, the other method is -to set up a Jenkins slave and connect your infrastructure to the OPNFV Jenkins master. - -For the purposes of evaluation and development a number of Danube scenarios are able to be deployed -virtually to mitigate the requirements on physical infrastructure. Details and instructions on performing -virtual deployments can be found in the installer specific installation instructions. - -To set up a Jenkins slave for automated deployment to your lab, refer to the `Jenkins slave connect guide. -`_ diff --git a/docs/release/glossary/kvmfornfv_glossary.rst b/docs/release/glossary/kvmfornfv_glossary.rst deleted file mode 100644 index aed5a971e..000000000 --- a/docs/release/glossary/kvmfornfv_glossary.rst +++ /dev/null @@ -1,401 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. http://creativecommons.org/licenses/by/4.0 - -************** -OPNFV Glossary -************** - -Danube 1.0 ------------- - - -Contents --------- - -This glossary provides a common definition of phrases and words commonly used -in OPNFV. - --------- - -A -~ - -Arno - - A river running through Tuscany and the name of the first OPNFV release. - -API - - Application Programming Interface - -AVX2 - - Advanced Vector Extensions 2 is an instruction set extension for x86. - - --------- - -B -~ - -Brahmaputra - - A river running through Asia and the name of the Second OPNFV release. - -Bios - - Basic Input/Output System - -Builds - - Build in Jenkins is a version of a program. - -Bogomips - - Bogomips is the number of million times per second a processor can do - absolutely nothing. - --------- - -C -~ - -CAT - - Cache Automation Technology - -CentOS - - Community Enterprise Operating System is a Linux distribution - -CICD - - Continuous Integration and Continuous Deployment - -CLI - - Command Line Interface - -Colorado - - A river in Argentina and the name of the Third OPNFV release. - -Compute - - Compute is an OpenStack service which offers many configuration options - which may be deployment specific. - -Console - - Console is display screen. - -CPU - Central Processing Unit - --------- - -D -~ - -Danube - - Danube is the fourth release of OPNFV and also a river in Europe - -Data plane - - The data plane is the part of a network that carries user traffic. - -Debian/deb - - Debian is a Unix-like computer operating system that is composed entirely of - free software. - -Docs - - Documentation/documents - -DPDK - - Data Plane Development Kit - -DPI - - Deep Packet Inspection - -DSCP - - Differentiated Services Code Point - --------- - -F -~ - -Flavors - - Flavors are templates used to define VM configurations. - -Fuel - - Provides an intuitive, GUI-driven experience for deployment and management of OpenStack - --------- - -H -~ - -Horizon - - Horizon is an OpenStack service which serves as an UI. - -Hypervisor - - A hypervisor, also called a virtual machine manager, is a program that allows - multiple operating systems to share a single hardware host. - --------- - -I -~ - -IGMP - - Internet Group Management Protocol - -IOMMU - - Input-Output Memory Management Unit - -IOPS - - Input/Output Operations Per Second - -IRQ - - Interrupt ReQuest is an interrupt request sent from the hardware level to - the CPU. - -IRQ affinity - - IRQ affinity is the set of CPU cores that can service that interrupt. - --------- - -J -~ - -Jenkins - - Jenkins is an open source continuous integration tool written in Java. - -JIRA - - JIRA is a bug tracking software. - -Jitter - - Time difference in packet inter-arrival time to their destination can be called jitter. - -JumpHost - - A jump host or jump server or jumpbox is a computer on a network typically - used to manage devices in a separate security zone. - --------- - -K -~ - -Kernel - - The kernel is a computer program that constitutes the central core of a - computer's operating system. - --------- - -L -~ - -Latency - - The amount of time it takes a packet to travel from source to destination is - Latency. - -libvirt - - libvirt is an open source API, daemon and management tool for managing - platform virtualization. - --------- - -M -~ - -Migration - - Migration is the process of moving from the use of one operating environment - to another operating environment. - --------- - -N -~ - -NFV - - Network Functions Virtualisation, an industry initiative to leverage - virtualisation technologies in carrier networks. - -NFVI - - Network Function Virtualization Infrastructure - -NIC - - Network Interface Controller - -NUMA - - Non-Uniform Memory Access - --------- - -O -~ - -OPNFV - - Open Platform for NFV, an open source project developing an NFV reference - platform and features. - --------- - -P -~ - -Pharos - - Is a lighthouse and is a project deals with developing an OPNFV lab - infrastructure that is geographically and technically diverse. - -Pipeline - - A suite of plugins in Jenkins that lets you orchestrate automation. - -Platform - - OPNFV provides an open source platform for deploying NFV solutions that - leverages investments from a community of developers and solution providers. - -Pools - - A Pool is a set of resources that are kept ready to use, rather than acquired - on use and released afterwards. - --------- - -Q -~ - -Qemu - - QEMU is a free and open-source hosted hypervisor that performs hardware - virtualization. - --------- - -R -~ - -RDMA - - Remote Direct Memory Access (RDMA) - -Rest-Api - - REST (REpresentational State Transfer) is an architectural style, and an - approach to communications that is often used in the development of web - services - --------- - -S -~ - -Scaling - - Refers to altering the size. - -Slave - - Works with/for master.where master has unidirectional control over one or - more other devices. - -SR-IOV - - Single root IO- Virtualization. - -Spin locks - - A spinlock is a lock which causes a thread trying to acquire it to simply - wait in a loop while repeatedly checking if the lock is available. - -Storage - - Refers to computer components which store some data. - --------- - -T -~ - -Tenant - - A Tenant is a group of users who share a common access with specific - privileges to the software instance. - -Tickless - - A tickless kernel is an operating system kernel in which timer interrupts - do not occur at regular intervals, but are only delivered as required. - -TSC - - Technical Steering Committee - --------- - -V -~ - -VLAN - - A virtual local area network, typically an isolated ethernet network. - -VM - - Virtual machine, an emulation in software of a computer system. - -VNF - - Virtual network function, typically a networking application or function - running in a virtual environment. - --------- - -X -~ - -XBZRLE - - Helps to reduce the network traffic by just sending the updated data - --------- - -Y -~ - -Yardstick - - Yardstick is an infrastructure verification. It is an OPNFV testing project. diff --git a/docs/release/installation/abstract.rst b/docs/release/installation/abstract.rst new file mode 100644 index 000000000..a53450eff --- /dev/null +++ b/docs/release/installation/abstract.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. http://creativecommons.org/licenses/by/4.0 + +******** +Abstract +******** + +This document will give the instructions to user on how to deploy available +KVM4NFV build scenario verfied for the Danube release of the OPNFV +platform. diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst new file mode 100644 index 000000000..87afea1f2 --- /dev/null +++ b/docs/release/installation/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. http://creativecommons.org/licenses/by/4.0 + +.. _kvmfornfv-installation: + +******************************** +KVM4NFV Installation instruction +******************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + ./abstract.rst + ./kvm4nfv-cicd.installation.instruction.rst + ./kvm4nfv-cicd.release.notes.rst diff --git a/docs/release/installation/kvm4nfv-cicd.installation.instruction.rst b/docs/release/installation/kvm4nfv-cicd.installation.instruction.rst new file mode 100644 index 000000000..dedcca34f --- /dev/null +++ b/docs/release/installation/kvm4nfv-cicd.installation.instruction.rst @@ -0,0 +1,107 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. http://creativecommons.org/licenses/by/4.0 + +================================ +KVM4NFV Installation Instruction +================================ + +Preparing the installation +-------------------------- + +The OPNFV project- KVM4NFV (https://gerrit.opnfv.org/gerrit/kvmfornfv.git) is +cloned first, to make the build scripts for Qemu & Kernel, Rpms and Debians +available. + +HW requirements +--------------- + +These build scripts are triggered on the Jenkins-Slave build server. Currently +Intel POD10 is used as test environment for kvm4nfv to execute cyclictest. As +part of this test environment Intel pod10-jump is configured as jenkins slave +and all the latest build artifacts are downloaded on to it. Intel pod10-node1 +is the host on which a guest vm will be launched as a part of running cylictest +through yardstick. + +Build instructions +------------------ + +Builds are possible for the following packages- + +**kvmfornfv source code** + +The ./ci/build.sh is the main script used to trigger +the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case. + +* How to build Kernel/Qemu Rpms- To build rpm packages, build.sh script is run + with -p and -o option (i.e. if -p package option is passed as "centos" or in + default case). Example: + +.. code:: bash + + cd kvmfornfv/ + + For Kernel/Qemu RPMs, + sh ./ci/build.sh -p centos -o build_output + +* How to build Kernel/Qemu Debians- To build debian packages, build.sh script + is run with -p and -o option (i.e. if -p package option is passed as + "ubuntu"). Example: + +.. code:: bash + + cd kvmfornfv/ + + For Kernel/Qemu Debians, + sh ./ci/build.sh -p ubuntu -o build_output + + +* How to build all Kernel & Qemu, Rpms & Debians- To build both debian and rpm + packages, build.sh script is run with -p and -o option (i.e. if -p package + option is passed as "both"). Example: + +.. code:: bash + + cd kvmfornfv/ + + For Kernel/Qemu RPMs and Debians, + sh ./ci/build.sh -p both -o build_output + +.. note:: Kvm4nfv can be installed in two ways + + 1. As part of a `scenario deployment`_ + 2. As a `stand alone`_ component + +.. _scenario deployment: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description +.. _stand alone: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#build-instructions + +For installation of kvmfornfv as part of scenario deployment use this `link`_ + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description + + +Installation instructions +------------------------- + +Installation can be done in the following ways- + +**1. From kvmfornfv source code**- +The build packages that are prepared in the above section, are installed +differently depending on the platform. + +Please visit the links for each- + +* Centos : https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-rpm-using.html +* Ubuntu : https://help.ubuntu.com/community/InstallingSoftware + +**2. Using Fuel installer**- + +* Please refer to the document present at /fuel-plugin/README.md + +Post-installation activities +---------------------------- + +After the packages are built, test these packages by executing the scripts +present in ci/envs for configuring the host and guest respectively. diff --git a/docs/release/installation/kvm4nfv-cicd.release.notes.rst b/docs/release/installation/kvm4nfv-cicd.release.notes.rst new file mode 100644 index 000000000..415182bc7 --- /dev/null +++ b/docs/release/installation/kvm4nfv-cicd.release.notes.rst @@ -0,0 +1,103 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. http://creativecommons.org/licenses/by/4.0 + +============================= +Release Note for KVM4NFV CICD +============================= + + +Abstract +-------- + +This document contains the release notes for the Danube release of OPNFV when using KVM4NFV CICD process. + +Introduction +------------ + +Provide a brief introduction of how this configuration is used in OPNFV release +using KVM4VFV CICD as scenario. + +Be sure to reference your scenario installation instruction. + +Release Data +------------ + ++--------------------------------------+--------------------------------------+ +| **Project** | NFV Hypervisors-KVM | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | kvmfornfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2017-03-27 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | - Automate the KVM4VFV CICD scenario | +| | - Executing latency test cases | +| | - Collection of logs for debugging | +| | | ++--------------------------------------+--------------------------------------+ + + +Document version change +----------------------- + +The following documents are added- + - configurationguide + - installationprocedure + - userguide + - overview + - glossary + - releasenotes + +Reason for new version +---------------------- + +Feature additions +~~~~~~~~~~~~~~~~~ + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-34 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-57 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-58 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-59 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-60 | +| | | ++--------------------------------------+--------------------------------------+ + +Known issues +------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-75 | ++--------------------------------------+--------------------------------------+ + +Workarounds +----------- +See JIRA: https://jira.opnfv.org/projects + + +References +========== +For more information on the OPNFV Danube release, please visit +http://www.opnfv.org/danube diff --git a/docs/release/installationprocedure/abstract.rst b/docs/release/installationprocedure/abstract.rst deleted file mode 100644 index a53450eff..000000000 --- a/docs/release/installationprocedure/abstract.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. http://creativecommons.org/licenses/by/4.0 - -******** -Abstract -******** - -This document will give the instructions to user on how to deploy available -KVM4NFV build scenario verfied for the Danube release of the OPNFV -platform. diff --git a/docs/release/installationprocedure/index.rst b/docs/release/installationprocedure/index.rst deleted file mode 100644 index 9d75307f4..000000000 --- a/docs/release/installationprocedure/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. http://creativecommons.org/licenses/by/4.0 - -.. _kvmfornfv-installation: - -******************************** -KVM4NFV Installation instruction -******************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - abstract.rst - kvm4nfv-cicd.installation.instruction.rst diff --git a/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst b/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst deleted file mode 100644 index dedcca34f..000000000 --- a/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. http://creativecommons.org/licenses/by/4.0 - -================================ -KVM4NFV Installation Instruction -================================ - -Preparing the installation --------------------------- - -The OPNFV project- KVM4NFV (https://gerrit.opnfv.org/gerrit/kvmfornfv.git) is -cloned first, to make the build scripts for Qemu & Kernel, Rpms and Debians -available. - -HW requirements ---------------- - -These build scripts are triggered on the Jenkins-Slave build server. Currently -Intel POD10 is used as test environment for kvm4nfv to execute cyclictest. As -part of this test environment Intel pod10-jump is configured as jenkins slave -and all the latest build artifacts are downloaded on to it. Intel pod10-node1 -is the host on which a guest vm will be launched as a part of running cylictest -through yardstick. - -Build instructions ------------------- - -Builds are possible for the following packages- - -**kvmfornfv source code** - -The ./ci/build.sh is the main script used to trigger -the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case. - -* How to build Kernel/Qemu Rpms- To build rpm packages, build.sh script is run - with -p and -o option (i.e. if -p package option is passed as "centos" or in - default case). Example: - -.. code:: bash - - cd kvmfornfv/ - - For Kernel/Qemu RPMs, - sh ./ci/build.sh -p centos -o build_output - -* How to build Kernel/Qemu Debians- To build debian packages, build.sh script - is run with -p and -o option (i.e. if -p package option is passed as - "ubuntu"). Example: - -.. code:: bash - - cd kvmfornfv/ - - For Kernel/Qemu Debians, - sh ./ci/build.sh -p ubuntu -o build_output - - -* How to build all Kernel & Qemu, Rpms & Debians- To build both debian and rpm - packages, build.sh script is run with -p and -o option (i.e. if -p package - option is passed as "both"). Example: - -.. code:: bash - - cd kvmfornfv/ - - For Kernel/Qemu RPMs and Debians, - sh ./ci/build.sh -p both -o build_output - -.. note:: Kvm4nfv can be installed in two ways - - 1. As part of a `scenario deployment`_ - 2. As a `stand alone`_ component - -.. _scenario deployment: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description -.. _stand alone: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#build-instructions - -For installation of kvmfornfv as part of scenario deployment use this `link`_ - -.. code:: bash - - http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description - - -Installation instructions -------------------------- - -Installation can be done in the following ways- - -**1. From kvmfornfv source code**- -The build packages that are prepared in the above section, are installed -differently depending on the platform. - -Please visit the links for each- - -* Centos : https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-rpm-using.html -* Ubuntu : https://help.ubuntu.com/community/InstallingSoftware - -**2. Using Fuel installer**- - -* Please refer to the document present at /fuel-plugin/README.md - -Post-installation activities ----------------------------- - -After the packages are built, test these packages by executing the scripts -present in ci/envs for configuring the host and guest respectively. diff --git a/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst b/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst deleted file mode 100644 index 415182bc7..000000000 --- a/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst +++ /dev/null @@ -1,103 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. http://creativecommons.org/licenses/by/4.0 - -============================= -Release Note for KVM4NFV CICD -============================= - - -Abstract --------- - -This document contains the release notes for the Danube release of OPNFV when using KVM4NFV CICD process. - -Introduction ------------- - -Provide a brief introduction of how this configuration is used in OPNFV release -using KVM4VFV CICD as scenario. - -Be sure to reference your scenario installation instruction. - -Release Data ------------- - -+--------------------------------------+--------------------------------------+ -| **Project** | NFV Hypervisors-KVM | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | kvmfornfv | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | 2017-03-27 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | - Automate the KVM4VFV CICD scenario | -| | - Executing latency test cases | -| | - Collection of logs for debugging | -| | | -+--------------------------------------+--------------------------------------+ - - -Document version change ------------------------ - -The following documents are added- - - configurationguide - - installationprocedure - - userguide - - overview - - glossary - - releasenotes - -Reason for new version ----------------------- - -Feature additions -~~~~~~~~~~~~~~~~~ - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-34 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-57 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-58 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-59 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-60 | -| | | -+--------------------------------------+--------------------------------------+ - -Known issues ------------- - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-75 | -+--------------------------------------+--------------------------------------+ - -Workarounds ------------ -See JIRA: https://jira.opnfv.org/projects - - -References -========== -For more information on the OPNFV Danube release, please visit -http://www.opnfv.org/danube diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 000000000..3cf19f32f --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _kvmfornfv-releasenotes: + +======================================== +KVM4NFV Release Notes for Danube Release +======================================== + +.. toctree:: + :maxdepth: 2 + + release-notes diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 000000000..e08341ffb --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,278 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _Kvmfornfv: https://wiki.opnfv.org/display/kvm/ + +============= +Release Notes +============= + +Abstract +--------- + +This document provides the release notes for Danube 1.0 release of KVM4NFV. + + +**Contents** + + **1 Version History** + + **2 Important notes** + + **3 Summary** + + **4 Delivery Data** + + **5 References** + +Version history +--------------- + ++--------------------+--------------------+--------------------+----------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+----------------------+ +|2016-08-22 | 0.1.0 | | Colorado 1.0 release | +| | | | | ++--------------------+--------------------+--------------------+----------------------+ +|2017-03-27 | 0.1.0 | | Danube 1.0 release | +| | | | | ++--------------------+--------------------+--------------------+----------------------+ + +Important notes +--------------- + +The KVM4NFV project is currently supported on the Fuel installer. + +Summary +------- + +This Danube 1.0 release provides *KVM4NFV* as a framework to enhance the +KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV +CI pipeline, including: + +* KVMFORNFV source code + +* Automation of building the Kernel and qemu for RPM and debian packages + +* Cyclictests execution to check the latency + +* “os-nosdn-kvm-ha”,“os-nosdn-kvm_nfv_ovs_dpdk-ha”,“os-nosdn-kvm_nfv_ovs_dpdk-noha”,“os-nosdn-kvm_nfv_ovs_dpdk_bar-ha”, + “os-nosdn-kvm_nfv_ovs_dpdk_bar-noha” Scenarios testing for ``high availability/no-high avaliability`` + configuration using Fuel installer + +* Documentation created for, + + * User Guide + + * Configuration Guide + + * Installation Procedure + + * Release notes + + * Scenarios Guide + + * Design Guide + + * Requirements Guide + + +Release Data +------------ + ++--------------------------------------+--------------------------------------+ +| **Project** | NFV Hypervisors-KVM | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | kvmfornfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2017-03-27 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | OPNFV Danube 1.0 Releases | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +-------------- + +1 Module version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This is the Danube 1.0 main release. It is based on following upstream +versions: + +* RT Kernel 4.4.50-rt62 + +* QEMU 2.6 + +* Fuel plugin based on Fuel 10.0 + +This is the second tracked release of KVM4NFV + + +2 Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is the second version of the KVM4NFV framework in OPNFV. + +Reason for version +------------------ + +1 Feature additions +~~~~~~~~~~~~~~~~~~~ + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-57 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-58 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-59 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-61 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-62 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-63 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-64 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-65 | +| | | ++--------------------------------------+--------------------------------------+ + +A brief ``Description of the the JIRA tickets``: + ++---------------------------------------+-------------------------------------------------------------+ +| **JIRA REFERENCE** | **DESCRIPTION** | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-57 | CI/CD Integration into Yardstick | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-58 | Complete the integration of test plan into Yardstick | +| | and Jenkins infrastructure to include latency testing | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-59 | Enable capability to publish results on Yardstick Dashboard | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-61 | Define and integrate additional scenario - KVM+OVS+DPDK | +| | with HA and NOHA for baremetal and virtual environments | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-62 | Define and integrate additional scenario - KVM+OVS+DPDK+BAR | +| | with HA and NOHA for bare metal and virtual environments | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-63 | Setup Local fuel environment | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-64 | Fuel environment setup for local machine to debug Fuel | +| | related integration issues | ++---------------------------------------+-------------------------------------------------------------+ + +Deliverables +------------ + +1 Software deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~ +* Danube 1.0 release of the KVM4NFV RPM and debian for kvm4nfv + +* Added the following scenarios as part of D-Release: + + * os-nosdn-kvm_nfv_ovs_dpdk-noha + + * os-nosdn-kvm_nfv_ovs_dpdk_bar-noha + + * os-nosdn-kvm_nfv_ovs_dpdk-ha + + * os-nosdn-kvm_nfv_ovs_dpdk_bar-ha + +* Configured influxdb and `Graphana_dashboard`_ for publishing kvm4nfv test results + +.. _Graphana_dashboard: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest + +* Cyclictest test case is successfully implemented, it has the below test types., + + * idle-idle + + * CPUstress-idle + + * IOstress-idle + + * Memorystress-idle + +* Implemented Noisy Neighbour feature ., cyclictest under stress testing is implemented + +* Packet forwarding test case is implemented and it supports the following test types currently, + + * Packet forwarding to Host + + * Packet forwarding to Guest + + * Packet forwarding to Guest using SRIOV + +* Ftrace debugging tool is supported in D-Release. The logs collected by ftrace are stored in artifacts for future needs + +* PCM Utility is part of D-Release. The future scope may include collection of read/write data and publishing in grafana + +* Either Apex or Fuel can be used for deployment of os-nosdn-kvm-ha scenario + ++------------------------------------------+------------------+-----------------+ +| **Scenario Name** | **Apex** | **Fuel** | +| | | | ++==========================================+==================+=================+ +| - os-nosdn-kvm-ha | ``Y`` | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk-noha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk-ha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk_bar-noha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk_bar-ha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ + +* Future scope may include adding Apex support for all the remaining scenarios + +* The below documents are delivered for Danube KVM4NFV Release: + + * User Guide + + * Configuration Guide + + * Installation Procedure + + * Overview + + * Release notes + + * Glossary + + * Scenarios + + * Requirements Guide + + * Overview Guide + +References +---------- + +For more information on the KVM4NFV Danube release, please see: + +https://wiki.opnfv.org/display/kvm/ diff --git a/docs/release/releasenotes/index.rst b/docs/release/releasenotes/index.rst deleted file mode 100644 index 3cf19f32f..000000000 --- a/docs/release/releasenotes/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. _kvmfornfv-releasenotes: - -======================================== -KVM4NFV Release Notes for Danube Release -======================================== - -.. toctree:: - :maxdepth: 2 - - release-notes diff --git a/docs/release/releasenotes/release-notes.rst b/docs/release/releasenotes/release-notes.rst deleted file mode 100644 index c52b4b839..000000000 --- a/docs/release/releasenotes/release-notes.rst +++ /dev/null @@ -1,280 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. _Kvmfornfv: https://wiki.opnfv.org/display/kvm/ - -============= -Release Notes -============= - -Abstract ---------- - -This document provides the release notes for Danube 1.0 release of KVM4NFV. - - -**Contents** - - **1 Version History** - - **2 Important notes** - - **3 Summary** - - **4 Delivery Data** - - **5 References** - -Version history ---------------- - -+--------------------+--------------------+--------------------+----------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+----------------------+ -|2016-08-22 | 0.1.0 | | Colorado 1.0 release | -| | | | | -+--------------------+--------------------+--------------------+----------------------+ -|2017-03-27 | 0.1.0 | | Danube 1.0 release | -| | | | | -+--------------------+--------------------+--------------------+----------------------+ - -Important notes ---------------- - -The KVM4NFV project is currently supported on the Fuel installer. - -Summary -------- - -This Danube 1.0 release provides *KVM4NFV* as a framework to enhance the -KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV -CI pipeline, including: - -* KVMFORNFV source code - -* Automation of building the Kernel and qemu for RPM and debian packages - -* Cyclictests execution to check the latency - -* “os-nosdn-kvm-ha”,“os-nosdn-kvm_nfv_ovs_dpdk-ha”,“os-nosdn-kvm_nfv_ovs_dpdk-noha”,“os-nosdn-kvm_nfv_ovs_dpdk_bar-ha”, - “os-nosdn-kvm_nfv_ovs_dpdk_bar-noha” Scenarios testing for ``high availability/no-high avaliability`` - configuration using Fuel installer - -* Documentation created for, - - * User Guide - - * Configuration Guide - - * Installation Procedure - - * Release notes - - * Scenarios Guide - - * Design Guide - - * Requirements Guide - -The *KVM4NFV framework* is developed in the OPNFV community, by the -KVM4NFV_ team. - -Release Data ------------- - -+--------------------------------------+--------------------------------------+ -| **Project** | NFV Hypervisors-KVM | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/commit-ID** | kvmfornfv | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Danube | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | 2017-03-27 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Danube 1.0 Releases | -| | | -+--------------------------------------+--------------------------------------+ - -Version change --------------- - -1 Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This is the Danube 1.0 main release. It is based on following upstream -versions: - -* RT Kernel 4.4.50-rt62 - -* QEMU 2.6 - -* Fuel plugin based on Fuel 10.0 - -This is the second tracked release of KVM4NFV - - -2 Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the second version of the KVM4NFV framework in OPNFV. - -Reason for version ------------------- - -1 Feature additions -~~~~~~~~~~~~~~~~~~~ - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-57 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-58 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-59 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-61 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-62 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-63 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-64 | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMFORNFV-65 | -| | | -+--------------------------------------+--------------------------------------+ - -A brief ``Description of the the JIRA tickets``: - -+---------------------------------------+-------------------------------------------------------------+ -| **JIRA REFERENCE** | **DESCRIPTION** | -| | | -+---------------------------------------+-------------------------------------------------------------+ -| KVMFORNFV-57 | CI/CD Integration into Yardstick | -| | | -+---------------------------------------+-------------------------------------------------------------+ -| KVMFORNFV-58 | Complete the integration of test plan into Yardstick | -| | and Jenkins infrastructure to include latency testing | -| | | -+---------------------------------------+-------------------------------------------------------------+ -| KVMFORNFV-59 | Enable capability to publish results on Yardstick Dashboard | -| | | -+---------------------------------------+-------------------------------------------------------------+ -| KVMFORNFV-61 | Define and integrate additional scenario - KVM+OVS+DPDK | -| | with HA and NOHA for baremetal and virtual environments | -| | | -+---------------------------------------+-------------------------------------------------------------+ -| KVMFORNFV-62 | Define and integrate additional scenario - KVM+OVS+DPDK+BAR | -| | with HA and NOHA for bare metal and virtual environments | -| | | -+---------------------------------------+-------------------------------------------------------------+ -| KVMFORNFV-63 | Setup Local fuel environment | -| | | -+---------------------------------------+-------------------------------------------------------------+ -| KVMFORNFV-64 | Fuel environment setup for local machine to debug Fuel | -| | related integration issues | -+---------------------------------------+-------------------------------------------------------------+ - -Deliverables ------------- - -1 Software deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~ -* Danube 1.0 release of the KVM4NFV RPM and debian for kvm4nfv - -* Added the following scenarios as part of D-Release: - - * os-nosdn-kvm_nfv_ovs_dpdk-noha - - * os-nosdn-kvm_nfv_ovs_dpdk_bar-noha - - * os-nosdn-kvm_nfv_ovs_dpdk-ha - - * os-nosdn-kvm_nfv_ovs_dpdk_bar-ha - -* Configured influxdb and `Graphana dashboard`_ for publishing kvm4nfv test results - -.. _Graphana_dashboard: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest - -* Cyclictest test case is successfully implemented, it has the below test types., - - * idle-idle - - * CPUstress-idle - - * IOstress-idle - - * Memorystress-idle - -* Implemented Noisy Neighbour feature ., cyclictest under stress testing is implemented - -* Packet forwarding test case is implemented and it supports the following test types currently, - - * Packet forwarding to Host - - * Packet forwarding to Guest - - * Packet forwarding to Guest using SRIOV - -* Ftrace debugging tool is supported in D-Release. The logs collected by ftrace are stored in artifacts for future needs - -* PCM Utility is part of D-Release. The future scope may include collection of read/write data and publishing in grafana - -* Either Apex or Fuel can be used for deployment of os-nosdn-kvm-ha scenario - -+------------------------------------------+------------------+-----------------+ -| **Scenario Name** | **Apex** | **Fuel** | -| | | | -+==========================================+==================+=================+ -| - os-nosdn-kvm-ha | ``Y`` | ``Y`` | -+------------------------------------------+------------------+-----------------+ -| - os-nosdn-kvm_nfv_ovs_dpdk-noha | | ``Y`` | -+------------------------------------------+------------------+-----------------+ -| - os-nosdn-kvm_nfv_ovs_dpdk-ha | | ``Y`` | -+------------------------------------------+------------------+-----------------+ -| - os-nosdn-kvm_nfv_ovs_dpdk_bar-noha | | ``Y`` | -+------------------------------------------+------------------+-----------------+ -| - os-nosdn-kvm_nfv_ovs_dpdk_bar-ha | | ``Y`` | -+------------------------------------------+------------------+-----------------+ - -* Future scope may include adding Apex support for all the remaining scenarios - -* The below documents are delivered for Danube KVM4NFV Release: - - * User Guide - - * Configuration Guide - - * Installation Procedure - - * Overview - - * Release notes - - * Glossary - - * Scenarios - - * Requirements Guide - - * Overview Guide - -References ----------- - -For more information on the KVM4NFV Danube release, please see: - -https://wiki.opnfv.org/display/kvm/ diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst index ff6898746..00fe6c85f 100644 --- a/docs/release/userguide/index.rst +++ b/docs/release/userguide/index.rst @@ -23,3 +23,4 @@ KVM4NFV User Guide ./packet_forwarding.userguide.rst ./pcm_utility.userguide.rst ./tuning.userguide.rst + ./kvmfornfv_glossary.rst diff --git a/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst b/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst index 468f471e7..c119b43c7 100644 --- a/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst +++ b/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst @@ -202,7 +202,7 @@ Influxdb api which is already implemented in `Influxdb`_ will post the data in l ``Displaying Results on Grafana dashboard:`` - Once the test results are stored in Influxdb, dashboard configuration file(Json) which used to display the cyclictest results -on Grafana need to be created by following the `Grafana-procedure`_ and then pushed into `yardstick-repo`_ +on Grafana need to be created by following the `Grafana-procedure`_ and then pushed into `yardstick-repo`_\ - Grafana can be accessed at `Login`_ using credentials opnfv/opnfv and used for visualizing the collected test data as shown in `Visual`_\ diff --git a/docs/release/userguide/kvmfornfv_glossary.rst b/docs/release/userguide/kvmfornfv_glossary.rst new file mode 100644 index 000000000..aed5a971e --- /dev/null +++ b/docs/release/userguide/kvmfornfv_glossary.rst @@ -0,0 +1,401 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. http://creativecommons.org/licenses/by/4.0 + +************** +OPNFV Glossary +************** + +Danube 1.0 +------------ + + +Contents +-------- + +This glossary provides a common definition of phrases and words commonly used +in OPNFV. + +-------- + +A +~ + +Arno + + A river running through Tuscany and the name of the first OPNFV release. + +API + + Application Programming Interface + +AVX2 + + Advanced Vector Extensions 2 is an instruction set extension for x86. + + +-------- + +B +~ + +Brahmaputra + + A river running through Asia and the name of the Second OPNFV release. + +Bios + + Basic Input/Output System + +Builds + + Build in Jenkins is a version of a program. + +Bogomips + + Bogomips is the number of million times per second a processor can do + absolutely nothing. + +-------- + +C +~ + +CAT + + Cache Automation Technology + +CentOS + + Community Enterprise Operating System is a Linux distribution + +CICD + + Continuous Integration and Continuous Deployment + +CLI + + Command Line Interface + +Colorado + + A river in Argentina and the name of the Third OPNFV release. + +Compute + + Compute is an OpenStack service which offers many configuration options + which may be deployment specific. + +Console + + Console is display screen. + +CPU + Central Processing Unit + +-------- + +D +~ + +Danube + + Danube is the fourth release of OPNFV and also a river in Europe + +Data plane + + The data plane is the part of a network that carries user traffic. + +Debian/deb + + Debian is a Unix-like computer operating system that is composed entirely of + free software. + +Docs + + Documentation/documents + +DPDK + + Data Plane Development Kit + +DPI + + Deep Packet Inspection + +DSCP + + Differentiated Services Code Point + +-------- + +F +~ + +Flavors + + Flavors are templates used to define VM configurations. + +Fuel + + Provides an intuitive, GUI-driven experience for deployment and management of OpenStack + +-------- + +H +~ + +Horizon + + Horizon is an OpenStack service which serves as an UI. + +Hypervisor + + A hypervisor, also called a virtual machine manager, is a program that allows + multiple operating systems to share a single hardware host. + +-------- + +I +~ + +IGMP + + Internet Group Management Protocol + +IOMMU + + Input-Output Memory Management Unit + +IOPS + + Input/Output Operations Per Second + +IRQ + + Interrupt ReQuest is an interrupt request sent from the hardware level to + the CPU. + +IRQ affinity + + IRQ affinity is the set of CPU cores that can service that interrupt. + +-------- + +J +~ + +Jenkins + + Jenkins is an open source continuous integration tool written in Java. + +JIRA + + JIRA is a bug tracking software. + +Jitter + + Time difference in packet inter-arrival time to their destination can be called jitter. + +JumpHost + + A jump host or jump server or jumpbox is a computer on a network typically + used to manage devices in a separate security zone. + +-------- + +K +~ + +Kernel + + The kernel is a computer program that constitutes the central core of a + computer's operating system. + +-------- + +L +~ + +Latency + + The amount of time it takes a packet to travel from source to destination is + Latency. + +libvirt + + libvirt is an open source API, daemon and management tool for managing + platform virtualization. + +-------- + +M +~ + +Migration + + Migration is the process of moving from the use of one operating environment + to another operating environment. + +-------- + +N +~ + +NFV + + Network Functions Virtualisation, an industry initiative to leverage + virtualisation technologies in carrier networks. + +NFVI + + Network Function Virtualization Infrastructure + +NIC + + Network Interface Controller + +NUMA + + Non-Uniform Memory Access + +-------- + +O +~ + +OPNFV + + Open Platform for NFV, an open source project developing an NFV reference + platform and features. + +-------- + +P +~ + +Pharos + + Is a lighthouse and is a project deals with developing an OPNFV lab + infrastructure that is geographically and technically diverse. + +Pipeline + + A suite of plugins in Jenkins that lets you orchestrate automation. + +Platform + + OPNFV provides an open source platform for deploying NFV solutions that + leverages investments from a community of developers and solution providers. + +Pools + + A Pool is a set of resources that are kept ready to use, rather than acquired + on use and released afterwards. + +-------- + +Q +~ + +Qemu + + QEMU is a free and open-source hosted hypervisor that performs hardware + virtualization. + +-------- + +R +~ + +RDMA + + Remote Direct Memory Access (RDMA) + +Rest-Api + + REST (REpresentational State Transfer) is an architectural style, and an + approach to communications that is often used in the development of web + services + +-------- + +S +~ + +Scaling + + Refers to altering the size. + +Slave + + Works with/for master.where master has unidirectional control over one or + more other devices. + +SR-IOV + + Single root IO- Virtualization. + +Spin locks + + A spinlock is a lock which causes a thread trying to acquire it to simply + wait in a loop while repeatedly checking if the lock is available. + +Storage + + Refers to computer components which store some data. + +-------- + +T +~ + +Tenant + + A Tenant is a group of users who share a common access with specific + privileges to the software instance. + +Tickless + + A tickless kernel is an operating system kernel in which timer interrupts + do not occur at regular intervals, but are only delivered as required. + +TSC + + Technical Steering Committee + +-------- + +V +~ + +VLAN + + A virtual local area network, typically an isolated ethernet network. + +VM + + Virtual machine, an emulation in software of a computer system. + +VNF + + Virtual network function, typically a networking application or function + running in a virtual environment. + +-------- + +X +~ + +XBZRLE + + Helps to reduce the network traffic by just sending the updated data + +-------- + +Y +~ + +Yardstick + + Yardstick is an infrastructure verification. It is an OPNFV testing project. -- cgit 1.2.3-korg