To update the documentation for E-release
[kvmfornfv.git] / docs / release / scenarios / os-nosdn-kvm-ha / os-nosdn-kvm-ha.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-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-ha scenario testing is to test the
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. High Availability feature is achieved
20 by deploying OpenStack multi-node setup with 3 controllers and 2 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
24 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 High Availability OPNFV Cloud based on the
33 configurations provided in ha_nfv-kvm_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-ha) and an actual deployment
39   scenario configuration file(ha_nfv-kvm_heat_ceilometer_scenario.yaml)
40
41 * ``deployment-scenario-metadata:`` Contains the configuration metadata like
42   title,version,created,comment.
43
44 * ``stack-extensions:`` Stack extentions are opnfv added value features in form
45   of a fuel-plugin.Plugins listed in stack extensions are enabled and
46   configured.
47
48 * ``dea-override-config:`` Used to configure the HA mode,network segmentation
49   types and role to node assignments.These configurations overrides
50   corresponding keys in the dea_base.yaml and dea_pod_override.yaml.
51   These keys are used to deploy multiple nodes(3 controllers,2 computes)
52   as mention below.
53
54   * **Node 1**: This node has MongoDB and Controller roles. The controller
55     node runs the Identity service, Image Service, management portions of
56     Compute and Networking, Networking plug-in and the dashboard. The
57     Telemetry service which was designed to support billing systems for
58     OpenStack cloud resources uses a NoSQL database to store information.
59     The database typically runs on the controller node.
60
61   * **Node 2**: This node has Controller and Ceph-osd roles. Ceph is a
62     massively scalable, open source, distributed storage system. It is
63     comprised of an object store, block store and a POSIX-compliant distributed
64     file system. Enabling Ceph,  configures Nova to store ephemeral volumes in
65     RBD, configures Glance to use the Ceph RBD backend to store images,
66     configures Cinder to store volumes in Ceph RBD images and configures the
67     default number of object replicas in Ceph.
68
69   * **Node 3**: This node has Controller role in order to achieve high
70     availability.
71
72   * **Node 4**: This node has Compute role. The compute node runs the
73     hypervisor portion of Compute that operates tenant virtual machines
74     or instances. By default, Compute uses KVM as the hypervisor.
75
76   * **Node 5**: This node has compute role.
77
78 * ``dha-override-config:`` Provides information about the VM definition and
79   Network config for virtual deployment.These configurations overrides
80   the pod dha definition and points to the controller,compute and
81   fuel definition files.
82
83 * os-nosdn-kvm-ha scenario is successful when all the 5 Nodes are accessible,
84   up and running
85
86 Scenario Usage Overview
87 -----------------------
88 .. Provide a brief overview on how to use the scenario and the features available to the
89 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
90 .. where the specifics of the features are covered including examples and API's
91
92 * The high availability feature can be acheived by executing deploy.py with
93   ha_nfv-kvm_heat_ceilometer_scenario.yaml as an argument.
94 * Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware
95   Environment:
96
97   -Example:
98
99 .. code:: bash
100
101   sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha \
102   ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr -log ~/Deployment-888.log.tar.gz
103
104 * Install Fuel Master and deploy OPNFV Cloud from scratch on Virtual
105   Environment:
106
107   -Example:
108
109 .. code:: bash
110
111   sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha \
112   ~/CONF/virtual/dha.yaml -s /mnt/images -log ~/Deployment-888.log.tar.gz
113
114 * os-nosdn-kvm-ha scenario can be executed from the jenkins project
115   "fuel-os-nosdn-kvm-ha-baremetal-daily-master"
116 * This scenario provides the High Availability feature by deploying
117   3 controller,2 compute nodes and checking if all the 5 nodes
118   are accessible(IP,up & running).
119 * Test Scenario is passed if deployment is successful and all 5 nodes have
120   accessibility (IP , up & running).
121 * Observed that scenario is not running any testcase on top of deployment.
122
123 Known Limitations, Issues and Workarounds
124 -----------------------------------------
125 .. Explain any known limitations here.
126
127 * Test scenario os-nosdn-kvm-ha result is not stable. After node reboot
128   triggered by kvm plugin, sometimes puppet agent (mcollective) is not
129   responding with in the given time.
130
131 References
132 ----------
133
134 For more information on the OPNFV Euphrates release, please visit
135 http://www.opnfv.org/euphrates