To update the documentation for E-release
[kvmfornfv.git] / docs / release / scenarios / os-nosdn-kvm_ovs_dpdk_bar-noha / os-nosdn-kvm_ovs_dpdk_bar-noha.description.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. http://creativecommons.org/licenses/by/4.0
4
5 ============================================
6 os-nosdn-kvm_ovs_dpdk_bar-ha Description
7 ============================================
8
9 Introduction
10 -------------
11
12 .. In this section explain the purpose of the scenario and the
13    types of capabilities provided
14
15 The purpose of os-nosdn-kvm_ovs_dpdk_bar-noha scenario testing is to test the
16 No High Availability deployment and configuration of OPNFV software suite
17 with OpenStack and without SDN software. This OPNFV software suite
18 includes OPNFV KVM4NFV latest software packages for Linux Kernel and
19 QEMU patches for achieving low latency.No High Availability feature is achieved
20 by deploying OpenStack multi-node setup with 1 controller and 3 computes nodes.
21
22 OPNFV Barometer packages is used for traffic,performance and platform monitoring.
23 KVM4NFV packages will be installed on compute nodes as part of deployment.
24 This scenario testcase deployment is happening on multi-node by using OPNFV Fuel deployer.
25
26 Scenario Components and Composition
27 ------------------------------------
28 .. In this section describe the unique components that make up the scenario,
29 .. what each component provides and why it has been included in order
30 .. to communicate to the user the capabilities available in this scenario.
31
32 This scenario deploys the No High Availability OPNFV Cloud based on the
33 configurations provided in no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml.
34 This yaml file contains following configurations and is passed as an
35 argument to deploy.py script
36
37 * ``scenario.yaml:`` This configuration file defines translation between a
38   short deployment scenario name(os-nosdn-kvm_ovs_dpdk_bar-noha) and an actual deployment
39   scenario configuration file(no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml)
40
41 * ``deployment-scenario-metadata:`` Contains the configuration metadata like
42   title,version,created,comment.
43
44 .. code:: bash
45
46    deployment-scenario-metadata:
47       title: NFV KVM and OVS-DPDK HA deployment
48       version: 0.0.1
49       created: Dec 20 2016
50       comment: NFV KVM and OVS-DPDK
51
52 * ``stack-extensions:`` Stack extentions are opnfv added value features in form
53   of a fuel-plugin.Plugins listed in stack extensions are enabled and
54   configured. os-nosdn-kvm_ovs_dpdk_bar-noha scenario currently uses KVM-1.0.0 plugin and
55   barometer-1.0.0 plugin.
56
57 .. code:: bash
58
59   stack-extensions:
60      - module: fuel-plugin-kvm
61        module-config-name: fuel-nfvkvm
62        module-config-version: 1.0.0
63        module-config-override:
64         # Module config overrides
65      - module: fuel-plugin-collectd-ceilometer
66        module-config-name: fuel-barometer
67        module-config-version: 1.0.0
68        module-config-override:
69          # Module config overrides
70
71 * ``dea-override-config:`` Used to configure the HA mode,network segmentation
72   types and role to node assignments.These configurations overrides
73   corresponding keys in the dea_base.yaml and dea_pod_override.yaml.
74   These keys are used to deploy multiple nodes(``1 controller,3 computes``)
75   as mention below.
76
77   * **Node 1**:
78      - This node has MongoDB and Controller roles
79      - The controller node runs the Identity service, Image Service, management portions of
80        Compute and Networking, Networking plug-in and the dashboard
81      - Uses VLAN as an interface
82
83   * **Node 2**:
84      - This node has compute and Ceph-osd roles
85      - Ceph is a massively scalable, open source, distributed storage system
86      - By default, Compute uses KVM as the hypervisor
87      - Uses DPDK as an interface
88
89   * **Node 3**:
90      - This node has compute and Ceph-osd roles
91      - Ceph is a massively scalable, open source, distributed storage system
92      - By default, Compute uses KVM as the hypervisor
93      - Uses DPDK as an interface
94
95   * **Node 4**:
96      - This node has compute and Ceph-osd roles
97      - Ceph is a massively scalable, open source, distributed storage system
98      - By default, Compute uses KVM as the hypervisor
99      - Uses DPDK as an interface
100
101   The below is the ``dea-override-config`` of the no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml file.
102
103 .. code:: bash
104
105    dea-override-config:
106      fuel:
107        FEATURE_GROUPS:
108        - experimental
109      environment:
110        net_segment_type: vlan
111      nodes:
112      - id: 1
113        interfaces: interfaces_vlan
114        role: mongo,controller
115      - id: 2
116        interfaces: interfaces_dpdk
117        role: ceph-osd,compute
118        attributes: attributes_1
119      - id: 3
120        interfaces: interfaces_dpdk
121        role: ceph-osd,compute
122        attributes: attributes_1
123      - id: 4
124        interfaces: interfaces_dpdk
125        role: ceph-osd,compute
126        attributes: attributes_1
127
128      attributes_1:
129        hugepages:
130          dpdk:
131            value: 1024
132          nova:
133            value:
134              '2048': 1024
135
136      network:
137        networking_parameters:
138          segmentation_type: vlan
139        networks:
140        - cidr: null
141          gateway: null
142          ip_ranges: []
143          meta:
144            configurable: false
145            map_priority: 2
146            name: private
147            neutron_vlan_range: true
148            notation: null
149            render_addr_mask: null
150            render_type: null
151            seg_type: vlan
152            use_gateway: false
153            vlan_start: null
154          name: private
155          vlan_start: null
156
157      settings:
158        editable:
159          storage:
160            ephemeral_ceph:
161              description: Configures Nova to store ephemeral volumes in RBD. This works best if Ceph
162              is enabled for volumes and images, too. Enables live migration of all types of Ceph
163              backed VMs (without this option, live migration will only work with VMs launched from
164              Cinder volumes).
165              label: Ceph RBD for ephemeral volumes (Nova)
166              type: checkbox
167              value: true
168              weight: 75
169            images_ceph:
170              description: Configures Glance to use the Ceph RBD backend to store images. If enabled,
171              this option will prevent Swift from installing.
172              label: Ceph RBD for images (Glance)
173              restrictions:
174              - settings:storage.images_vcenter.value == true: Only one Glance backend could be selected.
175              type: checkbox
176              value: true
177              weight: 30
178
179 * ``dha-override-config:`` Provides information about the VM definition and
180   Network config for virtual deployment.These configurations overrides
181   the pod dha definition and points to the controller,compute and
182   fuel definition files. The noha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml has no
183   dha-config changes i.e., default    configuration is used.
184
185 * os-nosdn-kvm_ovs_dpdk_bar-noha scenario is successful when all the 4 Nodes are accessible,
186   up and running.
187
188
189
190 **Note:**
191
192 * In os-nosdn-kvm_ovs_dpdk_bar-noha scenario, OVS is installed on the compute nodes with DPDK configured
193
194 * Baraometer plugin is also implemented along with KVM plugin.
195
196 * Hugepages for DPDK are configured in the attributes_1 section of the
197   no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml
198
199 * Hugepages are only configured for compute nodes
200
201 * This results in faster communication and data transfer among the compute nodes
202
203 Scenario Usage Overview
204 -----------------------
205 .. Provide a brief overview on how to use the scenario and the features available to the
206 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
207 .. where the specifics of the features are covered including examples and API's
208
209 * The high availability feature is disabled and deploymet is done by deploy.py with
210   noha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml as an argument.
211 * Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware
212   Environment:
213
214
215 Command to deploy the os-nosdn-kvm_ovs_dpdk_bar-noha scenario:
216
217 .. code:: bash
218
219         $ cd ~/fuel/ci/
220         $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default \
221         -s no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso
222
223 where,
224     -b is used to specify the configuration directory
225
226     -i is used to specify the image downloaded from artifacts.
227
228 Note:
229
230 .. code:: bash
231
232           Check $ sudo ./deploy.sh -h for further information.
233
234 * os-nosdn-kvm_ovs_dpdk_bar-noha scenario can be executed from the jenkins project
235   "fuel-os-nosdn-kvm_ovs_dpdk_bar-noha-baremetal-daily-master"
236 * This scenario provides the No High Availability feature by deploying
237   1 controller,3 compute nodes and checking if all the 4 nodes
238   are accessible(IP,up & running).
239 * Test Scenario is passed if deployment is successful and all 4 nodes have
240   accessibility (IP , up & running).
241
242 Known Limitations, Issues and Workarounds
243 -----------------------------------------
244 .. Explain any known limitations here.
245
246 * Test scenario os-nosdn-kvm_ovs_dpdk_bar-noha result is not stable.
247
248 References
249 ----------
250
251 For more information on the OPNFV Euphrates release, please visit
252 http://www.opnfv.org/Euphrates