1319f4272e32e0b8e724ba314d8b6ad9b16f59a6
[apex.git] / docs / release / scenarios / os-nosdn-performance-ha / os-nosdn-performance-ha.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) <optionally add copywriters name>
4
5 This document provides scenario level details for Euphrates 1.0 of
6 deployment with no SDN controller and performance options enabled.
7
8 .. contents::
9    :depth: 3
10    :local:
11
12 ============
13 Introduction
14 ============
15
16 This scenario is used primarily to demonstrate the performance settings and
17 capabilities in Apex. This scenario will  deploy a Newton OpenStack
18 deployment without any NFV features or SDN controller enabled.
19
20 Scenario components and composition
21 ===================================
22
23 This scenario is composed of common OpenStack services enabled by default,
24 including Nova, Neutron, Glance, Cinder, Keystone, Horizon.  Optionally and
25 by default, Tacker and Congress services are also enabled.  Ceph is used as
26 the backend storage to Cinder on all deployed nodes.
27
28 All services are in HA, meaning that there are multiple cloned instances of
29 each service, and they are balanced by HA Proxy using a Virtual IP Address
30 per service.
31
32 The main purpose of this scenario is to serve as an example to show how to
33 set optional performance settings in an Apex deploy settings file.
34
35 Scenario usage overview
36 =======================
37
38 The performance options listed in os-nosdn-performance-ha.yaml give an example
39 of the different options a user can set in any deploy settings file.  Some
40 of these performance options are actually required for other scenarios which
41 rely on DPDK.  Options under the nova section like 'libvirtpin' allow a
42 user to choose which core to pin nova instances to on the overcloud compute
43 node.  Options under 'kernel' allow a user to set kernel specific arguments
44 at boot, which include options like hugepages, isolcpus, enabling iommu, etc.
45
46
47 Limitations, Issues and Workarounds
48 ===================================
49
50 * `APEX-389 <https://jira.opnfv.org/browse/APEX-389>`_:
51    Compute kernel parameters are applied to all nodes
52
53 References
54 ==========
55
56 For more information on the OPNFV Euphrates release, please visit
57 http://www.opnfv.org/euphrates
58