To update the documentation for E-release
[kvmfornfv.git] / docs / release / scenarios / os-nosdn-kvm_ovs_dpdk-ha / os-nosdn-kvm_ovs_dpdk-ha.description.rst
@@ -3,7 +3,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 =========================================
-os-nosdn-kvm_nfv_ovs_dpdk-ha Description
+os-nosdn-kvm_ovs_dpdk-ha Description
 =========================================
 
 Introduction
@@ -20,7 +20,11 @@ QEMU patches for achieving low latency. High Availability feature is achieved
 by deploying OpenStack multi-node setup with 3 controllers and 2 computes nodes.
 
 KVM4NFV packages will be installed on compute nodes as part of deployment.
-This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer.
+This scenario testcase deployment is happening on multi-node by using OPNFV Fuel
+and Apex deployer.
+
+
+**Using Fuel Installer**
 
 Scenario Components and Composition
 -----------------------------------
@@ -135,13 +139,17 @@ argument to deploy.py script
        editable:
          storage:
            ephemeral_ceph:
-             description: Configures Nova to store ephemeral volumes in RBD. This works best if Ceph is enabled for volumes and images, too. Enables live migration of all types of Ceph backed VMs (without this option, live migration will only work with VMs launched from Cinder volumes).
+             description: Configures Nova to store ephemeral volumes in RBD. This works best if Ceph
+             is enabled for volumes and images, too. Enables live migration of all types of Ceph
+             backed VMs (without this option, live migration will only work with VMs launched from
+             Cinder volumes).
              label: Ceph RBD for ephemeral volumes (Nova)
              type: checkbox
              value: true
              weight: 75
            images_ceph:
-             description: Configures Glance to use the Ceph RBD backend to store images. If enabled, this option will prevent Swift from installing.
+             description: Configures Glance to use the Ceph RBD backend to store images. If enabled,
+             this option will prevent Swift from installing.
              label: Ceph RBD for images (Glance)
              restrictions:
              - settings:storage.images_vcenter.value == true: Only one Glance backend could be selected.
@@ -190,7 +198,8 @@ argument to deploy.py script
 
 * In os-nosdn-kvm_ovs_dpdk-ha scenario, OVS is installed on the compute nodes with DPDK configured
 
-* Hugepages for DPDK are configured in the attributes_1 section of the no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml
+* Hugepages for DPDK are configured in the attributes_1 section of the
+no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml
 
 * Hugepages are only configured for compute nodes
 
@@ -199,7 +208,7 @@ argument to deploy.py script
 Scenario Usage Overview
 -----------------------
 .. Provide a brief overview on how to use the scenario and the features available to the
-.. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
+.. user. This should be an "introduction" to the userguide document, and explicitly link to it,
 .. where the specifics of the features are covered including examples and API's
 
 * The high availability feature can be acheived by executing deploy.py with
@@ -213,7 +222,8 @@ 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 ha_nfv-kvm_nfv-ovs-dpdk_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
@@ -234,14 +244,110 @@ where,
 * Test Scenario is passed if deployment is successful and all 5 nodes have
   accessibility (IP , up & running).
 
-Known Limitations, Issues and Workarounds
------------------------------------------
-.. Explain any known limitations here.
 
-* Test scenario os-nosdn-kvm_ovs_dpdk-ha result is not stable.
+**Using Apex Installer**
+
+Scenario Components and Composition
+-----------------------------------
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+This scenario is composed of common OpenStack services enabled by default,
+including Nova, Neutron, Glance, Cinder, Keystone, Horizon.  Optionally and
+by default, Tacker and Congress services are also enabled.  Ceph is used as
+the backend storage to Cinder on all deployed nodes.
+
+All services are in HA, meaning that there are multiple cloned instances of
+each service, and they are balanced by HA Proxy using a Virtual IP Address
+per service.
+
+The os-nosdn-kvm_ovs_dpdk-ha.yaml file contains following configurations and
+is passed as an argument to deploy.sh script.
+
+* ``global-params:`` Used to define the global parameter and there is only one
+  such parameter exists,i.e, ha_enabled
+
+.. code:: bash
+
+   global-params:
+     ha_enabled: true
+
+* ``deploy_options:`` Used to define the type of SDN controller, configure the
+  tacker, congress, service functioning chaining support(sfc) for ODL and ONOS,
+  configure ODL with SDNVPN support, which dataplane to use for overcloud
+  tenant networks, whether to run the kvm real time kernel (rt_kvm) in the
+  compute node(s) to reduce the network latencies caused by network function
+  virtualization and whether to install and configure fdio functionality in the
+  overcloud
+
+.. code:: bash
+
+   deploy_options:
+     sdn_controller: false
+     tacker: true
+     congress: true
+     sfc: false
+     vpn: false
+     rt_kvm: true
+     dataplane: ovs_dpdk
+
+* ``performance:`` Used to set performance options on specific roles. The valid
+  roles are 'Compute', 'Controller' and 'Storage', and the valid sections are
+  'kernel' and 'nova'
+
+.. code:: bash
+
+   performance:
+     Controller:
+       kernel:
+         hugepages: 1024
+         hugepagesz: 2M
+     Compute:
+       kernel:
+         hugepagesz: 2M
+         hugepages: 2048
+         intel_iommu: 'on'
+         iommu: pt
+       ovs:
+         socket_memory: 1024
+         pmd_cores: 2
+         dpdk_cores: 1
+
+Scenario Usage Overview
+-----------------------
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+* The high availability feature can be acheived by executing deploy.sh with
+  os-nosdn-kvm_ovs_dpdk-ha.yaml as an argument.
+
+* Build the undercloud and overcloud images as mentioned below:
+
+.. code:: bash
+
+   cd ~/apex/build/
+   make images-clean
+   make images
+
+* Command to deploy os-nosdn-kvm_ovs_dpdk-ha scenario:
+
+.. code:: bash
+
+   cd ~/apex/ci/
+   ./clean.sh
+   ./dev_dep_check.sh
+   ./deploy.sh -v --ping-site <ping_ip-address> --dnslookup-site <dns_ip-address> -n \
+   ~/apex/config/network/intc_network_settings.yaml -d ~/apex/config/deploy/os-nosdn-kvm_ovs_dpdk-ha.yaml
+
+where,
+    -v is used for virtual deployment
+    -n is used for providing the network configuration file
+    -d is used for providing the scenario configuration file
 
 References
 ----------
 
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/Danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/Euphrates