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