diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release/scenarios/index.rst | 4 | ||||
| -rw-r--r-- | docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst | 61 | ||||
| -rw-r--r-- | docs/release/scenarios/os-nosdn-bar-noha/scenario.description.rst | 61 |
3 files changed, 124 insertions, 2 deletions
diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst index 12ca9933..7593434a 100644 --- a/docs/release/scenarios/index.rst +++ b/docs/release/scenarios/index.rst @@ -12,5 +12,5 @@ OPNFV Barometer Scenarios .. toctree:: :maxdepth: 1 - ./os-nosdn-kvm_ovs_dpdk_bar-ha/scenario.description - + ./os-nosdn-bar-ha/scenario.description + ./os-nosdn-bar-noha/scenario.description 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 00000000..3f31ff0d --- /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: + +Introduction +--------------- +.. 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. + +None. + +References +----------------- + + diff --git a/docs/release/scenarios/os-nosdn-bar-noha/scenario.description.rst b/docs/release/scenarios/os-nosdn-bar-noha/scenario.description.rst new file mode 100644 index 00000000..d6a1184a --- /dev/null +++ b/docs/release/scenarios/os-nosdn-bar-noha/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-noha overview and description +================================================= + +This document provides details of the scenario for Euphrates release of Barometer. + +.. contents:: + :depth: 3 + :local: + +Introduction +--------------- +.. 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-noha.yaml``. +This yaml file contains configurations and is passed as an +argument to ``overcloud-deploy-function.sh`` script. +This scenario deploys multiple nodes: 1 Controller, 2 Computes. + +Collectd is installed on compute nodes and Openstack services runs on the controller node. + +os-nosdn-bar-noha 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. + +None. + +References +----------------- + + |