path: root/docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst
diff options
authorShobhi <shobhi.jain@intel.com>2017-08-25 12:48:24 +0100
committerShobhi Jain <shobhi.jain@intel.com>2017-08-25 15:18:30 +0000
commit9fbeaeddd7903f6265a6be767ea7271cb19cff4b (patch)
tree5834e501d64d459b1d598fb607afee029e538c6a /docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst
parent04e102b5abcff93b10eaa08a64249a7e0c709c34 (diff)
docs: updated scenario document for E release.
* removed old scenario os-nosdn-kvm_ovs_dpdk_bar-ha file. * added two new scenario files. Change-Id: If737b34ecd3cc594b5e2bca82268f3c8ec6476f7 Signed-off-by: Shobhi <shobhi.jain@intel.com>
Diffstat (limited to 'docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst')
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst b/docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst
new file mode 100644
index 0000000..3f31ff0
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst
@@ -0,0 +1,61 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+OPNFV os-nosdn-bar-ha overview and description
+This document provides details of the scenario for Euphrates release of Barometer.
+.. contents::
+ :depth: 3
+ :local:
+.. In this section explain the purpose of the scenario and the types of
+.. capabilities provided
+This scenario has the features from the Barometer project. Collectd (a telemetry agent) is installed
+on compute nodes so that their statistics, events and alarming services can be relayed to Gnoochi and Aodh.
+These are the first steps in paving the way for Platform (NFVI) Monitoring in OPNFV.
+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 deploys the High Availability OPNFV Cloud based on the
+configurations provided in ``os-nosdn-bar-ha.yaml``.
+This yaml file contains configurations and is passed as an
+argument to ``overcloud-deploy-function.sh`` script.
+This scenario deploys multiple nodes: 3 Controllers, 2 Computes.
+Collectd is installed on compute nodes and Openstack services runs on the controller nodes.
+os-nosdn-bar-ha scenario is successful when all the nodes are accessible, up and running.
+Also, verify if plugins/services are communicating with Gnocchi and Aodh on the controller nodes.
+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
+After installation, plugins will be able to read/write the stats on/from the controller node.
+A detailed list of supported plugins along with their sample configuration can be found in the userguide.
+Limitations, Issues and Workarounds
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs. If the system design only provide some expected functionality then provide
+.. some insight at this point.