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