47a7f1034b3ec78b7533a9932a31a6f73d2181ff
[kvmfornfv.git] / docs / release / scenarios / os-nosdn-kvm_nfv_ovs_dpdk_bar-noha / os-nosdn-kvm_nfv_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_nfv_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 barometer-1.0.0 plugin.
55
56 .. code:: bash
57
58   stack-extensions:
59      - module: fuel-plugin-kvm
60        module-config-name: fuel-nfvkvm
61        module-config-version: 1.0.0
62        module-config-override:
63         # Module config overrides
64      - module: fuel-plugin-collectd-ceilometer
65        module-config-name: fuel-barometer
66        module-config-version: 1.0.0
67        module-config-override:
68          # Module config overrides
69
70 * ``dea-override-config:`` Used to configure the HA mode,network segmentation
71   types and role to node assignments.These configurations overrides
72   corresponding keys in the dea_base.yaml and dea_pod_override.yaml.
73   These keys are used to deploy multiple nodes(``1 controller,3 computes``)
74   as mention below.
75
76   * **Node 1**:
77      - This node has MongoDB and Controller roles
78      - The controller node runs the Identity service, Image Service, management portions of
79        Compute and Networking, Networking plug-in and the dashboard
80      - Uses VLAN as an interface
81
82   * **Node 2**:
83      - This node has compute and Ceph-osd roles
84      - Ceph is a massively scalable, open source, distributed storage system
85      - By default, Compute uses KVM as the hypervisor
86      - Uses DPDK as an interface
87
88   * **Node 3**:
89      - This node has compute and Ceph-osd roles
90      - Ceph is a massively scalable, open source, distributed storage system
91      - By default, Compute uses KVM as the hypervisor
92      - Uses DPDK as an interface
93
94   * **Node 4**:
95      - This node has compute and Ceph-osd roles
96      - Ceph is a massively scalable, open source, distributed storage system
97      - By default, Compute uses KVM as the hypervisor
98      - Uses DPDK as an interface
99
100   The below is the ``dea-override-config`` of the no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml file.
101
102 .. code:: bash
103
104    dea-override-config:
105      fuel:
106        FEATURE_GROUPS:
107        - experimental
108      environment:
109        net_segment_type: vlan
110      nodes:
111      - id: 1
112        interfaces: interfaces_vlan
113        role: mongo,controller
114      - id: 2
115        interfaces: interfaces_dpdk
116        role: ceph-osd,compute
117        attributes: attributes_1
118      - id: 3
119        interfaces: interfaces_dpdk
120        role: ceph-osd,compute
121        attributes: attributes_1
122      - id: 4
123        interfaces: interfaces_dpdk
124        role: ceph-osd,compute
125        attributes: attributes_1
126
127      attributes_1:
128        hugepages:
129          dpdk:
130            value: 1024
131          nova:
132            value:
133              '2048': 1024
134
135      network:
136        networking_parameters:
137          segmentation_type: vlan
138        networks:
139        - cidr: null
140          gateway: null
141          ip_ranges: []
142          meta:
143            configurable: false
144            map_priority: 2
145            name: private
146            neutron_vlan_range: true
147            notation: null
148            render_addr_mask: null
149            render_type: null
150            seg_type: vlan
151            use_gateway: false
152            vlan_start: null
153          name: private
154          vlan_start: null
155
156      settings:
157        editable:
158          storage:
159            ephemeral_ceph:
160              description: Configures Nova to store ephemeral volumes in RBD. This works best if Ceph is enabled for volumes and images, too. Enables live migration of all types of Ceph backed VMs (without this option, live migration will only work with VMs launched from Cinder volumes).
161              label: Ceph RBD for ephemeral volumes (Nova)
162              type: checkbox
163              value: true
164              weight: 75
165            images_ceph:
166              description: Configures Glance to use the Ceph RBD backend to store images. If enabled, this option will prevent Swift from installing.
167              label: Ceph RBD for images (Glance)
168              restrictions:
169              - settings:storage.images_vcenter.value == true: Only one Glance backend could be selected.
170              type: checkbox
171              value: true
172              weight: 30
173
174 * ``dha-override-config:`` Provides information about the VM definition and
175   Network config for virtual deployment.These configurations overrides
176   the pod dha definition and points to the controller,compute and
177   fuel definition files. The noha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml has no dha-config changes i.e., default    configuration is used.
178
179 * os-nosdn-kvm_ovs_dpdk_bar-noha scenario is successful when all the 4 Nodes are accessible,
180   up and running.
181
182
183
184 **Note:**
185
186 * In os-nosdn-kvm_ovs_dpdk_bar-noha scenario, OVS is installed on the compute nodes with DPDK configured
187
188 * Baraometer plugin is also implemented along with KVM plugin.
189
190 * Hugepages for DPDK are configured in the attributes_1 section of the no-ha_nfv-kvm_nfv-ovs-dpdk_heat_ceilometer_scenario.yaml
191
192 * Hugepages are only configured for compute nodes
193
194 * This results in faster communication and data transfer among the compute nodes
195
196 Scenario Usage Overview
197 -----------------------
198 .. Provide a brief overview on how to use the scenario and the features available to the
199 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
200 .. where the specifics of the features are covered including examples and API's
201
202 * The high availability feature is disabled and deploymet is done by deploy.py with
203   noha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml as an argument.
204 * Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware
205   Environment:
206
207
208 Command to deploy the os-nosdn-kvm_ovs_dpdk_bar-noha scenario:
209
210 .. code:: bash
211
212         $ cd ~/fuel/ci/
213         $ sudo ./deploy.sh -f -b file:///tmp/opnfv-fuel/deploy/config -l devel-pipeline -p default -s no-ha_nfv-kvm_nfv-ovs-dpdk-bar_heat_ceilometer_scenario.yaml -i file:///tmp/opnfv.iso
214
215 where,
216     -b is used to specify the configuration directory
217
218     -i is used to specify the image downloaded from artifacts.
219
220 Note:
221
222 .. code:: bash
223
224           Check $ sudo ./deploy.sh -h for further information.
225
226 * os-nosdn-kvm_ovs_dpdk_bar-noha scenario can be executed from the jenkins project
227   "fuel-os-nosdn-kvm_ovs_dpdk_bar-noha-baremetal-daily-master"
228 * This scenario provides the No High Availability feature by deploying
229   1 controller,3 compute nodes and checking if all the 4 nodes
230   are accessible(IP,up & running).
231 * Test Scenario is passed if deployment is successful and all 4 nodes have
232   accessibility (IP , up & running).
233
234 Known Limitations, Issues and Workarounds
235 -----------------------------------------
236 .. Explain any known limitations here.
237
238 * Test scenario os-nosdn-kvm_ovs_dpdk_bar-noha result is not stable.
239
240 References
241 ----------
242
243 For more information on the OPNFV Danube release, please visit
244 http://www.opnfv.org/Danube