docs/release/scenarios/os-nosdn-kvm_ovs_dpdk_bar-ha/scenario.description.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) <optionally add copywriters name>
   4
   5 ===================================
   6 OPNFV os-nosdn-kvm_ovs_dpdk_bar-ha
   7 ===================================
   8
   9 This document provides scenario level details for Danube of Barometer.
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15 Introduction
  16 ---------------
  17 .. In this section explain the purpose of the scenario and the types of
  18 .. capabilities provided
  19 This scenario combines the features from the following three projects in a
  20 single instantiation of OPNFV:
  21
  22 - KVM4NFV
  23 - OVS4NFV
  24 - Barometer
  25
  26 A distinguishing factor for this scenario vs other scenarios that integrate
  27 Open vSwitch and KVM is that collectd (a telemetry agent) is installed on
  28 compute nodes so that their statistics and events can be relayed to ceilometer.
  29 These are the first steps in paving the way for Platform (NFVI) Monitoring in
  30 OPNFV.
  31
  32 For Fuel this scenario installs the latest DPDK-enabled Open vSwitch component,
  33 KVM4NFV latest software packages for Linux Kernel and QEMU patches for
  34 achieving low latency, and the collectd telemetry agent.
  35
  36 Scenario components and composition
  37 -------------------------------------
  38 .. In this section describe the unique components that make up the scenario,
  39 .. what each component provides and why it has been included in order
  40 .. to communicate to the user the capabilities available in this scenario.
  41
  42 This scenario deploys the High Availability OPNFV Cloud based on the
  43 configurations provided in ha_nfv-kvm_ovs_bar_heat_ceilometer_scenario.yaml.
  44 This yaml file contains following configurations and is passed as an
  45 argument to deploy.py script
  46
  47 * scenario.yaml:This configuration file defines translation between a
  48   short deployment scenario name(os-nosdn-kvm_ovs_dpdk_bar-ha) and an actual
  49   deployment scenario configuration file
  50   (ha_nfv-kvm_nfv-ovs-dpdk_bar_heat_ceilometer_scenario.yaml)
  51
  52 * deployment-scenario-metadata:Contains the configuration metadata like
  53   title,version,created,comment.
  54
  55 * stack-extensions:Stack extentions are opnfv added value features in form
  56   of a fuel-plugin.Plugins listed in stack extensions are enabled and
  57   configured.
  58
  59 * dea-override-config: Used to configure the HA mode,network segmentation
  60   types and role to node assignments. These configurations overrides
  61   corresponding keys in the dea_base.yaml and dea_pod_override.yaml.
  62   These keys are used to deploy multiple nodes(3 controllers,2 computes)
  63   as mention below.
  64
  65 * **Node 1**: This node has MongoDB and Controller roles. The controller
  66   node runs the Identity service, Image Service, management portions of
  67   Compute and Networking, Networking plug-in and the dashboard. The
  68   Telemetry service which was designed to support billing systems for
  69   OpenStack cloud resources uses a NoSQL database to store information.
  70   The database typically runs on the controller node.
  71
  72 * **Node 2**: This node has Controller and Ceph-osd roles. Ceph is a
  73   massively scalable, open source, distributed storage system. It is
  74   comprised of an object store, block store and a POSIX-compliant distributed
  75   file system. Enabling Ceph,  configures Nova to store ephemeral volumes in
  76   RBD, configures Glance to use the Ceph RBD backend to store images,
  77   configures Cinder to store volumes in Ceph RBD images and configures the
  78   default number of object replicas in Ceph.
  79
  80 * **Node 3**: This node has Controller role in order to achieve high
  81   availability.
  82
  83 * **Node 4**: This node has Compute role. The compute node runs the
  84   hypervisor portion of Compute that operates tenant virtual machines
  85   instances. By default, Compute uses KVM as the hypervisor. Collectd
  86   will be installed on this node.
  87
  88 * **Node 5**: This node has compute role.
  89
  90 * dha-override-config:Provides information about the VM definition and
  91   Network config for virtual deployment. These configurations overrides
  92   the pod dha definition and points to the controller,compute and
  93   fuel definition files.
  94
  95 * os-nosdn-kvm_ovs_dpdk_bar-ha scenario is successful when all the 5 Nodes are
  96   accessible, up and running.
  97
  98 Scenario usage overview
  99 ----------------------------
 100 .. Provide a brief overview on how to use the scenario and the features available to the
 101 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
 102 .. where the specifics of the features are covered including examples and API's
 103
 104 After installation use of the scenario traffic on the private network will
 105 automatically be processed by the upgraded DPDK datapath.
 106
 107 Limitations, Issues and Workarounds
 108 ---------------------------------------
 109 .. Explain scenario limitations here, this should be at a design level rather than discussing
 110 .. faults or bugs.  If the system design only provide some expected functionality then provide
 111 .. some insight at this point.
 112
 113 References
 114 -----------------
 115
 116 For more information on the OPNFV Danube release, please visit
 117 http://www.opnfv.org/danube
 118