Merge "This patch is used to update the documents of D-release."

1 files changed, 104 insertions, 51 deletions

diff --git a/docs/scenarios/kvmfornfv.scenarios.description.rst b/docs/scenarios/kvmfornfv.scenarios.description.rst
index 459852d53..29488bbfd 100644
--- a/docs/scenarios/kvmfornfv.scenarios.description.rst
+++ b/docs/scenarios/kvmfornfv.scenarios.description.rst
@@ -1,19 +1,20 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
 .. http://creativecommons.org/licenses/by/4.0
+
 ========================
 KVM4NFV SCENARIO-TESTING
 ========================
 
 ABSTRACT
-========
+--------
 
-This document describes the procedure to deploy/test KVM4NFV scenario in a nested virtualization
-environment in a single system. This has been verified with 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 test scenario.
+This document describes the procedure to deploy/test KVM4NFV scenarios in a nested virtualization
+environment. This has been verified with 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 test scenarios.
 
 Version Features
-================
+----------------
 
 +-----------------------------+---------------------------------------------+
 |                             |                                             |
@@ -24,26 +25,40 @@ Version Features
 |       Colorado              |   the Colorado release of KVMFORNFV         |
 |                             |                                             |
 +-----------------------------+---------------------------------------------+
-|                             | - High Availability deployment and          |
-|                             |   configuration of KVMFORNFV software suite |
-|        Danube               | - Multi-node setup with 3 controllers and   |
-|                             |   2 computes nodes are deployed             |
-|                             | - Scenarios os-nosdn-kvm_ovs_dpdk-ha and    |
-|                             |   os-nosdn-kvm_ovs_dpdk_bar-ha are supported|
-|                             |                                             |
+|                             | - High Availability/No-High Availability    |
+|                             |   deployment configuration of KVMFORNFV     |
+|                             |   software suite                            |
+|        Danube               | - Multi-node setup with 3 controller and    |
+|                             |   2 compute nodes are deployed for HA       |
+|                             | - Multi-node setup with 1 controller and    |
+|                             |   3 compute nodes are deployed for NO-HA    |
+|                             | - Scenarios os-nosdn-kvm_ovs_dpdk-ha,       |
+|                             |   os-nosdn-kvm_ovs_dpdk_bar-ha,             |
+|                             |   os-nosdn-kvm_ovs_dpdk-noha,               |
+|                             |   os-nosdn-kvm_ovs_dpdk_bar-noha            |
+|                             |   are supported                             |
 +-----------------------------+---------------------------------------------+
 
 
 INTRODUCTION
-============
-The purpose of os-nosdn-kvm_ovs_dpdk-ha and os-nosdn-kvm_ovs_dpdk_bar-ha scenario testing is to
-test the High Availability deployment and configuration of OPNFV software suite with OpenStack and
-without SDN software. This OPNFV software suite includes OPNFV KVMFORNFV latest software packages
+------------
+The purpose of os-nosdn-kvm_ovs_dpdk-ha,os-nosdn-kvm_ovs_dpdk_bar-ha and
+os-nosdn-kvm_ovs_dpdk-noha,os-nosdn-kvm_ovs_dpdk_bar-noha scenarios testing is to
+test the High Availability/No-High Availability deployment and configuration of
+OPNFV software suite with OpenStack and without SDN software.
+
+This OPNFV software suite includes OPNFV KVMFORNFV latest software packages
 for Linux Kernel and QEMU patches for achieving low latency and also OPNFV Barometer for traffic,
-performance and platform monitoring. High Availability feature is achieved by deploying OpenStack
+performance and platform monitoring.
+
+High Availability feature is achieved by deploying OpenStack
 multi-node setup with 1 Fuel-Master,3 controllers and 2 computes nodes.
 
-KVMFORNFV packages will be installed on compute nodes as part of deployment. The scenario testcase deploys a multi-node setup by using OPNFV Fuel deployer.
+No-High Availability feature is achieved by deploying OpenStack
+multi-node setup with 1 Fuel-Master,1 controllers and 3 computes nodes.
+
+KVMFORNFV packages will be installed on compute nodes as part of deployment.
+The scenario testcase deploys a multi-node setup by using OPNFV Fuel deployer.
 
 1. System pre-requisites
 ------------------------
@@ -86,9 +101,11 @@ If Nested virtualization is disabled, enable it by,
 2. Environment Setup
 --------------------
 
-**2.1  Configure apt.conf in /etc/apt**
+**2.1  Configuring Proxy**
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Create an apt.conf file in /etc/apt if it doesn't exist. Used to set proxy for apt-get if workin behind a proxy server.
+For **Ubuntu**.,
+Create an apt.conf file in /etc/apt if it doesn't exist. Used to set proxy for apt-get if working behind a proxy server.
 
 .. code:: bash
 
@@ -97,7 +114,15 @@ Create an apt.conf file in /etc/apt if it doesn't exist. Used to set proxy for a
    Acquire::ftp::proxy "ftp://<username>:<password>@<proxy>:<port>/";
    Acquire::socks::proxy "socks://<username>:<password>@<proxy>:<port>/";
 
+For **CentOS**.,
+Edit /etc/yum.conf to work behind a proxy server by adding the below line.
+
+.. code:: bash
+
+   $ echo "proxy=http://<username>:<password>@<proxy>:<port>/" >> /etc/yum.conf
+
 **2.2 Network Time Protocol (NTP) setup and configuration**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Install ntp by:
 
@@ -110,10 +135,12 @@ Insert the following two lines after  “server ntp.ubuntu.com” line and befor
 
 .. _link: /usr/share/doc/ntp-doc/html/accopt.html
 
-server 127.127.1.0
-fudge 127.127.1.0 stratum 10
+.. code:: bash
+
+   server 127.127.1.0
+   fudge 127.127.1.0 stratum 10
 
-Restart the ntp server
+Restart the ntp server to apply the changes
 
 .. code:: bash
 
@@ -128,19 +155,24 @@ There are three ways of performing scenario testing,
     - 3.3 Jenkins Project
 
 3.1 Fuel
-~~~~~~~~~
+~~~~~~~~
 
 **3.1.1 Clone the fuel repo :**
 
 .. code:: bash
 
-              git clone https://gerrit.opnfv.org/gerrit/fuel.git
+   $ git clone https://gerrit.opnfv.org/gerrit/fuel.git
 
 **3.1.2 Checkout to the specific version of the branch to deploy by:**
 
+The default branch is master, to use a stable release-version use the below.,
+
 .. code:: bash
+    To check the current branch
+    $ git branch
 
-              git checkout stable/Colorado
+    To check out a specific branch
+    $ git checkout stable/Colorado
 
 **3.1.3  Building the Fuel iso :**
 
@@ -149,28 +181,34 @@ There are three ways of performing scenario testing,
               $ cd ~/fuel/ci/
               $ ./build.sh -h
 
-Provides the necessary options that are required to build an iso. Creates a ``customized iso`` as per the deployment needs.
+Provide the necessary options that are required to build an iso.
+Create a ``customized iso`` as per the deployment needs.
 
 .. code:: bash
 
               $ cd ~/fuel/build/
               $ make
 
- (OR) Other way is to download the latest stable fuel iso from `here`_.
+(OR) Other way is to download the latest stable fuel iso from `here`_.
 
-.. _here: http://artifacts.opnfv.org/fuel/colorado/opnfv-colorado.3.0.iso
+.. _here: http://artifacts.opnfv.org/fuel.html
+
+.. code:: bash
+
+   http://artifacts.opnfv.org/fuel.html
 
 **3.1.4 Creating a new deployment scenario**
 
 ``(i). Naming the scenario file:``
 
-Include the new deployment scenario yaml file in deploy/scenario/. The file name should adhere to the following format :
+Include the new deployment scenario yaml file in ~/fuel/deploy/scenario/. The file name should adhere to the following format:
 
 .. code:: bash
 
     <ha | no-ha>_<SDN Controller>_<feature-1>_..._<feature-n>.yaml
 
-``(ii). The deployment configuration file should contain configuration metadata as stated below:``
+``(ii). Meta data``
+The deployment configuration file should contain configuration metadata as stated below:
 
 .. code:: bash
 
@@ -179,7 +217,8 @@ Include the new deployment scenario yaml file in deploy/scenario/. The file name
                       version:
                       created:
 
-``(iii). To include fuel plugins in the deployment configuration file, use the “stack-extentions” key:``
+``(iii). “stack-extentions” Module``
+ To include fuel plugins in the deployment configuration file, use the “stack-extentions” key:
 
 .. code:: bash
 
@@ -191,13 +230,13 @@ Include the new deployment scenario yaml file in deploy/scenario/. The file name
                           module-config-override:
                           #module-config overrides
 
-
+**Note:**
 The “module-config-name” and “module-config-version” should be same as the name of plugin configuration file.
 
-
 The “module-config-override” is used to configure the plugin by overrriding the corresponding keys in the plugin config yaml file present in ~/fuel/deploy/config/plugins/.
 
-``(iv). To configure the HA/No-Ha mode, network segmentation types and role to node assignments, use the “dea-override-config” key.``
+``(iv).  “dea-override-config” Module``
+To configure the HA/No-HA mode, network segmentation types and role to node assignments, use the “dea-override-config” key.
 
 .. code:: bash
 
@@ -244,12 +283,12 @@ Under the “dea-override-config” should provide atleast {environment:{mode:'v
 and {nodes:1,2,...} and can also enable additional stack features such ceph,heat which overrides
 corresponding keys in the dea_base.yaml and dea_pod_override.yaml.
 
-``(v). In order to configure the pod dha definition, use the “dha-override-config” key.``
-
-The “dha-override-config” key is an optional key present at the ending of the scenario file.
-
-``(vi). The scenario.yaml file is used to map the short names of scenario's to the one or more deployment scenario configuration yaml files.``
+``(v). “dha-override-config”  Module``
+In order to configure the pod dha definition, use the “dha-override-config” key.
+This is an optional key present at the ending of the scenario file.
 
+``(vi). Mapping to short scenario name``
+The scenario.yaml file is used to map the short names of scenario's to the one or more deployment scenario configuration yaml files.
 The short scenario names should follow the scheme below:
 
 .. code:: bash
@@ -259,7 +298,7 @@ The short scenario names should follow the scheme below:
         [os]: mandatory
         possible value: os
 
-please note that this field is needed in order to select parent jobs to list and do blocking relations between them.
+Please note that this field is needed in order to select parent jobs to list and do blocking relations between them.
 
 .. code:: bash
 
@@ -272,8 +311,8 @@ please note that this field is needed in order to select parent jobs to list and
 
     [option]: optional
 
-used for the scenarios those do not fit into naming scheme.
-optional field in the short scenario name should not be included if there is no optional scenario.
+Used for the scenarios those do not fit into naming scheme.
+Optional field in the short scenario name should not be included if there is no optional scenario.
 
 .. code:: bash
 
@@ -303,14 +342,22 @@ Command to deploy the os-nosdn-kvm_ovs_dpdk-ha scenario:
 .. code:: bash
 
         $ cd ~/fuel/ci/
-        $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s no-ha_nfv-kvm_nfv-ovsdpdk_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso
+        $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso
 
 where,
-    -b is used to specify the configuration directory
+    ``-b`` is used to specify the configuration directory
 
-    -i is used to specify the image downloaded from artifacts.
+    ``-f`` is used to re-deploy on the existing deployment
 
-Note:
+    ``-i`` is used to specify the image downloaded from artifacts.
+
+    ``-l`` is used to specify the lab name
+
+    ``-p`` is used to specify POD name
+
+    ``-s`` is used to specify the scenario file
+
+**Note:**
 
 .. code:: bash
 
@@ -381,7 +428,8 @@ Check out the specific version of specific branch of fuel@opnfv
    $ cd ~
    $ git clone https://gerrit.opnfv.org/gerrit/fuel.git
    $ cd fuel
-   $ git checkout stable/Colorado
+   By default it will be master branch, in-order to deploy on the Colorado/Danube branch, do:
+   $ git checkout stable/Danube
 
 
 ``3.2.3 Creating the scenario``
@@ -390,7 +438,7 @@ Implement the scenario file as described in 3.1.4
 
 ``3.2.4 Deploying the scenario``
 
-You can use the following command to start to deploy/test os-nosdn kvm_ovs_dpdk-noha and os-nosdn-kvm_ovs_dpdk-ha scenario
+You can use the following command to deploy/test os-nosdn kvm_ovs_dpdk-(no)ha and os-nosdn-kvm_ovs_dpdk_bar-(no)ha scenario
 
 .. code:: bash
 
@@ -409,7 +457,7 @@ For os-nosdn-kvm_ovs_dpdk_bar-ha:
    $ ./ci_pipeline.sh -r ~/fuel -i /root/fuel.iso -B -n intel-sc -s os-nosdn-kvm_ovs_dpdk_bar-ha
 
 The “ci_pipeline.sh” first clones the local fuel repo, then deploys the
-os-nosdn-kvm_ovs_dpdk-ha/os-nosdn-kvm_ovs_dpdk-noha scenario from the given ISO, and run Func test
+os-nosdn-kvm_ovs_dpdk-ha/os-nosdn-kvm_ovs_dpdk_bar-ha scenario from the given ISO, and run Functest
 and Yarstick test.  The log of the deployment/test (ci.log)  can be found in
 ~/OPNFV-Playground/ci_fuel_opnfv/artifact/master/YYYY-MM-DD—HH.mm, where YYYY-MM-DD—HH.mm is the
 date/time you start the “ci_pipeline.sh”.
@@ -424,7 +472,12 @@ Note:
 3.3 Jenkins Project
 ~~~~~~~~~~~~~~~~~~~
 
-os-nosdn-kvm_ovs_dpdk-ha and os-nosdn-kvm_ovs_dpdk_bar-ha scenario can be executed from the jenkins project :
+os-nosdn-kvm_ovs_dpdk-(no)ha and os-nosdn-kvm_ovs_dpdk_bar-(no)ha scenario can be executed from the jenkins project :
 
+    HA scenarios:
         1.  "fuel-os-nosdn-kvm_ovs_dpdk-ha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk-ha)
         2.  "fuel-os-nosdn-kvm_ovs_dpdk_bar-ha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk_bar-ha)
+
+    NOHA scenarios:
+       1.  "fuel-os-nosdn-kvm_ovs_dpdk-noha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk-noha)
+       2.  "fuel-os-nosdn-kvm_ovs_dpdk_bar-noha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk_bar-noha)