diff options
Diffstat (limited to 'docs/scenarios')
12 files changed, 456 insertions, 260 deletions
diff --git a/docs/scenarios/abstract.rst b/docs/scenarios/abstract.rst new file mode 100644 index 000000000..1480f778d --- /dev/null +++ b/docs/scenarios/abstract.rst @@ -0,0 +1,42 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +***************** +Scenario Abstract +***************** +This chapter includes detailed explanation of various sceanrios files deployed as part +of kvmfornfv D-Release. + +Release Features +---------------- + ++------------------------------------------+------------------+-----------------+ +| **Scenario Name** | **Colorado** | **Danube** | +| | | | ++==========================================+==================+=================+ +| - os-nosdn-kvm-ha | ``Y`` | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk-noha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk-ha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk_bar-noha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ +| - os-nosdn-kvm_nfv_ovs_dpdk_bar-ha | | ``Y`` | ++------------------------------------------+------------------+-----------------+ + +D- Release Scenario's overview +------------------------------- + ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| **Scenario Name** | **No of Controllers** | **No of Computes** | **Plugin Names** | **DPDK** | **OVS** | +| | | | | | | ++==========================================+=======================+=====================+==================+==========+==========+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk-noha`` | 1 | 3 | KVM | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk-ha`` | 3 | 2 | KVM | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk_bar-noha`` | 1 | 3 | KVM & BAR | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk_bar-ha`` | 3 | 2 | KVM & BAR | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ diff --git a/docs/scenarios/index.rst b/docs/scenarios/index.rst index 5f41fd414..6c3ed1dea 100644 --- a/docs/scenarios/index.rst +++ b/docs/scenarios/index.rst @@ -1,12 +1,58 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -**************************************** -os-nosdn-kvm-ha Overview and Description -**************************************** +********************************* +Scenario Overview and Description +********************************* .. toctree:: + :caption: Scenario Overview and Description :numbered: :maxdepth: 4 + ./abstract.rst ./kvmfornfv.scenarios.description.rst + +******************************************************* +os-nosdn-kvm_nfv_ovs_dpdk-noha Overview and Description +******************************************************* + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk-noha + :numbered: + :maxdepth: 3 + + ./os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst + +***************************************************** +os-nosdn-kvm_nfv_ovs_dpdk-ha Overview and Description +***************************************************** + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk-ha + :numbered: + :maxdepth: 3 + + ./os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst + +*********************************************************** +os-nosdn-kvm_nfv_ovs_dpdk_bar-noha Overview and Description +*********************************************************** + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk_bar-noha + :numbered: + :maxdepth: 3 + + ./os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst + +********************************************************* +os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Overview and Description +********************************************************* + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk_bar-ha + :numbered: + :maxdepth: 3 + + ./os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst diff --git a/docs/scenarios/kvmfornfv.scenarios.description.rst b/docs/scenarios/kvmfornfv.scenarios.description.rst index 459852d53..c7715b252 100644 --- a/docs/scenarios/kvmfornfv.scenarios.description.rst +++ b/docs/scenarios/kvmfornfv.scenarios.description.rst @@ -1,19 +1,20 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -======================== -KVM4NFV SCENARIO-TESTING -======================== -ABSTRACT -======== +============================== +KVMFORNFV Scenario-Description +============================== -This document describes the procedure to deploy/test KVM4NFV scenario in a nested virtualization -environment in a single system. This has been verified with os-nosdn-kvm-ha, os-nosdn-kvm-noha, -os-nosdn-kvm_ovs_dpdk-ha, os-nosdn-kvm_ovs_dpdk-noha and os-nosdn-kvm_ovs_dpdk_bar-ha test scenario. +Abstract +-------- + +This document describes the procedure to deploy/test KVM4NFV scenarios in a nested virtualization +environment. This has been verified with os-nosdn-kvm-ha, os-nosdn-kvm-noha,os-nosdn-kvm_ovs_dpdk-ha, +os-nosdn-kvm_ovs_dpdk-noha and os-nosdn-kvm_ovs_dpdk_bar-ha test scenarios. Version Features -================ +---------------- +-----------------------------+---------------------------------------------+ | | | @@ -24,29 +25,43 @@ Version Features | Colorado | the Colorado release of KVMFORNFV | | | | +-----------------------------+---------------------------------------------+ -| | - High Availability deployment and | -| | configuration of KVMFORNFV software suite | -| Danube | - Multi-node setup with 3 controllers and | -| | 2 computes nodes are deployed | -| | - Scenarios os-nosdn-kvm_ovs_dpdk-ha and | -| | os-nosdn-kvm_ovs_dpdk_bar-ha are supported| -| | | +| | - High Availability/No-High Availability | +| | deployment configuration of KVMFORNFV | +| | software suite | +| Danube | - Multi-node setup with 3 controller and | +| | 2 compute nodes are deployed for HA | +| | - Multi-node setup with 1 controller and | +| | 3 compute nodes are deployed for NO-HA | +| | - Scenarios os-nosdn-kvm_ovs_dpdk-ha, | +| | os-nosdn-kvm_ovs_dpdk_bar-ha, | +| | os-nosdn-kvm_ovs_dpdk-noha, | +| | os-nosdn-kvm_ovs_dpdk_bar-noha | +| | are supported | +-----------------------------+---------------------------------------------+ -INTRODUCTION -============ -The purpose of os-nosdn-kvm_ovs_dpdk-ha and os-nosdn-kvm_ovs_dpdk_bar-ha scenario testing is to -test the High Availability deployment and configuration of OPNFV software suite with OpenStack and -without SDN software. This OPNFV software suite includes OPNFV KVMFORNFV latest software packages +Introduction +------------ +The purpose of os-nosdn-kvm_ovs_dpdk-ha,os-nosdn-kvm_ovs_dpdk_bar-ha and +os-nosdn-kvm_ovs_dpdk-noha,os-nosdn-kvm_ovs_dpdk_bar-noha scenarios testing is to +test the High Availability/No-High Availability deployment and configuration of +OPNFV software suite with OpenStack and without SDN software. + +This OPNFV software suite includes OPNFV KVMFORNFV latest software packages for Linux Kernel and QEMU patches for achieving low latency and also OPNFV Barometer for traffic, -performance and platform monitoring. High Availability feature is achieved by deploying OpenStack +performance and platform monitoring. + +High Availability feature is achieved by deploying OpenStack multi-node setup with 1 Fuel-Master,3 controllers and 2 computes nodes. -KVMFORNFV packages will be installed on compute nodes as part of deployment. The scenario testcase deploys a multi-node setup by using OPNFV Fuel deployer. +No-High Availability feature is achieved by deploying OpenStack +multi-node setup with 1 Fuel-Master,1 controllers and 3 computes nodes. + +KVMFORNFV packages will be installed on compute nodes as part of deployment. +The scenario testcase deploys a multi-node setup by using OPNFV Fuel deployer. -1. System pre-requisites ------------------------- +System pre-requisites +--------------------- - RAM - Minimum 16GB - HARD DISK - Minimum 500GB @@ -83,12 +98,14 @@ If Nested virtualization is disabled, enable it by, EOF $ sudo reboot -2. Environment Setup --------------------- +Environment Setup +----------------- -**2.1 Configure apt.conf in /etc/apt** +**Configuring Proxy** +~~~~~~~~~~~~~~~~~~~~~ -Create an apt.conf file in /etc/apt if it doesn't exist. Used to set proxy for apt-get if workin behind a proxy server. +For **Ubuntu**., +Create an apt.conf file in /etc/apt if it doesn't exist. Used to set proxy for apt-get if working behind a proxy server. .. code:: bash @@ -97,7 +114,15 @@ Create an apt.conf file in /etc/apt if it doesn't exist. Used to set proxy for a Acquire::ftp::proxy "ftp://<username>:<password>@<proxy>:<port>/"; Acquire::socks::proxy "socks://<username>:<password>@<proxy>:<port>/"; -**2.2 Network Time Protocol (NTP) setup and configuration** +For **CentOS**., +Edit /etc/yum.conf to work behind a proxy server by adding the below line. + +.. code:: bash + + $ echo "proxy=http://<username>:<password>@<proxy>:<port>/" >> /etc/yum.conf + +**Network Time Protocol (NTP) setup and configuration** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Install ntp by: @@ -110,67 +135,81 @@ Insert the following two lines after “server ntp.ubuntu.com” line and befor .. _link: /usr/share/doc/ntp-doc/html/accopt.html -server 127.127.1.0 -fudge 127.127.1.0 stratum 10 +.. code:: bash + + server 127.127.1.0 + fudge 127.127.1.0 stratum 10 -Restart the ntp server +Restart the ntp server to apply the changes .. code:: bash $ sudo service ntp restart -3. Scenario Testing -------------------- +Scenario Testing +---------------- There are three ways of performing scenario testing, - - 3.1 Fuel - - 3.2 OPNFV-Playground - - 3.3 Jenkins Project + - 1 Fuel + - 2 OPNFV-Playground + - 3 Jenkins Project -3.1 Fuel -~~~~~~~~~ +Fuel +~~~~ -**3.1.1 Clone the fuel repo :** +**1 Clone the fuel repo :** .. code:: bash - git clone https://gerrit.opnfv.org/gerrit/fuel.git + $ git clone https://gerrit.opnfv.org/gerrit/fuel.git + +**2 Checkout to the specific version of the branch to deploy by:** -**3.1.2 Checkout to the specific version of the branch to deploy by:** +The default branch is master, to use a stable release-version use the below., .. code:: bash + To check the current branch + $ git branch - git checkout stable/Colorado + To check out a specific branch + $ git checkout stable/Colorado -**3.1.3 Building the Fuel iso :** +**3 Building the Fuel iso :** .. code:: bash $ cd ~/fuel/ci/ $ ./build.sh -h -Provides the necessary options that are required to build an iso. Creates a ``customized iso`` as per the deployment needs. +Provide the necessary options that are required to build an iso. +Create a ``customized iso`` as per the deployment needs. .. code:: bash $ cd ~/fuel/build/ $ make - (OR) Other way is to download the latest stable fuel iso from `here`_. +(OR) Other way is to download the latest stable fuel iso from `here`_. -.. _here: http://artifacts.opnfv.org/fuel/colorado/opnfv-colorado.3.0.iso +.. _here: http://artifacts.opnfv.org/fuel.html -**3.1.4 Creating a new deployment scenario** +.. code:: bash + + http://artifacts.opnfv.org/fuel.html -``(i). Naming the scenario file:`` +**4 Creating a new deployment scenario** -Include the new deployment scenario yaml file in deploy/scenario/. The file name should adhere to the following format : +``(i). Naming the scenario file`` + +Include the new deployment scenario yaml file in ~/fuel/deploy/scenario/. The file name should adhere to the following format: .. code:: bash <ha | no-ha>_<SDN Controller>_<feature-1>_..._<feature-n>.yaml -``(ii). The deployment configuration file should contain configuration metadata as stated below:`` +``(ii). Meta data`` + +The deployment configuration file should contain configuration metadata as stated below: .. code:: bash @@ -179,7 +218,9 @@ Include the new deployment scenario yaml file in deploy/scenario/. The file name version: created: -``(iii). To include fuel plugins in the deployment configuration file, use the “stack-extentions” key:`` +``(iii). “stack-extentions” Module`` + +To include fuel plugins in the deployment configuration file, use the “stack-extentions” key: .. code:: bash @@ -191,13 +232,15 @@ Include the new deployment scenario yaml file in deploy/scenario/. The file name module-config-override: #module-config overrides - +**Note:** The “module-config-name” and “module-config-version” should be same as the name of plugin configuration file. +The “module-config-override” is used to configure the plugin by overrriding the corresponding keys in +the plugin config yaml file present in ~/fuel/deploy/config/plugins/. -The “module-config-override” is used to configure the plugin by overrriding the corresponding keys in the plugin config yaml file present in ~/fuel/deploy/config/plugins/. +``(iv). “dea-override-config” Module`` -``(iv). To configure the HA/No-Ha mode, network segmentation types and role to node assignments, use the “dea-override-config” key.`` +To configure the HA/No-HA mode, network segmentation types and role to node assignments, use the “dea-override-config” key. .. code:: bash @@ -244,12 +287,14 @@ Under the “dea-override-config” should provide atleast {environment:{mode:'v and {nodes:1,2,...} and can also enable additional stack features such ceph,heat which overrides corresponding keys in the dea_base.yaml and dea_pod_override.yaml. -``(v). In order to configure the pod dha definition, use the “dha-override-config” key.`` +``(v). “dha-override-config” Module`` -The “dha-override-config” key is an optional key present at the ending of the scenario file. +In order to configure the pod dha definition, use the “dha-override-config” key. +This is an optional key present at the ending of the scenario file. -``(vi). The scenario.yaml file is used to map the short names of scenario's to the one or more deployment scenario configuration yaml files.`` +``(vi). Mapping to short scenario name`` +The scenario.yaml file is used to map the short names of scenario's to the one or more deployment scenario configuration yaml files. The short scenario names should follow the scheme below: .. code:: bash @@ -259,7 +304,7 @@ The short scenario names should follow the scheme below: [os]: mandatory possible value: os -please note that this field is needed in order to select parent jobs to list and do blocking relations between them. +Please note that this field is needed in order to select parent jobs to list and do blocking relations between them. .. code:: bash @@ -272,8 +317,8 @@ please note that this field is needed in order to select parent jobs to list and [option]: optional -used for the scenarios those do not fit into naming scheme. -optional field in the short scenario name should not be included if there is no optional scenario. +Used for the scenarios those do not fit into naming scheme. +Optional field in the short scenario name should not be included if there is no optional scenario. .. code:: bash @@ -295,30 +340,37 @@ Note: - ( _ ) used to separate the values belong to the same field. [os-nosdn-kvm_ovs_bar-ha]. -**3.1.5 Deploying the scenario** - +**5 Deploying the scenario** Command to deploy the os-nosdn-kvm_ovs_dpdk-ha scenario: .. code:: bash $ cd ~/fuel/ci/ - $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s no-ha_nfv-kvm_nfv-ovsdpdk_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso + $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso where, - -b is used to specify the configuration directory + ``-b`` is used to specify the configuration directory - -i is used to specify the image downloaded from artifacts. + ``-f`` is used to re-deploy on the existing deployment -Note: + ``-i`` is used to specify the image downloaded from artifacts. + + ``-l`` is used to specify the lab name + + ``-p`` is used to specify POD name + + ``-s`` is used to specify the scenario file + +**Note:** .. code:: bash Check $ sudo ./deploy.sh -h for further information. -3.2 OPNFV-Playground -~~~~~~~~~~~~~~~~~~~~ +OPNFV-Playground +~~~~~~~~~~~~~~~~ Install OPNFV-playground (the tool chain to deploy/test CI scenarios in fuel@opnfv, ): @@ -337,17 +389,20 @@ Install OPNFV-playground (the tool chain to deploy/test CI scenarios in fuel@opn -``3.2.1 Downgrade paramiko package from 2.x.x to 1.10.0`` +``1 Downgrade paramiko package from 2.x.x to 1.10.0`` The paramiko package 2.x.x doesn’t work with OPNFV-playground tool chain now, Jira ticket FUEL - 188 has been raised for the same. Check paramiko package version by following below steps in your system: -$ python -Python 2.7.6 (default, Jun 22 2015, 17:58:13) [GCC 4.8.2] on linux2 Type "help", "copyright", "credits" or "license" for more information. ->>> import paramiko ->>> print paramiko.__version__ ->>> exit() +.. code:: bash + + $ python + Python 2.7.6 (default, Jun 22 2015, 17:58:13) [GCC 4.8.2] on linux2 Type "help", "copyright", "credits" or "license" for more information. + + >>> import paramiko + >>> print paramiko.__version__ + >>> exit() You will get the current paramiko package version, if it is 2.x.x, uninstall this version by @@ -372,7 +427,7 @@ Verify it by following: >>> exit() -``3.2.2 Clone the fuel@opnfv`` +``2 Clone the fuel@opnfv`` Check out the specific version of specific branch of fuel@opnfv @@ -381,16 +436,17 @@ Check out the specific version of specific branch of fuel@opnfv $ cd ~ $ git clone https://gerrit.opnfv.org/gerrit/fuel.git $ cd fuel - $ git checkout stable/Colorado + By default it will be master branch, in-order to deploy on the Colorado/Danube branch, do: + $ git checkout stable/Danube -``3.2.3 Creating the scenario`` +``3 Creating the scenario`` Implement the scenario file as described in 3.1.4 -``3.2.4 Deploying the scenario`` +``4 Deploying the scenario`` -You can use the following command to start to deploy/test os-nosdn kvm_ovs_dpdk-noha and os-nosdn-kvm_ovs_dpdk-ha scenario +You can use the following command to deploy/test os-nosdn kvm_ovs_dpdk-(no)ha and os-nosdn-kvm_ovs_dpdk_bar-(no)ha scenario .. code:: bash @@ -409,7 +465,7 @@ For os-nosdn-kvm_ovs_dpdk_bar-ha: $ ./ci_pipeline.sh -r ~/fuel -i /root/fuel.iso -B -n intel-sc -s os-nosdn-kvm_ovs_dpdk_bar-ha The “ci_pipeline.sh” first clones the local fuel repo, then deploys the -os-nosdn-kvm_ovs_dpdk-ha/os-nosdn-kvm_ovs_dpdk-noha scenario from the given ISO, and run Func test +os-nosdn-kvm_ovs_dpdk-ha/os-nosdn-kvm_ovs_dpdk_bar-ha scenario from the given ISO, and run Functest and Yarstick test. The log of the deployment/test (ci.log) can be found in ~/OPNFV-Playground/ci_fuel_opnfv/artifact/master/YYYY-MM-DD—HH.mm, where YYYY-MM-DD—HH.mm is the date/time you start the “ci_pipeline.sh”. @@ -421,10 +477,15 @@ Note: Check $ ./ci_pipeline.sh -h for further information. -3.3 Jenkins Project -~~~~~~~~~~~~~~~~~~~ +Jenkins Project +~~~~~~~~~~~~~~~ -os-nosdn-kvm_ovs_dpdk-ha and os-nosdn-kvm_ovs_dpdk_bar-ha scenario can be executed from the jenkins project : +os-nosdn-kvm_ovs_dpdk-(no)ha and os-nosdn-kvm_ovs_dpdk_bar-(no)ha scenario can be executed from the jenkins project : + ``HA scenarios:`` 1. "fuel-os-nosdn-kvm_ovs_dpdk-ha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk-ha) 2. "fuel-os-nosdn-kvm_ovs_dpdk_bar-ha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk_bar-ha) + + ``NOHA scenarios:`` + 1. "fuel-os-nosdn-kvm_ovs_dpdk-noha-virtual-daily-master" (os-nosdn-kvm_ovs_dpdk-noha) + 2. "fuel-os-nosdn-kvm_ovs_dpdk_bar-noha-virtual-daily-master" (os-nosdn-kvm_ovs_dpdk_bar-noha) diff --git a/docs/scenarios/os-nosdn-kvm-ha/os-nosdn-kvm-ha.description.rst b/docs/scenarios/os-nosdn-kvm-ha/os-nosdn-kvm-ha.description.rst index 9d8285831..f64f26ffc 100644 --- a/docs/scenarios/os-nosdn-kvm-ha/os-nosdn-kvm-ha.description.rst +++ b/docs/scenarios/os-nosdn-kvm-ha/os-nosdn-kvm-ha.description.rst @@ -2,9 +2,12 @@ .. http://creativecommons.org/licenses/by/4.0 +============================ +os-nosdn-kvm-ha Description +============================ Introduction -============ +------------- .. In this section explain the purpose of the scenario and the types of capabilities provided @@ -21,7 +24,7 @@ This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. 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. @@ -31,18 +34,18 @@ configurations provided in ha_nfv-kvm_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 +* ``scenario.yaml:`` This configuration file defines translation between a short deployment scenario name(os-nosdn-kvm-ha) and an actual deployment scenario configuration file(ha_nfv-kvm_heat_ceilometer_scenario.yaml) -* deployment-scenario-metadata:Contains the configuration metadata like +* ``deployment-scenario-metadata:`` Contains the configuration metadata like title,version,created,comment. -* stack-extensions:Stack extentions are opnfv added value features in form +* ``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 +* ``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) @@ -72,7 +75,7 @@ argument to deploy.py script * **Node 5**: This node has compute role. -* dha-override-config:Provides information about the VM definition and +* ``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. @@ -81,7 +84,7 @@ argument to deploy.py script 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 @@ -93,6 +96,8 @@ Scenario Usage Overview -Example: +.. code:: bash + sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr -log ~/Deployment-888.log.tar.gz * Install Fuel Master and deploy OPNFV Cloud from scratch on Virtual @@ -100,6 +105,8 @@ Scenario Usage Overview -Example: +.. code:: bash + sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images -log ~/Deployment-888.log.tar.gz * os-nosdn-kvm-ha scenario can be executed from the jenkins project @@ -112,7 +119,7 @@ Scenario Usage Overview * Observed that scenario is not running any testcase on top of deployment. Known Limitations, Issues and Workarounds -========================================= +----------------------------------------- .. Explain any known limitations here. * Test scenario os-nosdn-kvm-ha result is not stable. After node reboot @@ -120,7 +127,7 @@ Known Limitations, Issues and Workarounds responding with in the given time. References -========== +---------- For more information on the OPNFV Danube release, please visit http://www.opnfv.org/danube diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst index 5582f46c7..28f588e54 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst @@ -1,12 +1,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -**************************************** -os-nosdn-kvm-ha Overview and Description -**************************************** +***************************************************** +os-nosdn-kvm_nfv_ovs_dpdk-ha Overview and Description +***************************************************** .. toctree:: :numbered: :maxdepth: 3 - os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst + ./os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst index 40b9748af..a96130cad 100644 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst @@ -2,9 +2,12 @@ .. http://creativecommons.org/licenses/by/4.0 +========================================= +os-nosdn-kvm_nfv_ovs_dpdk-ha Description +========================================= Introduction -============ +------------ .. In this section explain the purpose of the scenario and the types of capabilities provided @@ -16,10 +19,11 @@ includes OPNFV KVM4NFV latest software packages for Linux Kernel and QEMU patches for achieving low latency. High Availability feature is achieved by deploying OpenStack multi-node setup with 3 controllers and 2 computes nodes. -KVM4NFV packages will be installed on compute nodes as part of deployment. This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. +KVM4NFV packages will be installed on compute nodes as part of deployment. +This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. 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. @@ -29,7 +33,7 @@ configurations provided in ha_nfv-kvm_nfv-ovs-dpdk_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 +* ``scenario.yaml:`` This configuration file defines translation between a short deployment scenario name(os-nosdn-kvm_ovs_dpdk-ha) and an actual deployment scenario configuration file(ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml) @@ -63,29 +67,34 @@ argument to deploy.py script 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 - or instances. By default, Compute uses KVM as the hypervisor. - - * **Node 5**: This node has compute role. + * **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 + - Uses VLAN as an interface + + * **Node 2**: + - This node has Ceph-osd and Controller roles + - The controller node runs the Identity service, Image Service, management portions of + Compute and Networking, Networking plug-in and the dashboard + - Ceph is a massively scalable, open source, distributed storage system + - Uses VLAN as an interface + + * **Node 3**: + - This node has Controller role in order to achieve high availability. + - Uses VLAN as an interface + + * **Node 4**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface + + * **Node 5**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface The below is the ``dea-override-config`` of the ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml file. @@ -177,17 +186,18 @@ argument to deploy.py script * os-nosdn-kvm_ovs_dpdk-ha scenario is successful when all the 5 Nodes are accessible, up and running. - - **Note:** * In os-nosdn-kvm_ovs_dpdk-ha scenario, OVS is installed on the compute nodes with DPDK configured -* This results in faster communication and data transfer among the compute nodes +* Hugepages for DPDK are configured in the attributes_1 section of the no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml + +* Hugepages are only configured for compute nodes +* This results in faster communication and data transfer among the compute 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 @@ -210,7 +220,7 @@ where, -i is used to specify the image downloaded from artifacts. -Note: +**Note:** .. code:: bash @@ -225,16 +235,13 @@ Note: accessibility (IP , up & running). Known Limitations, Issues and Workarounds -========================================= +----------------------------------------- .. Explain any known limitations here. * Test scenario os-nosdn-kvm_ovs_dpdk-ha result is not stable. -* As Functest and Yardstick test suites are not stable. Instances are not getting IP address from DHCP (functest issue). - - References -========== +---------- For more information on the OPNFV Danube release, please visit http://www.opnfv.org/Danube diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst index 9d60465d6..3a52fe426 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst @@ -1,12 +1,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -**************************************** -os-nosdn-kvm-ha Overview and Description -**************************************** +******************************************************* +os-nosdn-kvm_nfv_ovs_dpdk-noha Overview and Description +******************************************************* .. toctree:: :numbered: :maxdepth: 3 - os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst + ./os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst index 3e354b5b9..a7778d963 100644 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst @@ -2,36 +2,40 @@ .. http://creativecommons.org/licenses/by/4.0 +========================================== +os-nosdn-kvm_nfv_ovs_dpdk-noha Description +========================================== Introduction -============ +------------ .. In this section explain the purpose of the scenario and the types of capabilities provided -The purpose of os-nosdn-kvm_ovs_dpdk-noha scenario testing is to test the +The purpose of os-nosdn-kvm_ovs_dpdk-noha scenario testing is to test the No High Availability deployment and configuration of OPNFV software suite with OpenStack and without SDN software. This OPNFV software suite includes OPNFV KVM4NFV latest software packages for Linux Kernel and -QEMU patches for achieving low latency. High Availability feature is achieved -by deploying OpenStack multi-node setup with 3 controllers and 2 computes nodes. +QEMU patches for achieving low latency. No High Availability feature is achieved +by deploying OpenStack multi-node setup with 1 controller and 3 computes nodes. -KVM4NFV packages will be installed on compute nodes as part of deployment. This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. +KVM4NFV packages will be installed on compute nodes as part of deployment. +This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. 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 noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml. +This scenario deploys the No High Availability OPNFV Cloud based on the +configurations provided in no-ha_nfv-kvm_nfv-ovs-dpdk_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 +* ``scenario.yaml:`` This configuration file defines translation between a short deployment scenario name(os-nosdn-kvm_ovs_dpdk-noha) and an actual deployment - scenario configuration file(noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml) + scenario configuration file(no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml) * ``deployment-scenario-metadata:`` Contains the configuration metadata like title,version,created,comment. @@ -57,35 +61,37 @@ argument to deploy.py script module-config-override: # Module config overrides -* ``dea-override-config:`` Used to configure the HA mode,network segmentation +* ``dea-override-config:`` Used to configure the NO-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(``1 controller,3 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 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 + - Uses VLAN as an interface - * **Node 2**: This node has compute 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 - 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 2**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface - * **Node 3**: This node has Compute role in order to achieve high - availability. + * **Node 3**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface - * **Node 4**: This node has Compute role. The compute node runs the - hypervisor portion of Compute that operates tenant virtual machines - or instances. By default, Compute uses KVM as the hypervisor. + * **Node 4**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface - The below is the ``dea-override-config`` of the noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml file. + The below is the ``dea-override-config`` of the no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml file. .. code:: bash @@ -162,7 +168,8 @@ argument to deploy.py script * ``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. The noha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml has no dha-config changes i.e., default configuration is used. + fuel definition files. The no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml + has no dha-config changes i.e., default configuration is used. * os-nosdn-kvm_ovs_dpdk-noha scenario is successful when all the 4 Nodes are accessible, up and running. @@ -173,11 +180,16 @@ argument to deploy.py script * In os-nosdn-kvm_ovs_dpdk-noha scenario, OVS is installed on the compute nodes with DPDK configured +* Hugepages for DPDK are configured in the attributes_1 section of the no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml + +* Hugepages are only configured for compute nodes + * This results in faster communication and data transfer among the compute 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 @@ -200,7 +212,7 @@ where, -i is used to specify the image downloaded from artifacts. -Note: +**Note:** .. code:: bash @@ -208,20 +220,20 @@ Note: * os-nosdn-kvm_ovs_dpdk-noha scenario can be executed from the jenkins project "fuel-os-nosdn-kvm_ovs_dpdk-noha-baremetal-daily-master" -* This scenario provides the High Availability feature by deploying - 3 controller,2 compute nodes and checking if all the 5 nodes +* This scenario provides the No High Availability feature by deploying + 1 controller,3 compute nodes and checking if all the 4 nodes are accessible(IP,up & running). -* Test Scenario is passed if deployment is successful and all 5 nodes have +* Test Scenario is passed if deployment is successful and all 4 nodes have accessibility (IP , up & running). Known Limitations, Issues and Workarounds -========================================= +----------------------------------------- .. Explain any known limitations here. * Test scenario os-nosdn-kvm_ovs_dpdk-noha result is not stable. References -========== +---------- For more information on the OPNFV Danube release, please visit http://www.opnfv.org/Danube diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst index 5fccc5a2c..0e374a5ca 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst @@ -1,12 +1,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -**************************************** -os-nosdn-kvm-ha Overview and Description -**************************************** +********************************************************* +os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Overview and Description +********************************************************* .. toctree:: :numbered: :maxdepth: 3 - os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst + ./os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst index 7090ccdd6..0ab20514a 100644 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst @@ -2,9 +2,12 @@ .. http://creativecommons.org/licenses/by/4.0 +============================================ +os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Description +============================================ Introduction -============ +------------ .. In this section explain the purpose of the scenario and the types of capabilities provided @@ -16,10 +19,12 @@ includes OPNFV KVM4NFV latest software packages for Linux Kernel and QEMU patches for achieving low latency. High Availability feature is achieved by deploying OpenStack multi-node setup with 3 controllers and 2 computes nodes. -KVM4NFV packages will be installed on compute nodes as part of deployment. This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. +OPNFV Barometer packages is used for traffic,performance and platform monitoring. +KVM4NFV packages will be installed on compute nodes as part of deployment. +This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. 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. @@ -29,7 +34,7 @@ configurations provided in ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario. 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 +* ``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) @@ -69,29 +74,34 @@ argument to deploy.py script 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 - or instances. By default, Compute uses KVM as the hypervisor. - - * **Node 5**: This node has compute role. + * **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 + - Uses VLAN as an interface + + * **Node 2**: + - This node has Ceph-osd and Controller roles + - The controller node runs the Identity service, Image Service, management portions of + Compute and Networking, Networking plug-in and the dashboard + - Ceph is a massively scalable, open source, distributed storage system + - Uses VLAN as an interface + + * **Node 3**: + - This node has Controller role in order to achieve high availability. + - Uses VLAN as an interface + + * **Node 4**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface + + * **Node 5**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface The below is the ``dea-override-config`` of the ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml file. @@ -189,11 +199,15 @@ argument to deploy.py script * Baraometer plugin is also implemented along with KVM plugin +* Hugepages for DPDK are configured in the attributes_1 section of the no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml + +* Hugepages are only configured for compute nodes + * This results in faster communication and data transfer among the compute 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 @@ -209,14 +223,14 @@ Command to deploy the os-nosdn-kvm_ovs_dpdk_bar-ha scenario: .. code:: bash $ cd ~/fuel/ci/ - $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso + $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso where, -b is used to specify the configuration directory -i is used to specify the image downloaded from artifacts. -Note: +**Note:** .. code:: bash @@ -231,16 +245,13 @@ Note: accessibility (IP , up & running). Known Limitations, Issues and Workarounds -========================================= +----------------------------------------- .. Explain any known limitations here. * Test scenario os-nosdn-kvm_ovs_dpdk_bar-ha result is not stable. -* As Functest and Yardstick test suites are not stable. Instances are not getting IP address from DHCP (functest issue). - - References -========== +---------- For more information on the OPNFV Danube release, please visit http://www.opnfv.org/Danube diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst index 1cdad5205..756b2ba6a 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst @@ -1,12 +1,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -**************************************** -os-nosdn-kvm-ha Overview and Description -**************************************** +*********************************************************** +os-nosdn-kvm_nfv_ovs_dpdk_bar-noha Overview and Description +*********************************************************** .. toctree:: :numbered: :maxdepth: 3 - os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst + ./os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst index 67a0732a7..47a7f1034 100644 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst @@ -2,36 +2,41 @@ .. http://creativecommons.org/licenses/by/4.0 +============================================ +os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Description +============================================ Introduction -============ +------------- .. In this section explain the purpose of the scenario and the types of capabilities provided The purpose of os-nosdn-kvm_ovs_dpdk_bar-noha scenario testing is to test the -High Availability deployment and configuration of OPNFV software suite +No High Availability deployment and configuration of OPNFV software suite with OpenStack and without SDN software. This OPNFV software suite includes OPNFV KVM4NFV latest software packages for Linux Kernel and -QEMU patches for achieving low latency. High Availability feature is achieved -by deploying OpenStack multi-node setup with 3 controllers and 2 computes nodes. +QEMU patches for achieving low latency.No High Availability feature is achieved +by deploying OpenStack multi-node setup with 1 controller and 3 computes nodes. -KVM4NFV packages will be installed on compute nodes as part of deployment. This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. +OPNFV Barometer packages is used for traffic,performance and platform monitoring. +KVM4NFV packages will be installed on compute nodes as part of deployment. +This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer. 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 noha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml. +This scenario deploys the No High Availability OPNFV Cloud based on the +configurations provided in no-ha_nfv-kvm_nfv-ovs-dpdk-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 +* ``scenario.yaml:`` This configuration file defines translation between a short deployment scenario name(os-nosdn-kvm_ovs_dpdk_bar-noha) and an actual deployment - scenario configuration file(noha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml) + scenario configuration file(no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml) * ``deployment-scenario-metadata:`` Contains the configuration metadata like title,version,created,comment. @@ -68,29 +73,31 @@ argument to deploy.py script These keys are used to deploy multiple nodes(``1 controller,3 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 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 + - Uses VLAN as an interface - * **Node 2**: This node has compute 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 - 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 2**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface - * **Node 3**: This node has Compute role in order to achieve high - availability. + * **Node 3**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface - * **Node 4**: This node has Compute role. The compute node runs the - hypervisor portion of Compute that operates tenant virtual machines - or instances. By default, Compute uses KVM as the hypervisor. + * **Node 4**: + - This node has compute and Ceph-osd roles + - Ceph is a massively scalable, open source, distributed storage system + - By default, Compute uses KVM as the hypervisor + - Uses DPDK as an interface - The below is the ``dea-override-config`` of the noha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml file. + The below is the ``dea-override-config`` of the no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml file. .. code:: bash @@ -180,11 +187,14 @@ argument to deploy.py script * Baraometer plugin is also implemented along with KVM plugin. -* This results in faster communication and data transfer among the compute nodes +* Hugepages for DPDK are configured in the attributes_1 section of the no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml + +* Hugepages are only configured for compute nodes +* This results in faster communication and data transfer among the compute 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 @@ -215,20 +225,20 @@ Note: * os-nosdn-kvm_ovs_dpdk_bar-noha scenario can be executed from the jenkins project "fuel-os-nosdn-kvm_ovs_dpdk_bar-noha-baremetal-daily-master" -* This scenario provides the High Availability feature by deploying - 3 controller,2 compute nodes and checking if all the 5 nodes +* This scenario provides the No High Availability feature by deploying + 1 controller,3 compute nodes and checking if all the 4 nodes are accessible(IP,up & running). -* Test Scenario is passed if deployment is successful and all 5 nodes have +* Test Scenario is passed if deployment is successful and all 4 nodes have accessibility (IP , up & running). Known Limitations, Issues and Workarounds -========================================= +----------------------------------------- .. Explain any known limitations here. * Test scenario os-nosdn-kvm_ovs_dpdk_bar-noha result is not stable. References -========== +---------- For more information on the OPNFV Danube release, please visit http://www.opnfv.org/Danube |