From ba1d194769e171e9c306822202cd93e43e715fc1 Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Mon, 19 Oct 2020 11:04:57 +0100 Subject: [docs] Remove scenarios For Jerma, a documentation restructure was proposed [1]. THis change removes reference to scenarios in Barometer. [1] https://wiki.opnfv.org/display/meetings/OPNFV+TSC+Meeting+2020-10-13?preview=/63111416/63111451/OPNFV-docstructure.pdf Change-Id: Id55e55c3a4ea824c20fcadcfc4716ff8d23cc68f Change-Id: I135226f7ecc72ee086effede68f92ade0c85d0a2 Signed-off-by: Emma Foley --- docs/release/scenarios/index.rst | 16 --- docs/release/scenarios/os-nosdn-bar-ha/index.rst | 15 --- .../os-nosdn-bar-ha/scenario.description.rst | 61 ----------- docs/release/scenarios/os-nosdn-bar-noha/index.rst | 15 --- .../os-nosdn-bar-noha/scenario.description.rst | 61 ----------- .../scenario.description.rst | 118 --------------------- 6 files changed, 286 deletions(-) delete mode 100644 docs/release/scenarios/index.rst delete mode 100644 docs/release/scenarios/os-nosdn-bar-ha/index.rst delete mode 100644 docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst delete mode 100644 docs/release/scenarios/os-nosdn-bar-noha/index.rst delete mode 100644 docs/release/scenarios/os-nosdn-bar-noha/scenario.description.rst delete mode 100644 docs/release/scenarios/os-nosdn-kvm_ovs_dpdk_bar-ha/scenario.description.rst (limited to 'docs/release/scenarios') diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst deleted file mode 100644 index 7593434a..00000000 --- a/docs/release/scenarios/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) 2017 Intel Corporation and Others - -============================= -OPNFV Barometer Scenarios -============================= -.. This document will be used to provide a description of the scenario for an end user. -.. You should explain the purpose of the scenario, the types of capabilities provided and -.. the unique components that make up the scenario including how they are used. - -.. toctree:: - :maxdepth: 1 - - ./os-nosdn-bar-ha/scenario.description - ./os-nosdn-bar-noha/scenario.description diff --git a/docs/release/scenarios/os-nosdn-bar-ha/index.rst b/docs/release/scenarios/os-nosdn-bar-ha/index.rst deleted file mode 100644 index d1b18639..00000000 --- a/docs/release/scenarios/os-nosdn-bar-ha/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _os-nosdn-bar-ha: - -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -======================================== -os-nosdn-bar-ha overview and description -======================================== - -.. toctree:: - :numbered: - :maxdepth: 4 - - scenario.description.rst diff --git a/docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst b/docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst deleted file mode 100644 index 3f31ff0d..00000000 --- a/docs/release/scenarios/os-nosdn-bar-ha/scenario.description.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -=============================================== -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/index.rst b/docs/release/scenarios/os-nosdn-bar-noha/index.rst deleted file mode 100644 index 92851afa..00000000 --- a/docs/release/scenarios/os-nosdn-bar-noha/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _os-nosdn-bar-noha: - -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -========================================== -os-nosdn-bar-noha overview and description -========================================== - -.. toctree:: - :numbered: - :maxdepth: 4 - - scenario.description.rst diff --git a/docs/release/scenarios/os-nosdn-bar-noha/scenario.description.rst b/docs/release/scenarios/os-nosdn-bar-noha/scenario.description.rst deleted file mode 100644 index d6a1184a..00000000 --- a/docs/release/scenarios/os-nosdn-bar-noha/scenario.description.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -================================================= -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 ------------------ - - diff --git a/docs/release/scenarios/os-nosdn-kvm_ovs_dpdk_bar-ha/scenario.description.rst b/docs/release/scenarios/os-nosdn-kvm_ovs_dpdk_bar-ha/scenario.description.rst deleted file mode 100644 index f98a05ab..00000000 --- a/docs/release/scenarios/os-nosdn-kvm_ovs_dpdk_bar-ha/scenario.description.rst +++ /dev/null @@ -1,118 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -=================================== -OPNFV os-nosdn-kvm_ovs_dpdk_bar-ha -=================================== - -This document provides scenario level details for Danube of Barometer. - -.. contents:: - :depth: 3 - :local: - -Introduction ---------------- -.. In this section explain the purpose of the scenario and the types of -.. capabilities provided -This scenario combines the features from the following three projects in a -single instantiation of OPNFV: - -- KVM4NFV -- OVS4NFV -- Barometer - -A distinguishing factor for this scenario vs other scenarios that integrate -Open vSwitch and KVM is that collectd (a telemetry agent) is installed on -compute nodes so that their statistics and events can be relayed to ceilometer. -These are the first steps in paving the way for Platform (NFVI) Monitoring in -OPNFV. - -For Fuel this scenario installs the latest DPDK-enabled Open vSwitch component, -KVM4NFV latest software packages for Linux Kernel and QEMU patches for -achieving low latency, and the collectd telemetry agent. - -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 ha_nfv-kvm_ovs_bar_heat_ceilometer_scenario.yaml. -This yaml file contains following configurations and is passed as an -argument to deploy.py script - -* scenario.yaml:This configuration file defines translation between a - short deployment scenario name(os-nosdn-kvm_ovs_dpdk_bar-ha) and an actual - deployment scenario configuration file - (ha_nfv-kvm_nfv-ovs-dpdk_bar_heat_ceilometer_scenario.yaml) - -* deployment-scenario-metadata:Contains the configuration metadata like - title,version,created,comment. - -* stack-extensions:Stack extentions are opnfv added value features in form - of a fuel-plugin.Plugins listed in stack extensions are enabled and - configured. - -* dea-override-config: Used to configure the HA mode,network segmentation - types and role to node assignments. These configurations overrides - corresponding keys in the dea_base.yaml and dea_pod_override.yaml. - These keys are used to deploy multiple nodes(3 controllers,2 computes) - as mention below. - -* **Node 1**: This node has MongoDB and Controller roles. The controller - node runs the Identity service, Image Service, management portions of - Compute and Networking, Networking plug-in and the dashboard. The - Telemetry service which was designed to support billing systems for - OpenStack cloud resources uses a NoSQL database to store information. - The database typically runs on the controller node. - -* **Node 2**: This node has Controller and Ceph-osd roles. Ceph is a - massively scalable, open source, distributed storage system. It is - comprised of an object store, block store and a POSIX-compliant distributed - file system. Enabling Ceph, configures Nova to store ephemeral volumes in - RBD, configures Glance to use the Ceph RBD backend to store images, - configures Cinder to store volumes in Ceph RBD images and configures the - default number of object replicas in Ceph. - -* **Node 3**: This node has Controller role in order to achieve high - availability. - -* **Node 4**: This node has Compute role. The compute node runs the - hypervisor portion of Compute that operates tenant virtual machines - instances. By default, Compute uses KVM as the hypervisor. Collectd - will be installed on this node. - -* **Node 5**: This node has compute role. - -* dha-override-config:Provides information about the VM definition and - Network config for virtual deployment. These configurations overrides - the pod dha definition and points to the controller,compute and - fuel definition files. - -* os-nosdn-kvm_ovs_dpdk_bar-ha scenario is successful when all the 5 Nodes are - accessible, up and running. - -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 use of the scenario traffic on the private network will -automatically be processed by the upgraded DPDK datapath. - -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. - -References ------------------ - -For more information on the OPNFV Danube release, please visit -http://www.opnfv.org/danube - -- cgit 1.2.3-korg