docs/release/scenarios/os-nosdn-bar-noha/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-bar-noha overview and description
   7 =================================================
   8
   9 This document provides details of the scenario for Euphrates release 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
  20 This scenario has the features from the Barometer project. Collectd (a telemetry agent) is installed
  21 on compute nodes so that their statistics, events and alarming services can be relayed to Gnoochi and Aodh.
  22 These are the first steps in paving the way for Platform (NFVI) Monitoring in OPNFV.
  23
  24 Scenario components and composition
  25 -------------------------------------
  26 .. In this section describe the unique components that make up the scenario,
  27 .. what each component provides and why it has been included in order
  28 .. to communicate to the user the capabilities available in this scenario.
  29
  30 This scenario deploys the High Availability OPNFV Cloud based on the
  31 configurations provided in ``os-nosdn-bar-noha.yaml``.
  32 This yaml file contains configurations and is passed as an
  33 argument to ``overcloud-deploy-function.sh`` script.
  34 This scenario deploys multiple nodes: 1 Controller, 2 Computes.
  35
  36 Collectd is installed on compute nodes and Openstack services runs on the controller node.
  37
  38 os-nosdn-bar-noha scenario is successful when all the nodes are accessible, up and running.
  39 Also, verify if plugins/services are communicating with Gnocchi and Aodh on the controller nodes.
  40
  41 Scenario usage overview
  42 ----------------------------
  43 .. Provide a brief overview on how to use the scenario and the features available to the
  44 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
  45 .. where the specifics of the features are covered including examples and API's
  46
  47 After installation, plugins will be able to read/write the stats on/from the controller node.
  48 A detailed list of supported plugins along with their sample configuration can be found in the userguide.
  49
  50 Limitations, Issues and Workarounds
  51 ---------------------------------------
  52 .. Explain scenario limitations here, this should be at a design level rather than discussing
  53 .. faults or bugs.  If the system design only provide some expected functionality then provide
  54 .. some insight at this point.
  55
  56 None.
  57
  58 References
  59 -----------------
  60
  61