docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 .. http://creativecommons.org/licenses/by/4.0
   4
   5
   6 Introduction
   7 ============
   8
   9 .. In this section explain the purpose of the scenario and the
  10    types of capabilities provided
  11
  12 The purpose of os-nosdn-kvm_ovs_dpdk-noha scenario testing is to test the
  13 High Availability deployment and configuration of OPNFV software suite
  14 with OpenStack and without SDN software. This OPNFV software suite
  15 includes OPNFV KVM4NFV latest software packages for Linux Kernel and
  16 QEMU patches for achieving low latency. High Availability feature is achieved
  17 by deploying OpenStack multi-node setup with 3 controllers and 2 computes nodes.
  18
  19 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.
  20
  21 Scenario Components and Composition
  22 ===================================
  23 .. In this section describe the unique components that make up the scenario,
  24 .. what each component provides and why it has been included in order
  25 .. to communicate to the user the capabilities available in this scenario.
  26
  27 This scenario deploys the High Availability OPNFV Cloud based on the
  28 configurations provided in noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml.
  29 This yaml file contains following configurations and is passed as an
  30 argument to deploy.py script
  31
  32 * scenario.yaml:This configuration file defines translation between a
  33   short deployment scenario name(os-nosdn-kvm_ovs_dpdk-noha) and an actual deployment
  34   scenario configuration file(noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml)
  35
  36 * ``deployment-scenario-metadata:`` Contains the configuration metadata like
  37   title,version,created,comment.
  38
  39 .. code:: bash
  40
  41    deployment-scenario-metadata:
  42       title: NFV KVM and OVS-DPDK NOHA deployment
  43       version: 0.0.1
  44       created: Dec 20 2016
  45       comment: NFV KVM and OVS-DPDK
  46
  47 * ``stack-extensions:`` Stack extentions are opnfv added value features in form
  48   of a fuel-plugin.Plugins listed in stack extensions are enabled and
  49   configured. os-nosdn-kvm_ovs_dpdk-noha scenario currently uses KVM-1.0.0 plugin.
  50
  51 .. code:: bash
  52
  53    stack-extensions:
  54       - module: fuel-plugin-kvm
  55         module-config-name: fuel-nfvkvm
  56         module-config-version: 1.0.0
  57         module-config-override:
  58           # Module config overrides
  59
  60 * ``dea-override-config:`` Used to configure the HA mode,network segmentation
  61   types and role to node assignments.These configurations overrides
  62   corresponding keys in the dea_base.yaml and dea_pod_override.yaml.
  63   These keys are used to deploy multiple nodes(``1 controller,3 computes``)
  64   as mention below.
  65
  66   * **Node 1**: This node has MongoDB and Controller roles. The controller
  67     node runs the Identity service, Image Service, management portions of
  68     Compute and Networking, Networking plug-in and the dashboard. The
  69     Telemetry service which was designed to support billing systems for
  70     OpenStack cloud resources uses a NoSQL database to store information.
  71     The database typically runs on the controller node.
  72
  73   * **Node 2**: This node has compute and Ceph-osd roles. Ceph is a
  74     massively scalable, open source, distributed storage system. It is
  75     comprised of an object store, block store and a POSIX-compliant
  76     file system. Enabling Ceph, configures Nova to store ephemeral volumes in
  77     RBD, configures Glance to use the Ceph RBD backend to store images,
  78     configures Cinder to store volumes in Ceph RBD images and configures the
  79     default number of object replicas in Ceph.
  80
  81   * **Node 3**: This node has Compute role in order to achieve high
  82     availability.
  83
  84   * **Node 4**: This node has Compute role. The compute node runs the
  85     hypervisor portion of Compute that operates tenant virtual machines
  86     or instances. By default, Compute uses KVM as the hypervisor.
  87
  88   The below is the ``dea-override-config`` of the noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml file.
  89
  90 .. code:: bash
  91
  92    dea-override-config:
  93      fuel:
  94        FEATURE_GROUPS:
  95        - experimental
  96      environment:
  97        net_segment_type: vlan
  98      nodes:
  99      - id: 1
 100        interfaces: interfaces_vlan
 101        role: mongo,controller
 102      - id: 2
 103        interfaces: interfaces_dpdk
 104        role: ceph-osd,compute
 105        attributes: attributes_1
 106      - id: 3
 107        interfaces: interfaces_dpdk
 108        role: ceph-osd,compute
 109        attributes: attributes_1
 110      - id: 4
 111        interfaces: interfaces_dpdk
 112        role: ceph-osd,compute
 113        attributes: attributes_1
 114
 115      attributes_1:
 116        hugepages:
 117          dpdk:
 118            value: 1024
 119          nova:
 120            value:
 121              '2048': 1024
 122
 123      network:
 124        networking_parameters:
 125          segmentation_type: vlan
 126        networks:
 127        - cidr: null
 128          gateway: null
 129          ip_ranges: []
 130          meta:
 131            configurable: false
 132            map_priority: 2
 133            name: private
 134            neutron_vlan_range: true
 135            notation: null
 136            render_addr_mask: null
 137            render_type: null
 138            seg_type: vlan
 139            use_gateway: false
 140            vlan_start: null
 141          name: private
 142          vlan_start: null
 143
 144      settings:
 145        editable:
 146          storage:
 147            ephemeral_ceph:
 148              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).
 149              label: Ceph RBD for ephemeral volumes (Nova)
 150              type: checkbox
 151              value: true
 152              weight: 75
 153            images_ceph:
 154              description: Configures Glance to use the Ceph RBD backend to store images. If enabled, this option will prevent Swift from installing.
 155              label: Ceph RBD for images (Glance)
 156              restrictions:
 157              - settings:storage.images_vcenter.value == true: Only one Glance backend could be selected.
 158              type: checkbox
 159              value: true
 160              weight: 30
 161
 162 * ``dha-override-config:`` Provides information about the VM definition and
 163   Network config for virtual deployment.These configurations overrides
 164   the pod dha definition and points to the controller,compute and
 165   fuel definition files. The noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml has no dha-config changes i.e., default    configuration is used.
 166
 167 * os-nosdn-kvm_ovs_dpdk-noha scenario is successful when all the 4 Nodes are accessible,
 168   up and running.
 169
 170
 171
 172 **Note:**
 173
 174 * In os-nosdn-kvm_ovs_dpdk-noha scenario, OVS is installed on the compute nodes with DPDK configured
 175
 176 * This results in faster communication and data transfer among the compute nodes
 177
 178
 179 Scenario Usage Overview
 180 =======================
 181 .. Provide a brief overview on how to use the scenario and the features available to the
 182 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
 183 .. where the specifics of the features are covered including examples and API's
 184
 185 * The high availability feature is disabled and deploymet is done by deploy.py with
 186   noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml as an argument.
 187 * Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware
 188   Environment:
 189
 190
 191 Command to deploy the os-nosdn-kvm_ovs_dpdk-noha scenario:
 192
 193 .. code:: bash
 194
 195         $ cd ~/fuel/ci/
 196         $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso
 197
 198 where,
 199     -b is used to specify the configuration directory
 200
 201     -i is used to specify the image downloaded from artifacts.
 202
 203 Note:
 204
 205 .. code:: bash
 206
 207          Check $ sudo ./deploy.sh -h for further information.
 208
 209 * os-nosdn-kvm_ovs_dpdk-noha scenario can be executed from the jenkins project
 210   "fuel-os-nosdn-kvm_ovs_dpdk-noha-baremetal-daily-master"
 211 * This scenario provides the High Availability feature by deploying
 212   3 controller,2 compute nodes and checking if all the 5 nodes
 213   are accessible(IP,up & running).
 214 * Test Scenario is passed if deployment is successful and all 5 nodes have
 215   accessibility (IP , up & running).
 216
 217 Known Limitations, Issues and Workarounds
 218 =========================================
 219 .. Explain any known limitations here.
 220
 221 * Test scenario os-nosdn-kvm_ovs_dpdk-noha result is not stable.
 222
 223 References
 224 ==========
 225
 226 For more information on the OPNFV Danube release, please visit
 227 http://www.opnfv.org/Danube